|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SecurityBroker
Defines an Interface for security brokers. With this interface MoreMotion's security system is isolated from the persistency (where the security information stored).
Method Summary | |
---|---|
void |
authenticateUser(User user,
java.lang.String password)
Authenticates a user with password (plain) |
void |
deleteCheckPoint(BrokerCommunicationContext bcc,
java.lang.String checkPointName)
Deletes a check point. |
void |
deleteRole(BrokerCommunicationContext bcc,
java.lang.String roleName)
Deletes a role by its Name. |
void |
deleteUser(BrokerCommunicationContext bcc,
java.lang.String userName)
Deletes a user. |
java.lang.String |
encryptPassword(java.lang.String password)
Encryptes the given plain password. |
CheckPoint |
getCheckPoint(BrokerCommunicationContext bcc,
java.lang.String checkPointName)
Finds a check point by its name. |
CheckPoint[] |
getCheckPoints(BrokerCommunicationContext bcc)
Returns a lists of all checkpoints. |
Role |
getRole(BrokerCommunicationContext bcc,
java.lang.String roleName)
Returns a role by its name. |
Role[] |
getRoles(BrokerCommunicationContext bcc)
Returns a list all of roles. |
User |
getUser(BrokerCommunicationContext bcc,
java.lang.String userName)
Gets a user by its name. |
User |
getUserByEmail(BrokerCommunicationContext bcc,
java.lang.String email)
Gets a user by its Email address. |
User[] |
getUsers(BrokerCommunicationContext bcc)
Returns list of all users. |
User[] |
getUsers(BrokerCommunicationContext bcc,
int from,
int amount,
MutableInt noi)
Returns a sublist of the users. |
java.lang.Object |
init(MoreMotionRequest request,
java.lang.String connectionDatasource,
java.util.Map brokerParams)
Initialises the broker. |
BrokerCommunicationContext |
prepare(MoreMotionRequest request,
java.lang.Object initializedObject)
Prepares the broker for the successive calls. |
void |
saveCheckPoint(BrokerCommunicationContext bcc,
CheckPoint checkPoint)
Saves a check point. |
void |
saveRole(BrokerCommunicationContext bcc,
Role role)
Saves a role. |
void |
saveUser(BrokerCommunicationContext bcc,
User user)
Saves a user. |
User[] |
searchUsers(BrokerCommunicationContext bcc,
java.lang.String searchCriteria,
int from,
int amount,
MutableInt noi)
Returns list of that users that match with search criteria |
Method Detail |
---|
java.lang.Object init(MoreMotionRequest request, java.lang.String connectionDatasource, java.util.Map brokerParams) throws SecurityBrokerException
request
- MoreMotionRequest objectconnectionDatasource
- The name of the MoreMotion datasource that is defined in datasources dialog of mmDesigner.brokerParams
- The Map object that contains the broker parameters
prepare()
call.
SecurityBrokerException
- if initialisation fails.BrokerCommunicationContext prepare(MoreMotionRequest request, java.lang.Object initializedObject) throws SecurityBrokerException
request
- MoreMotionRequest objectinitializedObject
- The object created by the init()
method.
SecurityBrokerException
- if preparation fails.User getUser(BrokerCommunicationContext bcc, java.lang.String userName) throws MissingSecurityEntityException
bcc
- BrokerCommunication ObjectuserName
- User name.
MissingSecurityEntityException
- If user cannot be found.User getUserByEmail(BrokerCommunicationContext bcc, java.lang.String email) throws MissingSecurityEntityException
bcc
- BrokerCommunication Objectemail
- User E-mail.
MissingSecurityEntityException
- If no user is found with given email.void deleteUser(BrokerCommunicationContext bcc, java.lang.String userName) throws DeleteSecurityEntityException
bcc
- BrokerCommunication ObjectuserName
- User name.
DeleteSecurityEntityException
- If deletion fails.void saveUser(BrokerCommunicationContext bcc, User user) throws SaveSecurityEntityException
bcc
- BrokerCommunication Objectuser
- User object.
SaveSecurityEntityException
- If user cannot be saved.User[] getUsers(BrokerCommunicationContext bcc) throws MissingSecurityEntityException
bcc
- BrokerCommunication Object
MissingSecurityEntityException
User[] getUsers(BrokerCommunicationContext bcc, int from, int amount, MutableInt noi) throws MissingSecurityEntityException
bcc
- BrokerCommunication Objectfrom
- the start index.amount
- the number of the users to return.
MissingSecurityEntityException
User[] searchUsers(BrokerCommunicationContext bcc, java.lang.String searchCriteria, int from, int amount, MutableInt noi) throws MissingSecurityEntityException
bcc
- BrokerCommunication ObjectsearchCriteria
- the string that contains the search criteriafrom
- the start index.amount
- the number of the users to return.
MissingSecurityEntityException
void authenticateUser(User user, java.lang.String password) throws AuthenticationException
user
- User object.password
- String.
Authenticate
- if user is not authenticated.
AuthenticationException
java.lang.String encryptPassword(java.lang.String password)
password
- Plain Password String.Role getRole(BrokerCommunicationContext bcc, java.lang.String roleName) throws MissingSecurityEntityException
bcc
- BrokerCommunication ObjectroleName
- Role name.
MissingSecurityEntityException
- If role cannot be found.void deleteRole(BrokerCommunicationContext bcc, java.lang.String roleName) throws DeleteSecurityEntityException
bcc
- BrokerCommunication ObjectroleName
- Role Name.
DeleteSecurityEntityException
- If role cannot be found.Role[] getRoles(BrokerCommunicationContext bcc)
bcc
- BrokerCommunication Object
void saveRole(BrokerCommunicationContext bcc, Role role) throws SaveSecurityEntityException
bcc
- BrokerCommunication Objectrole
- Role object.
SaveSecurityEntityException
- If role cannot be saved.CheckPoint getCheckPoint(BrokerCommunicationContext bcc, java.lang.String checkPointName) throws MissingSecurityEntityException
bcc
- BrokerCommunication ObjectcheckPointName
- Check point name.
MissingSecurityEntityException
- If check point cannot be found.CheckPoint[] getCheckPoints(BrokerCommunicationContext bcc)
bcc
- BrokerCommunication Object
void deleteCheckPoint(BrokerCommunicationContext bcc, java.lang.String checkPointName) throws DeleteSecurityEntityException
bcc
- BrokerCommunication ObjectcheckPointName
- Check point name.
DeleteSecurityEntityException
- If deletion fails.void saveCheckPoint(BrokerCommunicationContext bcc, CheckPoint checkPoint) throws SaveSecurityEntityException
bcc
- BrokerCommunication ObjectcheckPoint
- CheckPoint object.
SaveSecurityEntityException
- If check point cannot be saved.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |