org.marketcetera.admin

Interface AdminClient

All Superinterfaces:

org.marketcetera.util.rpc.BaseClient, org.springframework.context.Lifecycle

public interface AdminClient
extends org.marketcetera.util.rpc.BaseClient

Provides access to admin services.

Since:

$Release$

Version:

$Id: AdminClient.java 17810 2018-12-19 21:43:26Z colin $

Author:

Colin DuPlantis

Method Summary

Modifier and Type	Method and Description
void	changeUserPassword(String inUsername, String inOldPassword, String inNewPassword) Change the password of the given user.
FixSession	createFixSession(FixSession inFixSession) Create the given FIX session.
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	deleteFixSession(String inName) Delete the FIX session 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.
void	disableFixSession(String inName) Disable the FIX session with the given name.
void	enableFixSession(String inName) Enable the FIX session with the given name.
Collection<FixSessionAttributeDescriptor>	getFixSessionAttributeDescriptors() Get the FIX session attribute descriptors.
InstanceData	getInstanceData(int inAffinity) Get the instance data for the given affinity.
Set<String>	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<ActiveFixSession>	readFixSessions() Get current FIX sessions with their status.
CollectionPageResponse<ActiveFixSession>	readFixSessions(PageRequest inPageRequest) Read a page of FIX sessions.
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	setUserAttribute(String inUsername, UserAttributeType inAttributeType, String inAttribute) Set the given user attribute for the given user and attribute type.
void	startFixSession(String inName) Start the FIX session with the given name.
void	stopFixSession(String inName) Stop the FIX session with the given name.
void	updateFixSession(String inIncomingName, FixSession inFixSession) Update the given FIX session with the given original name.
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.
void	updateSenderSequenceNumber(String inSessionName, int inSenderSequenceNumber) Update the sender sequence number for the given session.
void	updateSequenceNumbers(String inSessionName, int inSenderSequenceNumber, int inTargetSequenceNumber) Update sender and target sequence numbers for the given session.
void	updateTargetSequenceNumber(String inSessionName, int inTargetSequenceNumber) Update the target sequence number for the given session.
User	updateUser(String inUsername, User inUpdatedUser) Update the given user with the given current username.

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Method Detail

getPermissionsForCurrentUser

Set<String> getPermissionsForCurrentUser()

Get permissions for the current user.

Returns:

a Set<String> value

createFixSession

FixSession createFixSession(FixSession inFixSession)

Create the given FIX session.

Parameters:

inFixSession - a FixSession value

Returns:

a FixSession value

readFixSessions

List<ActiveFixSession> readFixSessions()

Get current FIX sessions with their status.

Returns:

a List<ActiveFixSession> value

readFixSessions

CollectionPageResponse<ActiveFixSession> readFixSessions(PageRequest inPageRequest)

Read a page of FIX sessions.

Parameters:

inPageRequest - a PageRequest value

Returns:

a CollectionPageResponse<ActiveFixSession> value

updateFixSession

void updateFixSession(String inIncomingName,
                      FixSession inFixSession)

Update the given FIX session with the given original name.

Parameters:

inIncomingName - a String value

inFixSession - a FixSession value

enableFixSession

void enableFixSession(String inName)

Enable the FIX session with the given name.

Parameters:

inName - a String value

disableFixSession

void disableFixSession(String inName)

Disable the FIX session with the given name.

Parameters:

inName - a String value

deleteFixSession

void deleteFixSession(String inName)

Delete the FIX session with the given name.

Parameters:

inName - a String value

stopFixSession

void stopFixSession(String inName)

Stop the FIX session with the given name.

Parameters:

inName - a String value

startFixSession

void startFixSession(String inName)

Start the FIX session with the given name.

Parameters:

inName - a String 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

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.

Parameters:

inUsername - a String value

inOldPassword - 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

getInstanceData

InstanceData getInstanceData(int inAffinity)

Get the instance data for the given affinity.

Parameters:

inAffinity - an int value

Returns:

an InstanceData value

getFixSessionAttributeDescriptors

Collection<FixSessionAttributeDescriptor> getFixSessionAttributeDescriptors()

Get the FIX session attribute descriptors.

Returns:

a Collection<FixSessionAttributeDescriptor> value

updateSequenceNumbers

void updateSequenceNumbers(String inSessionName,
                           int inSenderSequenceNumber,
                           int inTargetSequenceNumber)

Update sender and target sequence numbers for the given session.

Parameters:

inSessionName - a String value

inSenderSequenceNumber - an int value

inTargetSequenceNumber - an int value

updateSenderSequenceNumber

void updateSenderSequenceNumber(String inSessionName,
                                int inSenderSequenceNumber)

Update the sender sequence number for the given session.

Parameters:

inSessionName - a String value

inSenderSequenceNumber - an int value

updateTargetSequenceNumber

void updateTargetSequenceNumber(String inSessionName,
                                int inTargetSequenceNumber)

Update the target sequence number for the given session.

Parameters:

inSessionName - a String value

inTargetSequenceNumber - an int 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