com.atlassian.crowd.service.soap.client

Class SecurityServerClientImpl

java.lang.Object

com.atlassian.crowd.service.soap.client.SecurityServerClientImpl

All Implemented Interfaces:

SecurityServerClient

public class SecurityServerClientImpl
extends Object
implements SecurityServerClient

An implementation of the SecurityServerClient interface.

This class with establish a connection with the Crowd security server, authenticate the application client and store the authentication token for the client for server operations. If the token becomes invalid, a new authentication token will be obtained and the request will run again. If the request fails a InvalidAuthorizationTokenException exception will be thrown.

This bean should be used in a singleton fashion.

See Also:

for a singleton factory implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticatedToken	applicationToken
protected org.codehaus.xfire.client.XFireProxyFactory	factory
protected org.codehaus.xfire.service.Service	service

Constructor Summary

Constructors

Constructor and Description
SecurityServerClientImpl(SoapClientProperties clientProperties)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllPrincipals(Collection<SOAPPrincipalWithCredential> principals) Adds principals to the application's assigned directory.
void	addAttributeToGroup(String group, SOAPAttribute attribute) Adds an attribute to a group that is in the application's assigned directory.
void	addAttributeToPrincipal(String principal, SOAPAttribute attribute) Adds an attribute to a principal who is in the application's assigned directory.
SOAPGroup	addGroup(SOAPGroup group) Adds a group to the application's assigned directory.
SOAPPrincipal	addPrincipal(SOAPPrincipal principal, PasswordCredential credential) Adds a principal to the application's assigned directory.
void	addPrincipalToGroup(String principal, String group) Adds a principal to a group for the application's assigned directory.
void	addPrincipalToRole(String principal, String role) Adds the principal to a role for the application's assigned directory.
SOAPRole	addRole(SOAPRole role) Adds a role to the application's assigned directory.
void	authenticate() Authenticate the client using the application name and password from crowd.properties.
String	authenticatePrincipal(UserAuthenticationContext userAuthenticationContext) Authenticates a principal who is in the application's assigned directory.
String	authenticatePrincipalSimple(String username, String password) Authenticates a principal without SSO details utilizing centralized authentication only.
String	createPrincipalToken(String username, ValidationFactor[] validationFactors) Authenticates a principal without validating a password.
String[]	findAllGroupNames() Finds all of the groups who are visible in the application's assigned directory.
SOAPNestableGroup[]	findAllGroupRelationships() Finds all of the groups who are visible in the application's assigned directory.
SOAPGroup[]	findAllGroups() Retrieves all groups in the application's assigned directories.
String[]	findAllPrincipalNames() Finds all of the principals who are visible in the application's assigned directory.
SOAPPrincipal[]	findAllPrincipals() Retrieves all principals in the application's assigned directories.
String[]	findAllRoleNames() Finds all of the roles who are visible in the application's assigned directory.
SOAPRole[]	findAllRoles() Retrieves all roles in the application's assigned directories.
SOAPGroup	findGroupByName(String name) Find a group by name for the application's assigned directory.
String[]	findGroupMemberships(String principalName) Finds all the groups the principal is a direct member of.
SOAPGroup	findGroupWithAttributesByName(String name) Find a group by name for the application's assigned directory.
SOAPPrincipal	findPrincipalByName(String name) Finds a principal by name who is in the application's assigned directory.
SOAPPrincipal	findPrincipalByToken(String key) Finds a principal by token.
SOAPPrincipal	findPrincipalWithAttributesByName(String name) Finds a principal by name who is in the application's assigned directory.
SOAPRole	findRoleByName(String name) Finds a role by name for the application's assigned directory.
String[]	findRoleMemberships(String principalName) Finds all the roles the principal is a member of.
AuthenticatedToken	getApplicationToken() Retrieve the current application token.
long	getCacheTime() Gets the amount of time a client should cache security information from the Crowd server.
SOAPCookieInfo	getCookieInfo() Returns information needed to set the SSO cookie correctly.
String	getDomain() This will return the domain configured in Crowd or null if no domain has been set.
String[]	getGrantedAuthorities() Will return the List of group names that have been given access to connect to the application
protected SecurityServer	getSecurityServer() Create and return an instance to the Crowd SecurityServer.
SoapClientProperties	getSoapClientProperties() Retrieve the SOAP client properties used to connect to the Crowd Security Server.
void	invalidateToken(String token) Invalidates a principal token for all integrated applications.
boolean	isCacheEnabled() Checks if the client application should cache security information from the Crowd server.
boolean	isGroupMember(String group, String principal) Checks if a principal is a member of a group for the application's assigned directory.
boolean	isRoleMember(String role, String principal) Checks if a principal is a member of a role for the application's assigned directory.
boolean	isValidToken(String principalToken, ValidationFactor[] validationFactors) Checks if the principal's current token is still valid.
void	removeAttributeFromGroup(String group, String attribute) Removes an attribute from a group that is in the application's assigned directory.
void	removeAttributeFromPrincipal(String principal, String attribute) Removes an attribute from a principal who is in the application's assigned directory.
void	removeGroup(String group) Removes a group from the application's assigned directory.
void	removePrincipal(String principal) Removes a principal from the application's assigned directory.
void	removePrincipalFromGroup(String principal, String group) Removes a principal from a group for the application's assigned directory.
void	removePrincipalFromRole(String principal, String role) Removes a principal from a role for the application's assigned directory.
void	removeRole(String role) Removes a role from the application's assigned directory.
void	resetPrincipalCredential(String principal) Resets a principal's password credential to a random password and emails the new password who is in the application's assigned directory.
SOAPGroup[]	searchGroups(SearchRestriction[] searchRestrictions) Searches for groups that are in the application's assigned directory.
SOAPPrincipal[]	searchPrincipals(SearchRestriction[] searchRestrictions) Searches for principals that are in the application's assigned directory.
SOAPRole[]	searchRoles(SearchRestriction[] searchRestrictions) Searches for roles that are in the application's assigned directory.
void	updateGroup(String group, String description, boolean active) Updates the first group located from the list of directories assigned to an application Available fields that can be updated are description and active
void	updateGroupAttribute(String name, SOAPAttribute attribute) Updates an attribute for a group that is in the application's assigned directory.
void	updatePrincipalAttribute(String name, SOAPAttribute attribute) Updates an attribute for a principal who is in the application's assigned directory.
void	updatePrincipalCredential(String principal, PasswordCredential credential) Updates the password credential for a principal who is in the application's assigned directory.

Methods inherited from class java.lang.Object

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

Field Detail

applicationToken

protected AuthenticatedToken applicationToken

service

protected org.codehaus.xfire.service.Service service

factory

protected org.codehaus.xfire.client.XFireProxyFactory factory

Constructor Detail

SecurityServerClientImpl

public SecurityServerClientImpl(SoapClientProperties clientProperties)

Parameters:

clientProperties - properties used to configure the client.

Method Detail

getSecurityServer

protected SecurityServer getSecurityServer()
                                    throws RemoteException

Create and return an instance to the Crowd SecurityServer.

Returns:

SecurityServer instance.

Throws:

RemoteException - there is a problem connecting to the Crowd Security Server.

getApplicationToken

public AuthenticatedToken getApplicationToken()
                                       throws RemoteException,
                                              InvalidAuthorizationTokenException,
                                              InvalidAuthenticationException

Retrieve the current application token.

If this client is not authenticated, then authenticate prior to returning the token.

Returns:

current application token.

Throws:

RemoteException - there was a problem communicating with the Crowd Security Server.

InvalidAuthorizationTokenException - incorrect credentials were used to authenticate the client. Ensure the application.password in crowd.properties matches the one defined in the Crowd Console.

InvalidAuthenticationException - if the application name/password combination is invalid

authenticate

public void authenticate()
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Authenticate the client using the application name and password from crowd.properties.

NOTE: this will perform an explicit authentication call to the server. There is no reason to directly call this as all the methods will automatically attempt to authenticate when required.

Specified by:

authenticate in interface SecurityServerClient

Throws:

RemoteException - there was a problem communicating with the Crowd Security Server.

InvalidAuthorizationTokenException - the newly created application token is invalid.

InvalidAuthenticationException - application authentication is not valid. Ensure the application.password in crowd.properties matches the one defined in the Crowd Console.

authenticatePrincipal

public String authenticatePrincipal(UserAuthenticationContext userAuthenticationContext)
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    InvalidAuthenticationException,
                                    InactiveAccountException,
                                    ApplicationAccessDeniedException,
                                    ExpiredCredentialException

Description copied from interface: SecurityServerClient

Authenticates a principal who is in the application's assigned directory.

Specified by:

authenticatePrincipal in interface SecurityServerClient

Parameters:

userAuthenticationContext - The principal's authentication details.

Returns:

The principal's authenticated token.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - The principal's authentication details were invalid.

InactiveAccountException - The principal's account is not active.

ApplicationAccessDeniedException - if the user does not have access to this application.

ExpiredCredentialException - The user's credentials have expired.

isValidToken

public boolean isValidToken(String principalToken,
                   ValidationFactor[] validationFactors)
                     throws RemoteException,
                            InvalidAuthorizationTokenException,
                            ApplicationAccessDeniedException,
                            InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Checks if the principal's current token is still valid.

Specified by:

isValidToken in interface SecurityServerClient

Parameters:

principalToken - The token to check.

validationFactors - The known identity factors used when creating the principal's token.

Returns:

true if and only if the token is active, otherwise false.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationAccessDeniedException - if the user does not have access to this application.

InvalidAuthenticationException - application authentication is not valid

invalidateToken

public void invalidateToken(String token)
                     throws RemoteException,
                            InvalidAuthorizationTokenException,
                            InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Invalidates a principal token for all integrated applications. If the token is later validated, the token will not be found valid.

Specified by:

invalidateToken in interface SecurityServerClient

Parameters:

token - The token to invalidate.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

searchGroups

public SOAPGroup[] searchGroups(SearchRestriction[] searchRestrictions)
                         throws RemoteException,
                                InvalidAuthorizationTokenException,
                                InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Searches for groups that are in the application's assigned directory.

Specified by:

searchGroups in interface SecurityServerClient

Parameters:

searchRestrictions - The search restrictions to use when performing this search.

Returns:

The search results.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

searchPrincipals

public SOAPPrincipal[] searchPrincipals(SearchRestriction[] searchRestrictions)
                                 throws RemoteException,
                                        InvalidAuthorizationTokenException,
                                        InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Searches for principals that are in the application's assigned directory.

Specified by:

searchPrincipals in interface SecurityServerClient

Parameters:

searchRestrictions - The search restrictions to use when performing this search.

Returns:

The search results.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

searchRoles

public SOAPRole[] searchRoles(SearchRestriction[] searchRestrictions)
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Searches for roles that are in the application's assigned directory.

Specified by:

searchRoles in interface SecurityServerClient

Parameters:

searchRestrictions - The search restrictions to use when performing this search.

Returns:

The search results.

Throws:

RemoteException - An unknown remote exception occured.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllGroups

public SOAPGroup[] findAllGroups()
                          throws RemoteException,
                                 InvalidAuthorizationTokenException,
                                 InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Retrieves all groups in the application's assigned directories.

Specified by:

findAllGroups in interface SecurityServerClient

Returns:

all groups in the application's assigned directories.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllRoles

public SOAPRole[] findAllRoles()
                        throws RemoteException,
                               InvalidAuthorizationTokenException,
                               InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Retrieves all roles in the application's assigned directories.

Specified by:

findAllRoles in interface SecurityServerClient

Returns:

all roles in the application's assigned directories.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllPrincipals

public SOAPPrincipal[] findAllPrincipals()
                                  throws RemoteException,
                                         InvalidAuthorizationTokenException,
                                         InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Retrieves all principals in the application's assigned directories.

Specified by:

findAllPrincipals in interface SecurityServerClient

Returns:

all principals in the application's assigned directories.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

addGroup

public SOAPGroup addGroup(SOAPGroup group)
                   throws RemoteException,
                          InvalidGroupException,
                          InvalidAuthorizationTokenException,
                          ApplicationPermissionException,
                          InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds a group to the application's assigned directory.

Specified by:

addGroup in interface SecurityServerClient

Parameters:

group - The group to add.

Returns:

The populated details after the add of the group to the directory server.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidGroupException - An error occured adding the group to the directory server.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to add the entity to the directory server.

InvalidAuthenticationException - application authentication is not valid

updateGroup

public void updateGroup(String group,
               String description,
               boolean active)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        GroupNotFoundException,
                        ApplicationPermissionException,
                        InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Updates the first group located from the list of directories assigned to an application Available fields that can be updated are description and active

Specified by:

updateGroup in interface SecurityServerClient

Parameters:

group - The name of the group to update.

description - the new description of the group.

active - the new active flag for the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - no groups matching the supplied name is found.

ApplicationPermissionException - The application does not have the proper permissions to update the entity to the directory server.

InvalidAuthenticationException - application authentication is not valid

findGroupByName

public SOAPGroup findGroupByName(String name)
                          throws RemoteException,
                                 InvalidAuthorizationTokenException,
                                 GroupNotFoundException,
                                 InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Find a group by name for the application's assigned directory.

Specified by:

findGroupByName in interface SecurityServerClient

Parameters:

name - The name of the group.

Returns:

The group object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specific group.

InvalidAuthenticationException - application authentication is not valid

findGroupWithAttributesByName

public SOAPGroup findGroupWithAttributesByName(String name)
                                        throws RemoteException,
                                               InvalidAuthorizationTokenException,
                                               GroupNotFoundException,
                                               InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Find a group by name for the application's assigned directory.

This will retrieve the group and all its attributes.

Specified by:

findGroupWithAttributesByName in interface SecurityServerClient

Parameters:

name - The name of the group.

Returns:

The group object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specific group.

InvalidAuthenticationException - application authentication is not valid

addRole

public SOAPRole addRole(SOAPRole role)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        InvalidRoleException,
                        ApplicationPermissionException,
                        InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds a role to the application's assigned directory.

Specified by:

addRole in interface SecurityServerClient

Parameters:

role - The name of the role.

Returns:

The role object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidRoleException - An error occured adding the role to the directory server.

ApplicationPermissionException - The application does not have the proper permissions to add the entity to the directory server.

InvalidAuthenticationException - application authentication is not valid

findRoleByName

public SOAPRole findRoleByName(String name)
                        throws RemoteException,
                               InvalidAuthorizationTokenException,
                               GroupNotFoundException,
                               InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds a role by name for the application's assigned directory.

Specified by:

findRoleByName in interface SecurityServerClient

Parameters:

name - The name of the role.

Returns:

The role object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specified role.

InvalidAuthenticationException - application authentication is not valid

findPrincipalByToken

public SOAPPrincipal findPrincipalByToken(String key)
                                   throws RemoteException,
                                          InvalidTokenException,
                                          InvalidAuthorizationTokenException,
                                          InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds a principal by token.

Specified by:

findPrincipalByToken in interface SecurityServerClient

Parameters:

key - The principal's token.

Returns:

The principal object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidTokenException - Unable to find the specified token.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

updatePrincipalAttribute

public void updatePrincipalAttribute(String name,
                            SOAPAttribute attribute)
                              throws RemoteException,
                                     ApplicationPermissionException,
                                     InvalidAuthorizationTokenException,
                                     UserNotFoundException,
                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Updates an attribute for a principal who is in the application's assigned directory.

Note: This is the same as calling addAttributeToPrincipal

Specified by:

updatePrincipalAttribute in interface SecurityServerClient

Parameters:

name - The name of the principal.

attribute - The name of the attribute to update.

Throws:

RemoteException - An unknown remote exception occurred.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

updateGroupAttribute

public void updateGroupAttribute(String name,
                        SOAPAttribute attribute)
                          throws RemoteException,
                                 ApplicationPermissionException,
                                 InvalidAuthorizationTokenException,
                                 GroupNotFoundException,
                                 InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Updates an attribute for a group that is in the application's assigned directory.

Note: This is the same as calling addAttributeToGroup

Specified by:

updateGroupAttribute in interface SecurityServerClient

Parameters:

name - The name of the group.

attribute - The name of the attribute to update.

Throws:

RemoteException - An unknown remote exception occurred.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

findPrincipalByName

public SOAPPrincipal findPrincipalByName(String name)
                                  throws RemoteException,
                                         InvalidAuthorizationTokenException,
                                         UserNotFoundException,
                                         InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds a principal by name who is in the application's assigned directory.

Specified by:

findPrincipalByName in interface SecurityServerClient

Parameters:

name - The name of the principal.

Returns:

The principal object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

findPrincipalWithAttributesByName

public SOAPPrincipal findPrincipalWithAttributesByName(String name)
                                                throws RemoteException,
                                                       InvalidAuthorizationTokenException,
                                                       UserNotFoundException,
                                                       InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds a principal by name who is in the application's assigned directory.

This will retrieve the principal and all its attributes.

Specified by:

findPrincipalWithAttributesByName in interface SecurityServerClient

Parameters:

name - The name of the principal.

Returns:

The principal object.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

addPrincipal

public SOAPPrincipal addPrincipal(SOAPPrincipal principal,
                         PasswordCredential credential)
                           throws RemoteException,
                                  InvalidAuthorizationTokenException,
                                  InvalidCredentialException,
                                  InvalidUserException,
                                  ApplicationPermissionException,
                                  InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds a principal to the application's assigned directory.

Specified by:

addPrincipal in interface SecurityServerClient

Parameters:

principal - The populated principal object to added.

credential - The password for the principal.

Returns:

The principal object.

Throws:

RemoteException - An unknown remote exception occured.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidCredentialException - The supplied password is invalid.

InvalidUserException - The supplied principal is invalid.

ApplicationPermissionException - The application does not have the proper permissions to add the entity to the directory server.

InvalidAuthenticationException - application authentication is not valid

addAllPrincipals

public void addAllPrincipals(Collection<SOAPPrincipalWithCredential> principals)
                      throws InvalidAuthorizationTokenException,
                             RemoteException,
                             ApplicationPermissionException,
                             BulkAddFailedException,
                             InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds principals to the application's assigned directory.

Specified by:

addAllPrincipals in interface SecurityServerClient

Parameters:

principals - Array of SOAPPrincipalWithCredential

Throws:

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

RemoteException - An unknown remote exception occurred.

ApplicationPermissionException - thrown when no Create User Permission for any of the directories.

BulkAddFailedException - throw when it failed to create a user in of the directories.

InvalidAuthenticationException - application authentication is not valid

addPrincipalToGroup

public void addPrincipalToGroup(String principal,
                       String group)
                         throws RemoteException,
                                InvalidAuthorizationTokenException,
                                ApplicationPermissionException,
                                GroupNotFoundException,
                                UserNotFoundException,
                                InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds a principal to a group for the application's assigned directory.

Specified by:

addPrincipalToGroup in interface SecurityServerClient

Parameters:

principal - The name of the principal.

group - The name of the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

GroupNotFoundException - Unable to find group by name.

UserNotFoundException - Unable to find user by name.

InvalidAuthenticationException - application authentication is not valid

updatePrincipalCredential

public void updatePrincipalCredential(String principal,
                             PasswordCredential credential)
                               throws RemoteException,
                                      InvalidAuthorizationTokenException,
                                      InvalidCredentialException,
                                      ApplicationPermissionException,
                                      UserNotFoundException,
                                      InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Updates the password credential for a principal who is in the application's assigned directory.

Specified by:

updatePrincipalCredential in interface SecurityServerClient

Parameters:

principal - The name of the principal.

credential - The password.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidCredentialException - The supplied password is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

UserNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

resetPrincipalCredential

public void resetPrincipalCredential(String principal)
                              throws RemoteException,
                                     InvalidEmailAddressException,
                                     InvalidCredentialException,
                                     ApplicationPermissionException,
                                     InvalidAuthorizationTokenException,
                                     UserNotFoundException,
                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Resets a principal's password credential to a random password and emails the new password who is in the application's assigned directory.

Specified by:

resetPrincipalCredential in interface SecurityServerClient

Parameters:

principal - The name of the principal.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidEmailAddressException - invalid email address

InvalidCredentialException - Unable to reset the principal's password.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - Unable to find the specified principal.

InvalidAuthenticationException - application authentication is not valid

removeGroup

public void removeGroup(String group)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        ApplicationPermissionException,
                        GroupNotFoundException,
                        InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes a group from the application's assigned directory.

Specified by:

removeGroup in interface SecurityServerClient

Parameters:

group - The name of the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

GroupNotFoundException - Unable to find the specified group.

InvalidAuthenticationException - application authentication is not valid

removeRole

public void removeRole(String role)
                throws RemoteException,
                       InvalidAuthorizationTokenException,
                       ApplicationPermissionException,
                       GroupNotFoundException,
                       InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes a role from the application's assigned directory.

Specified by:

removeRole in interface SecurityServerClient

Parameters:

role - The name of the role.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

GroupNotFoundException - The specified role is invalid.

InvalidAuthenticationException - application authentication is not valid

removePrincipal

public void removePrincipal(String principal)
                     throws RemoteException,
                            InvalidAuthorizationTokenException,
                            ApplicationPermissionException,
                            UserNotFoundException,
                            InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes a principal from the application's assigned directory.

Specified by:

removePrincipal in interface SecurityServerClient

Parameters:

principal - The name of the principal.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

UserNotFoundException - The specified principal is invalid.

InvalidAuthenticationException - application authentication is not valid

addPrincipalToRole

public void addPrincipalToRole(String principal,
                      String role)
                        throws RemoteException,
                               InvalidAuthorizationTokenException,
                               ApplicationPermissionException,
                               UserNotFoundException,
                               GroupNotFoundException,
                               InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds the principal to a role for the application's assigned directory.

Specified by:

addPrincipalToRole in interface SecurityServerClient

Parameters:

principal - The name of the principal.

role - The name of the role.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity to the directory server.

UserNotFoundException - Unable to user by name

GroupNotFoundException - Unable to group (of type Role) by name.

InvalidAuthenticationException - application authentication is not valid

isGroupMember

public boolean isGroupMember(String group,
                    String principal)
                      throws RemoteException,
                             InvalidAuthorizationTokenException,
                             InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Checks if a principal is a member of a group for the application's assigned directory.

Specified by:

isGroupMember in interface SecurityServerClient

Parameters:

group - The name of the group.

principal - The name of the principal.

Returns:

true if and only if the principal is a group member, otherwise false.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

isRoleMember

public boolean isRoleMember(String role,
                   String principal)
                     throws RemoteException,
                            InvalidAuthorizationTokenException,
                            InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Checks if a principal is a member of a role for the application's assigned directory.

Specified by:

isRoleMember in interface SecurityServerClient

Parameters:

role - The name of the role.

principal - The name of the principal.

Returns:

true if and only if the principal is a role member, otherwise false.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

removePrincipalFromGroup

public void removePrincipalFromGroup(String principal,
                            String group)
                              throws RemoteException,
                                     InvalidAuthorizationTokenException,
                                     ApplicationPermissionException,
                                     UserNotFoundException,
                                     GroupNotFoundException,
                                     MembershipNotFoundException,
                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes a principal from a group for the application's assigned directory.

Specified by:

removePrincipalFromGroup in interface SecurityServerClient

Parameters:

principal - The name of the principal.

group - The name of the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

UserNotFoundException - Unable to find user by name

GroupNotFoundException - Unable to find group by name.

MembershipNotFoundException - Unable to find the membership

InvalidAuthenticationException - application authentication is not valid

removePrincipalFromRole

public void removePrincipalFromRole(String principal,
                           String role)
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    ApplicationPermissionException,
                                    UserNotFoundException,
                                    GroupNotFoundException,
                                    MembershipNotFoundException,
                                    InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes a principal from a role for the application's assigned directory.

Specified by:

removePrincipalFromRole in interface SecurityServerClient

Parameters:

principal - The name of the principal.

role - The name of the role.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

UserNotFoundException - Unable to find user by name

GroupNotFoundException - Unable to find group (of type Role) by name.

MembershipNotFoundException - Unable to find the membership

InvalidAuthenticationException - application authentication is not valid

addAttributeToPrincipal

public void addAttributeToPrincipal(String principal,
                           SOAPAttribute attribute)
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    ApplicationPermissionException,
                                    UserNotFoundException,
                                    InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds an attribute to a principal who is in the application's assigned directory.

Note: This is the same as calling updatePrincipalAttribute

Specified by:

addAttributeToPrincipal in interface SecurityServerClient

Parameters:

principal - The name of the principal.

attribute - The name attribute to add.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

UserNotFoundException - The specified principal is invalid.

InvalidAuthenticationException - application authentication is not valid

removeAttributeFromPrincipal

public void removeAttributeFromPrincipal(String principal,
                                String attribute)
                                  throws RemoteException,
                                         InvalidAuthorizationTokenException,
                                         ApplicationPermissionException,
                                         UserNotFoundException,
                                         InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes an attribute from a principal who is in the application's assigned directory.

Specified by:

removeAttributeFromPrincipal in interface SecurityServerClient

Parameters:

principal - The name of the principal.

attribute - The name of the attribute.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

UserNotFoundException - The specified principal is invalid.

InvalidAuthenticationException - application authentication is not valid

addAttributeToGroup

public void addAttributeToGroup(String group,
                       SOAPAttribute attribute)
                         throws RemoteException,
                                InvalidAuthorizationTokenException,
                                ApplicationPermissionException,
                                GroupNotFoundException,
                                InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Adds an attribute to a group that is in the application's assigned directory.

Note: This is the same as calling updateGroupAttribute

Specified by:

addAttributeToGroup in interface SecurityServerClient

Parameters:

group - The name of the group.

attribute - The name attribute to add.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to update the entity in the directory server.

GroupNotFoundException - The specified group is invalid.

InvalidAuthenticationException - application authentication is not valid

removeAttributeFromGroup

public void removeAttributeFromGroup(String group,
                            String attribute)
                              throws RemoteException,
                                     InvalidAuthorizationTokenException,
                                     ApplicationPermissionException,
                                     GroupNotFoundException,
                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Removes an attribute from a group that is in the application's assigned directory.

Note: This is the same as calling updateGroupAttribute

Specified by:

removeAttributeFromGroup in interface SecurityServerClient

Parameters:

group - The name of the group.

attribute - The name of the attribute.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ApplicationPermissionException - The application does not have the proper permissions to remove the entity from the directory server.

GroupNotFoundException - The specified principal is invalid.

InvalidAuthenticationException - application authentication is not valid

getCacheTime

public long getCacheTime()
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Gets the amount of time a client should cache security information from the Crowd server.

Specified by:

getCacheTime in interface SecurityServerClient

Returns:

The cache time in minutes.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

isCacheEnabled

public boolean isCacheEnabled()
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Checks if the client application should cache security information from the Crowd server.

Specified by:

isCacheEnabled in interface SecurityServerClient

Returns:

true if and only if the cache is enabled, otherwise false.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

getDomain

public String getDomain()
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        InvalidAuthenticationException

Description copied from interface: SecurityServerClient

This will return the domain configured in Crowd or null if no domain has been set.

Specified by:

getDomain in interface SecurityServerClient

Returns:

the domain to set the SSO cookie for, or null

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllPrincipalNames

public String[] findAllPrincipalNames()
                               throws RemoteException,
                                      InvalidAuthorizationTokenException,
                                      InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all of the principals who are visible in the application's assigned directory.

Specified by:

findAllPrincipalNames in interface SecurityServerClient

Returns:

The names of all known principals.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllGroupNames

public String[] findAllGroupNames()
                           throws RemoteException,
                                  InvalidAuthorizationTokenException,
                                  InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all of the groups who are visible in the application's assigned directory.

Specified by:

findAllGroupNames in interface SecurityServerClient

Returns:

A String listing of the group names.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllGroupRelationships

public SOAPNestableGroup[] findAllGroupRelationships()
                                              throws RemoteException,
                                                     InvalidAuthorizationTokenException,
                                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all of the groups who are visible in the application's assigned directory. The groups will have their application's direct sub-groups populated. Principals will not be populated.

Specified by:

findAllGroupRelationships in interface SecurityServerClient

Returns:

A SOAPNestableGroup listing of the groups, plus any direct sub-groups.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findAllRoleNames

public String[] findAllRoleNames()
                          throws RemoteException,
                                 InvalidAuthorizationTokenException,
                                 InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all of the roles who are visible in the application's assigned directory.

Specified by:

findAllRoleNames in interface SecurityServerClient

Returns:

A String listing of the role names.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

findGroupMemberships

public String[] findGroupMemberships(String principalName)
                              throws RemoteException,
                                     InvalidAuthorizationTokenException,
                                     UserNotFoundException,
                                     InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all the groups the principal is a direct member of. This call does not resolve nesting.

Specified by:

findGroupMemberships in interface SecurityServerClient

Parameters:

principalName - The name of the principal to use when performing the lookup.

Returns:

A String listing of the principal's group memberships.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - The principal was not found

InvalidAuthenticationException - application authentication is not valid

findRoleMemberships

public String[] findRoleMemberships(String principalName)
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    UserNotFoundException,
                                    InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Finds all the roles the principal is a member of.

Specified by:

findRoleMemberships in interface SecurityServerClient

Parameters:

principalName - The name of the principal to use role performing the lookup.

Returns:

A String listing of the principal's group memberships.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - The principal was not found

InvalidAuthenticationException - application authentication is not valid

authenticatePrincipalSimple

public String authenticatePrincipalSimple(String username,
                                 String password)
                                   throws RemoteException,
                                          InvalidAuthorizationTokenException,
                                          InvalidAuthenticationException,
                                          InactiveAccountException,
                                          ApplicationAccessDeniedException,
                                          ExpiredCredentialException

Description copied from interface: SecurityServerClient

Authenticates a principal without SSO details utilizing centralized authentication only.

Specified by:

authenticatePrincipalSimple in interface SecurityServerClient

Parameters:

username - The username of the principal.

password - The password credential.

Returns:

The principal's authentication token.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - An invalid authentication occurred.

InvalidAuthenticationException - An invalid authentication occurred.

InactiveAccountException - The principal's account is inactive.

ApplicationAccessDeniedException - user does not have access to the application.

ExpiredCredentialException - The user's credentials have expired. The user must change their credentials in order to successfully authenticate.

createPrincipalToken

public String createPrincipalToken(String username,
                          ValidationFactor[] validationFactors)
                            throws RemoteException,
                                   InvalidAuthorizationTokenException,
                                   InvalidAuthenticationException,
                                   InactiveAccountException,
                                   ApplicationAccessDeniedException

Description copied from interface: SecurityServerClient

Authenticates a principal without validating a password.

Specified by:

createPrincipalToken in interface SecurityServerClient

Parameters:

username - The username to create an authenticate token for.

validationFactors - The known attributes of the user to use when creating a token, such as their remote IP address and user-agent.

Returns:

The principal's authentication token.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - An invalid authentication occurred.

InvalidAuthenticationException - An invalid authentication occurred.

InactiveAccountException - The principal's account is inactive.

ApplicationAccessDeniedException - user does not have access to authenticate against application

getGrantedAuthorities

public String[] getGrantedAuthorities()
                               throws InvalidAuthorizationTokenException,
                                      RemoteException,
                                      InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Will return the List of group names that have been given access to connect to the application

Specified by:

getGrantedAuthorities in interface SecurityServerClient

Returns:

a String[] of group names

Throws:

InvalidAuthorizationTokenException - An invalid authentication occurred.

RemoteException - An unknown remote exception occurred.

InvalidAuthenticationException - application authentication is not valid

getCookieInfo

public SOAPCookieInfo getCookieInfo()
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    InvalidAuthenticationException

Description copied from interface: SecurityServerClient

Returns information needed to set the SSO cookie correctly.

Specified by:

getCookieInfo in interface SecurityServerClient

Returns:

An object with lots of tasty configuration information

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidAuthenticationException - application authentication is not valid

getSoapClientProperties

public SoapClientProperties getSoapClientProperties()

Description copied from interface: SecurityServerClient

Retrieve the SOAP client properties used to connect to the Crowd Security Server.

Specified by:

getSoapClientProperties in interface SecurityServerClient

Returns:

client properties used.