com.atlassian.crowd.service.soap.client

Interface SecurityServerClient

All Known Implementing Classes:

SecurityServerClientImpl

public interface SecurityServerClient

An interface to communicate with the Crowd Security Server.

See Also:

for a singleton factory implementation.

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) Deprecated.
SOAPRole	addRole(SOAPRole role) Deprecated.
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() Deprecated.
SOAPRole[]	findAllRoles() Deprecated.
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) Deprecated.
String[]	findRoleMemberships(String principalName) Deprecated.
long	getCacheTime() Deprecated. This method is now implemented by the crowd-ehcache.xml configuration file.
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
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) Deprecated.
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) Deprecated.
void	removeRole(String role) Deprecated.
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) Deprecated.
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.

Method Detail

authenticate

void authenticate()
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         InvalidAuthenticationException

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

Retrieves all groups in the application's assigned directories.

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

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

Deprecated.

Retrieves all roles in the application's assigned directories.

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

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

Retrieves all principals in the application's assigned directories.

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

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

Adds a group to the application's assigned directory.

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.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidGroupException - An error occured adding the group 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

updateGroup

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

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

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.

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

GroupNotFoundException - no groups matching the supplied name is found.

InvalidAuthenticationException - application authentication is not valid

findGroupByName

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

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

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

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

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

This will retrieve the group and all its attributes.

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

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

Deprecated.

Adds a role to the application's assigned directory.

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

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

Deprecated.

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

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

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

Finds a principal by token.

Parameters:

key - The principal's token.

Returns:

The principal object.

Throws:

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

RemoteException - An unknown remote exception occurred.

InvalidTokenException - Unable to find the specified token.

InvalidAuthenticationException - application authentication is not valid

updatePrincipalAttribute

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

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

Note: This is the same as calling addAttributeToPrincipal

Parameters:

name - The name of the principal.

attribute - The name of the attribute to update.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - Unable to find the specified principal.

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

InvalidAuthenticationException - application authentication is not valid

updateGroupAttribute

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

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

Note: This is the same as calling addAttributeToGroup

Parameters:

name - The name of the group.

attribute - The name of the attribute to update.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specified principal.

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

InvalidAuthenticationException - application authentication is not valid

findPrincipalByName

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

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

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

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

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

This will retrieve the principal and all its attributes.

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

addAllPrincipals

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

Adds principals to the application's assigned directory.

Parameters:

principals - Array of SOAPPrincipalWithCredential

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

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

addPrincipal

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

Adds a principal to the application's assigned directory.

Parameters:

principal - The populated principal object to added.

credential - The password for the principal.

Returns:

The principal object.

Throws:

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

RemoteException - An unknown remote exception occured.

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

addPrincipalToGroup

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

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

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.

GroupNotFoundException - Unable to find group by name.

UserNotFoundException - Unable to find user by name.

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

InvalidAuthenticationException - application authentication is not valid

updatePrincipalCredential

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

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

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.

UserNotFoundException - Unable to find the specified principal.

InvalidCredentialException - The supplied password is invalid.

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

InvalidAuthenticationException - application authentication is not valid

resetPrincipalCredential

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

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

Parameters:

principal - The name of the principal.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

InvalidCredentialException - Unable to reset the principal's password.

UserNotFoundException - Unable to find the specified principal.

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

InvalidAuthenticationException - application authentication is not valid

InvalidEmailAddressException - invalid email address

removeGroup

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

Removes a group from the application's assigned directory.

Parameters:

group - The name of the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - Unable to find the specified group.

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

InvalidAuthenticationException - application authentication is not valid

removeRole

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

Deprecated.

Removes a role from the application's assigned directory.

Parameters:

role - The name of the role.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

GroupNotFoundException - The specified role is invalid.

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

InvalidAuthenticationException - application authentication is not valid

removePrincipal

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

Removes a principal from the application's assigned directory.

Parameters:

principal - The name of the principal.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

UserNotFoundException - The specified principal is invalid.

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

InvalidAuthenticationException - application authentication is not valid

addPrincipalToRole

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

Deprecated.

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

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.

UserNotFoundException - Unable to user by name

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

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

InvalidAuthenticationException - application authentication is not valid

isGroupMember

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

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

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

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

Deprecated.

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

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

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

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

Parameters:

principal - The name of the principal.

group - The name of the group.

Throws:

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

RemoteException - An unknown remote exception occurred.

UserNotFoundException - Unable to find user by name

GroupNotFoundException - Unable to find group by name.

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

InvalidAuthenticationException - application authentication is not valid

MembershipNotFoundException - Unable to find the membership

removePrincipalFromRole

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

Deprecated.

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

Parameters:

principal - The name of the principal.

role - The name of the role.

Throws:

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

RemoteException - An unknown remote exception occurred.

UserNotFoundException - Unable to find user by name

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

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

InvalidAuthenticationException - application authentication is not valid

MembershipNotFoundException - Unable to find the membership

addAttributeToPrincipal

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

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

Note: This is the same as calling updatePrincipalAttribute

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.

UserNotFoundException - The specified principal is invalid.

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

InvalidAuthenticationException - application authentication is not valid

removeAttributeFromPrincipal

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

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

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.

UserNotFoundException - The specified principal is invalid.

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

InvalidAuthenticationException - application authentication is not valid

addAttributeToGroup

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

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

Note: This is the same as calling updateGroupAttribute

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.

GroupNotFoundException - The specified group is invalid.

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

InvalidAuthenticationException - application authentication is not valid

removeAttributeFromGroup

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

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

Note: This is the same as calling updateGroupAttribute

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.

GroupNotFoundException - The specified principal is invalid.

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

InvalidAuthenticationException - application authentication is not valid

getCacheTime

long getCacheTime()
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         InvalidAuthenticationException

Deprecated. This method is now implemented by the crowd-ehcache.xml configuration file.

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

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

boolean isCacheEnabled()
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              InvalidAuthenticationException

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

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

String getDomain()
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        InvalidAuthenticationException

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

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

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

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

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

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

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

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

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

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.

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

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

Deprecated.

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

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

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

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

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

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

Deprecated.

Finds all the roles the principal is a member of.

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

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

Authenticates a principal without SSO details utilizing centralized authentication only.

Parameters:

username - The username of the principal.

password - The password credential.

Returns:

The principal's authentication token.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthenticationException - An invalid authentication occurred.

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

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

Authenticates a principal without validating a password.

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.

InvalidAuthenticationException - An invalid authentication occurred.

InvalidAuthorizationTokenException - An invalid authentication occurred.

InactiveAccountException - The principal's account is inactive.

ApplicationAccessDeniedException - user does not have access to authenticate against application

getGrantedAuthorities

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

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

Returns:

a String[] of group names

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - An invalid authentication occurred.

InvalidAuthenticationException - application authentication is not valid

getCookieInfo

SOAPCookieInfo getCookieInfo()
                             throws RemoteException,
                                    InvalidAuthorizationTokenException,
                                    InvalidAuthenticationException

Returns information needed to set the SSO cookie correctly.

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

SoapClientProperties getSoapClientProperties()

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

Returns:

client properties used.