de.sekmi.li2b2.client.pm

Class PMClient

java.lang.Object

de.sekmi.li2b2.client.CellClient

de.sekmi.li2b2.client.pm.PMClient

public class PMClient
extends CellClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	XMLNS

Fields inherited from class de.sekmi.li2b2.client.CellClient

client, serviceUrl

Constructor Summary

Constructors

Constructor and Description
PMClient(Li2b2Client client, URL serviceUrl)

Method Summary

Modifier and Type	Method and Description
void	addHiveParam(String paramType, String paramName, String paramValue)
void	addProjectParam(String projectId, String paramType, String paramName, String paramValue)
void	addUserParam(String user_name, String paramType, String paramName, String paramValue) Add a parameter to the specified user's configuration.
void	changePassword(String user, String domain, char[] oldPassword, char[] newPassword) Change the password of any user.
void	deleteHiveParam(int id) Delete a global hive parameter
void	deleteProjectParam(int id) Delete a project specific parameter
void	deleteRole(String user_name, String role, String project_id) Delete one single Role for a specific user for one project.
void	deleteUser(String user_name) Delete one existing user
void	deleteUserParam(int id) Delete a user specific parameter.
Param[]	getHiveParams(String project_path) Retrieve global hive parameters
Param[]	getProjectParams(String projectId) Retrieve project specific parameters
Role[]	getRoles() Request the roles for a user for one project or all roles for one project or all roles of all users for all projects.
Role[]	getRoles(String project_id)
String[]	getRoles(String userId, String projectId)
User	getUser(String user_name) Request one user specified with user_name
Param[]	getUserParams(String user_name)
User[]	getUsers() Request all existing users
UserConfiguration	requestUserConfiguration() Request the configuration for the current user.
void	setRole(String user_name, String role, String project_id) Set one Role for a user for one project.
void	setUser(String user_name, String full_name, String email, String password, boolean is_admin) Update or create user with username, fullname, email and password
void	setUser(User user)

Methods inherited from class de.sekmi.li2b2.client.CellClient

appendOptionalElement, appendTextElement, createConnection, createRequest, createRequestMessage, createRequestMessage, createRequestMessage, getOutputCharset, getServiceURL, newBuilder, submitRequest, submitRequest, submitRequestWithResponseContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XMLNS

public static final String XMLNS

See Also:

Constant Field Values

Constructor Detail

PMClient

public PMClient(Li2b2Client client,
                URL serviceUrl)

Method Detail

changePassword

public void changePassword(String user,
                           String domain,
                           char[] oldPassword,
                           char[] newPassword)
                    throws ErrorResponseException,
                           HiveException

Change the password of any user. This method does not require prior authentication.

Parameters:

user - user name

domain - user domain

oldPassword - user's old password

newPassword - new password

Throws:

ErrorResponseException - password change operation failed

HiveException - server error

requestUserConfiguration

public UserConfiguration requestUserConfiguration()
                                           throws ErrorResponseException,
                                                  HiveException

Request the configuration for the current user. Use this method to authenticate and available projects and service cells.

Returns:

user configuration

Throws:

ErrorResponseException - application layer error. most commonly authentication failure

HiveException - unexpected response body

getUsers

public User[] getUsers()
                throws HiveException

Request all existing users

Returns:

array of users

Throws:

HiveException - unexpected response body

getUser

public User getUser(String user_name)
             throws HiveException

Request one user specified with user_name

Parameters:

user_name - user name

Returns:

user information

Throws:

HiveException - server error

setUser

public void setUser(User user)
             throws HiveException

Throws:

HiveException

setUser

public void setUser(String user_name,
                    String full_name,
                    String email,
                    String password,
                    boolean is_admin)
             throws HiveException

Update or create user with username, fullname, email and password

Parameters:

user_name - String username of the new user, non-null

full_name - String. Full name for the new user, descriptive (optional)

email - String. email of the new user, for contact (optional)

password - String password for the new user, non-null

is_admin - whether the user receives administrative privileges

Throws:

HiveException - for unexpected response

NullPointerException - if user_name or password is null

deleteUser

public void deleteUser(String user_name)
                throws HiveException,
                       ErrorResponseException

Delete one existing user

Parameters:

user_name - user name

Throws:

HiveException - unexpected response body

ErrorResponseException - delete failed. If the user does not exist, then the official Server will use status type ERROR and message User not updated, does it exist?.

getRoles

public Role[] getRoles()
                throws HiveException

Request the roles for a user for one project or all roles for one project or all roles of all users for all projects.

Returns:

array of roles

Throws:

HiveException - unexpected response body

getRoles

public Role[] getRoles(String project_id)
                throws HiveException

Throws:

HiveException

getRoles

public String[] getRoles(String userId,
                         String projectId)
                  throws HiveException

Throws:

HiveException

setRole

public void setRole(String user_name,
                    String role,
                    String project_id)
             throws HiveException,
                    ErrorResponseException

Set one Role for a user for one project. user_name and project can be "@" to set for all users

Parameters:

user_name - user name

role - role

project_id - project id

Throws:

HiveException - unexpected response body

ErrorResponseException - if current user does not have sufficient rights (has to be admin / manager)

deleteRole

public void deleteRole(String user_name,
                       String role,
                       String project_id)
                throws HiveException,
                       ErrorResponseException

Delete one single Role for a specific user for one project. user_name and project can be "@" to set for all users

Parameters:

user_name - user name

role - role

project_id - project id

Throws:

HiveException - unexpected response body

ErrorResponseException - if user-role-project combination does not exist

addUserParam

public void addUserParam(String user_name,
                         String paramType,
                         String paramName,
                         String paramValue)
                  throws HiveException

Add a parameter to the specified user's configuration. Multiple parameters with the same name are allowed. The server will assign a unique (numeric) id to each parameter.

Parameters:

user_name - user for whom to set the parameter

paramType - parameter type, see ParamType.getCode()

paramName - parameter name

paramValue - parameter value

Throws:

HiveException - error

getUserParams

public Param[] getUserParams(String user_name)
                      throws HiveException,
                             ErrorResponseException

Throws:

HiveException

ErrorResponseException

deleteUserParam

public void deleteUserParam(int id)
                     throws HiveException

Delete a user specific parameter. The official i2b2 server does not give error responses for non-existing ids

Parameters:

id - id for the parameter to delete

Throws:

HiveException - communications error

deleteHiveParam

public void deleteHiveParam(int id)
                     throws HiveException

Delete a global hive parameter

Parameters:

id - id for the parameter to delete

Throws:

HiveException - communications error

getHiveParams

public Param[] getHiveParams(String project_path)
                      throws HiveException

Retrieve global hive parameters

Parameters:

project_path - ??? web client always sets this parameter to "/"

Returns:

global hive params

Throws:

HiveException - communications error

getProjectParams

public Param[] getProjectParams(String projectId)
                         throws HiveException

Retrieve project specific parameters

Parameters:

projectId - project id to retrieve params for

Returns:

params

Throws:

HiveException - communications error

deleteProjectParam

public void deleteProjectParam(int id)
                        throws HiveException

Delete a project specific parameter

Parameters:

id - id for the parameter to delete

Throws:

HiveException - communications error

addHiveParam

public void addHiveParam(String paramType,
                         String paramName,
                         String paramValue)
                  throws HiveException

Throws:

HiveException

addProjectParam

public void addProjectParam(String projectId,
                            String paramType,
                            String paramName,
                            String paramValue)
                     throws HiveException

Throws:

HiveException