Package org.marketcetera.admin

Interface AdminClient

All Superinterfaces:

AutoCloseable, BaseClient, Closeable

public interface AdminClient
extends BaseClient

Provides access to admin services.

Since:

$Release$

Version:

$Id$

Author:

Colin DuPlantis

Method Summary

Modifier and Type	Method	Description
void	changeUserPassword(String inUsername, String inOldPassword, String inNewPassword)	Change the password of the given user.
Permission	createPermission(Permission inPermission)	Create a permission with the given attributes.
Role	createRole(Role inRole)	Create the given role.
User	createUser(User inNewUser, String inPassword)	Create the given user with the given password.
void	deactivateUser(String inName)	Deactivate the user with the given name.
void	deletePermission(String inPermissionName)	Delete the permission with the given name.
void	deleteRole(String inName)	Delete the role with the given name.
void	deleteUser(String inUsername)	Delete the given user.
User	getCurrentUser()	Get the current user.
Set<Permission>	getPermissionsForCurrentUser()	Get permissions for the current user.
UserAttribute	getUserAttribute(String inUsername, UserAttributeType inAttributeType)	Get the user attribute for the given user and attribute type.
List<Permission>	readPermissions()	Read permissions.
CollectionPageResponse<Permission>	readPermissions(PageRequest inPageRequest)	Read a page of permissions.
List<Role>	readRoles()	Read roles.
CollectionPageResponse<Role>	readRoles(PageRequest inPageRequest)	Read a page or roles.
List<User>	readUsers()	Get the list of users.
CollectionPageResponse<User>	readUsers(PageRequest inPageRequest)	Get a list of users.
void	resetPassword(String inUsername, String inNewPassword)	Resets the password of the given user to the given value.
void	setUserAttribute(String inUsername, UserAttributeType inAttributeType, String inAttribute)	Set the given user attribute for the given user and attribute type.
Permission	updatePermission(String inPermissionName, Permission inUpdatedPermission)	Update the permission with the given name.
Role	updateRole(String inName, Role inRole)	Update the given role with the given original name.
User	updateUser(String inUsername, User inUpdatedUser)	Update the given user with the given current username.

Methods inherited from interface org.marketcetera.core.BaseClient

addClientStatusListener, close, isRunning, removeClientStatusListener, start, stop

Method Detail

getPermissionsForCurrentUser

Set<Permission> getPermissionsForCurrentUser()

Get permissions for the current user.

Returns:

a Set<Permission> value

getCurrentUser

User getCurrentUser()

Get the current user.

Returns:

a User value

readUsers

List<User> readUsers()

Get the list of users.

Returns:

a List<User> value

readUsers

CollectionPageResponse<User> readUsers(PageRequest inPageRequest)

Get a list of users.

Parameters:

inPageRequest - a PageRequest value

Returns:

a CollectionPageResponse<User> value

createUser

User createUser(User inNewUser,
                String inPassword)

Create the given user with the given password.

Parameters:

inNewUser - a User value

inPassword - a String value

Returns:

a User value

updateUser

User updateUser(String inUsername,
                User inUpdatedUser)

Update the given user with the given current username.

Parameters:

inUsername - a String value

inUpdatedUser - a User value

Returns:

a User value

changeUserPassword

void changeUserPassword(String inUsername,
                        String inOldPassword,
                        String inNewPassword)

Change the password of the given user.

Requires permissions to change the password of the current user.

Parameters:

inUsername - a String value

inOldPassword - a String value

inNewPassword - a String value

resetPassword

void resetPassword(String inUsername,
                   String inNewPassword)

Resets the password of the given user to the given value.

Requires admin reset password permissions.

Parameters:

inUsername - a String value

inNewPassword - a String value

deleteUser

void deleteUser(String inUsername)

Delete the given user.

Parameters:

inUsername - a String value

deactivateUser

void deactivateUser(String inName)

Deactivate the user with the given name.

Parameters:

inName - a String value

createPermission

Permission createPermission(Permission inPermission)

Create a permission with the given attributes.

Parameters:

inPermission - a Permission value

Returns:

a Permission value

readPermissions

List<Permission> readPermissions()

Read permissions.

Returns:

a List<Permission> value

readPermissions

CollectionPageResponse<Permission> readPermissions(PageRequest inPageRequest)

Read a page of permissions.

Parameters:

inPageRequest - a PageRequest value

Returns:

a CollectionPageResponse<Permission> value

updatePermission

Permission updatePermission(String inPermissionName,
                            Permission inUpdatedPermission)

Update the permission with the given name.

Parameters:

inPermissionName - a String value

inUpdatedPermission - a Permission value

Returns:

a Permission value

deletePermission

void deletePermission(String inPermissionName)

Delete the permission with the given name.

Parameters:

inPermissionName - a String value

createRole

Role createRole(Role inRole)

Create the given role.

Parameters:

inRole - a Role value

Returns:

a Role value

readRoles

List<Role> readRoles()

Read roles.

Returns:

a List<Role> value

readRoles

CollectionPageResponse<Role> readRoles(PageRequest inPageRequest)

Read a page or roles.

Parameters:

inPageRequest - a PageRequest value

Returns:

a CollectionPageResponse<Role> value

deleteRole

void deleteRole(String inName)

Delete the role with the given name.

Parameters:

inName - a String value

updateRole

Role updateRole(String inName,
                Role inRole)

Update the given role with the given original name.

Parameters:

inName - a String value

inRole - a Role value

Returns:

a Role value

getUserAttribute

UserAttribute getUserAttribute(String inUsername,
                               UserAttributeType inAttributeType)

Get the user attribute for the given user and attribute type.

Parameters:

inUsername - a String value

inAttributeType - a UserAttributeType value

Returns:

a UserAttribute value or null

setUserAttribute

void setUserAttribute(String inUsername,
                      UserAttributeType inAttributeType,
                      String inAttribute)

Set the given user attribute for the given user and attribute type.

Parameters:

inUsername - a String value

inAttributeType - a UserAttributeType value

inAttribute - a String value or null to remove the attribute