com.atlassian.crowd.service.soap.server

Interface SecurityServer

All Known Implementing Classes:

SecurityServerGeneric

public interface SecurityServer

Atlassian Crowd SOAP security services interface. All methods, other than the authenticateApplication must first authenticate before an API call can be made. The application token may be reused for more than one call. If the application token expires, an InvalidAuthorizationTokenException exception will be thrown and the client will need to re-authenticate.

Method Summary

Modifier and Type	Method and Description
void	addAllPrincipals(AuthenticatedToken applicationToken, SOAPPrincipalWithCredential[] principals) Adds principals to the application's assigned directory.
void	addAttributeToGroup(AuthenticatedToken applicationToken, String group, SOAPAttribute attribute) Adds an attribute to a group that is in the application's assigned directory.
void	addAttributeToPrincipal(AuthenticatedToken applicationToken, String principal, SOAPAttribute attribute) Adds an attribute to a principal who is in the application's assigned directory.
SOAPGroup	addGroup(AuthenticatedToken applicationToken, SOAPGroup group) Adds a group to the application's assigned directory.
SOAPPrincipal	addPrincipal(AuthenticatedToken applicationToken, SOAPPrincipal principal, PasswordCredential credential) Adds a principal to the application's assigned directory.
void	addPrincipalToGroup(AuthenticatedToken applicationToken, String principal, String group) Adds a principal to a group for the application's assigned directory.
void	addPrincipalToRole(AuthenticatedToken applicationToken, String principal, String role) Adds the principal to a role for the application's assigned directory.
SOAPRole	addRole(AuthenticatedToken applicationToken, SOAPRole role) Deprecated.
AuthenticatedToken	authenticateApplication(ApplicationAuthenticationContext authenticationContext) Authenticates an application client to the Crowd security server.
String	authenticatePrincipal(AuthenticatedToken applicationToken, UserAuthenticationContext authenticateContext) Authenticates a principal verses the calling who is in the application's assigned directory.
String	authenticatePrincipalSimple(AuthenticatedToken authenticationContext, String username, String password) Authenticates a principal without SSO details utilizing centralized authentication only.
String	createPrincipalToken(AuthenticatedToken authenticationContext, String username, ValidationFactor[] validationFactors) Authenticates a principal without validating a password.
String[]	findAllGroupNames(AuthenticatedToken applicationToken) Finds all of the groups who are visible in the application's assigned directory.
SOAPNestableGroup[]	findAllGroupRelationships(AuthenticatedToken applicationToken) Finds all of the groups who are visible in the application's assigned directory.
String[]	findAllPrincipalNames(AuthenticatedToken applicationToken) Finds all of the principals who are visable in the application's assigned directory.
String[]	findAllRoleNames(AuthenticatedToken applicationToken) Finds all of the roles who are visible in the application's assigned directory.
SOAPGroup	findGroupByName(AuthenticatedToken applicationToken, String name) Find a group by name for the application's assigned directory.
String[]	findGroupMemberships(AuthenticatedToken applicationToken, String principalName) Finds all of the principals who are members of a group that is in the application's assigned directory.
SOAPGroup	findGroupWithAttributesByName(AuthenticatedToken applicationToken, String name) Find a group by name for the application's assigned directory.
SOAPPrincipal	findPrincipalByName(AuthenticatedToken applicationToken, String name) Finds a principal by name who is in the application's assigned directory.
SOAPPrincipal	findPrincipalByToken(AuthenticatedToken applicationToken, String key) Finds a principal by token.
SOAPPrincipal	findPrincipalWithAttributesByName(AuthenticatedToken applicationToken, String name) Finds a principal by name who is in the application's assigned directory.
SOAPRole	findRoleByName(AuthenticatedToken applicationToken, String name) Deprecated.
String[]	findRoleMemberships(AuthenticatedToken applicationToken, String principalName) Finds all of the principals who are members of a role that is in the application's assigned directory.
long	getCacheTime(AuthenticatedToken applicationToken) Deprecated. This method is now implemented by the crowd-ehcache.xml configuration file.
SOAPCookieInfo	getCookieInfo(AuthenticatedToken applicationToken) Returns information needed to set the SSO cookie correctly.
String	getDomain(AuthenticatedToken applicationToken) Deprecated. This method has been superceded by getCookieInfo(com.atlassian.crowd.integration.authentication.AuthenticatedToken)
String[]	getGrantedAuthorities(AuthenticatedToken applicationToken) Will return the List of group names that have been given access to connect to the application
void	invalidatePrincipalToken(AuthenticatedToken applicationToken, String token) Invalidates a token for all integrated applications.
boolean	isCacheEnabled(AuthenticatedToken applicationToken) Checks if the client application should cache security information from the Crowd server.
boolean	isGroupMember(AuthenticatedToken applicationToken, String group, String principal) Checks if a principal is a member of a group for the application's assigned directory.
boolean	isRoleMember(AuthenticatedToken applicationToken, String role, String principal) Checks if a principal is a member of a role for the application's assigned directory.
boolean	isValidPrincipalToken(AuthenticatedToken applicationToken, String principalToken, ValidationFactor[] validationFactors) Checks if the principal's current token is still valid.
void	removeAttributeFromGroup(AuthenticatedToken applicationToken, String group, String attribute) Removes an attribute from a group that is in the application's assigned directory.
void	removeAttributeFromPrincipal(AuthenticatedToken applicationToken, String principal, String attribute) Removes an attribute from a principal who is in the application's assigned directory.
void	removeGroup(AuthenticatedToken applicationToken, String group) Removes a group from the application's assigned directory.
void	removePrincipal(AuthenticatedToken applicationToken, String principal) Removes a principal from the application's assigned directory.
void	removePrincipalFromGroup(AuthenticatedToken applicationToken, String principal, String group) Removes a principal from a group for the application's assigned directory.
void	removePrincipalFromRole(AuthenticatedToken applicationToken, String principal, String role) Removes a principal from a role for the application's assigned directory.
void	removeRole(AuthenticatedToken applicationToken, String role) Removes a role from the application's assigned directory.
void	resetPrincipalCredential(AuthenticatedToken applicationToken, 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(AuthenticatedToken applicationToken, SearchRestriction[] searchRestrictions) Searches for groups that are in the application's assigned directory.
SOAPPrincipal[]	searchPrincipals(AuthenticatedToken applicationToken, SearchRestriction[] searchRestrictions) Searches for principals that are in the application's assigned directory.
SOAPRole[]	searchRoles(AuthenticatedToken applicationToken, SearchRestriction[] searchRestrictions) Searches for roles that are in the application's assigned directory.
void	updateGroup(AuthenticatedToken authenticatedToken, 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(AuthenticatedToken applicationToken, String group, SOAPAttribute attribute) Updates an attribute for a group that is in the application's assigned directory..
void	updatePrincipalAttribute(AuthenticatedToken applicationToken, String name, SOAPAttribute attribute) Updates an attribute for a principal who is in the application's assigned directory..
void	updatePrincipalCredential(AuthenticatedToken applicationToken, String principal, PasswordCredential credential) Updates the password credential for a principal who is in the application's assigned directory.

Method Detail

createPrincipalToken

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

Authenticates a principal without validating a password.

Parameters:

authenticationContext - The application authentication details.

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

authenticatePrincipalSimple

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

Authenticates a principal without SSO details utilizing centralized authentication only.

Parameters:

authenticationContext - The application authentication details.

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.

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

ApplicationAccessDeniedException - User does not have access to authenticate against application

authenticateApplication

AuthenticatedToken authenticateApplication(ApplicationAuthenticationContext authenticationContext)
                                    throws RemoteException,
                                           InvalidAuthenticationException,
                                           InvalidAuthorizationTokenException

Authenticates an application client to the Crowd security server.

Parameters:

authenticationContext - The application authentication details.

Returns:

The application's authenticated token that will be reused for operations verses the security server.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthenticationException - An invalid authentication occurred.

InvalidAuthorizationTokenException - An invalid authentication occurred.

authenticatePrincipal

String authenticatePrincipal(AuthenticatedToken applicationToken,
                             UserAuthenticationContext authenticateContext)
                      throws RemoteException,
                             InvalidAuthorizationTokenException,
                             InvalidAuthenticationException,
                             InactiveAccountException,
                             ApplicationAccessDeniedException,
                             ExpiredCredentialException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

authenticateContext - 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.

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

ApplicationAccessDeniedException - User does not have access to authenticate against application

isValidPrincipalToken

boolean isValidPrincipalToken(AuthenticatedToken applicationToken,
                              String principalToken,
                              ValidationFactor[] validationFactors)
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              ApplicationAccessDeniedException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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 - User does not have access to authenticate against application

invalidatePrincipalToken

void invalidatePrincipalToken(AuthenticatedToken applicationToken,
                              String token)
                       throws RemoteException,
                              InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

token - The token to invalidate.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

searchGroups

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

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

searchPrincipals

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

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

searchRoles

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

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

addGroup

SOAPGroup addGroup(AuthenticatedToken applicationToken,
                   SOAPGroup group)
            throws RemoteException,
                   InvalidAuthorizationTokenException,
                   InvalidGroupException,
                   ApplicationPermissionException

Adds a group to the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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 occurred adding the group to the directory server.

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

updateGroup

void updateGroup(AuthenticatedToken authenticatedToken,
                 String group,
                 String description,
                 boolean active)
          throws RemoteException,
                 InvalidAuthorizationTokenException,
                 ApplicationPermissionException,
                 ObjectNotFoundException

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:

authenticatedToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - no groups matching the supplied name is found.

findGroupByName

SOAPGroup findGroupByName(AuthenticatedToken applicationToken,
                          String name)
                   throws RemoteException,
                          InvalidAuthorizationTokenException,
                          ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specific group.

findGroupWithAttributesByName

SOAPGroup findGroupWithAttributesByName(AuthenticatedToken applicationToken,
                                        String name)
                                 throws RemoteException,
                                        InvalidAuthorizationTokenException,
                                        ObjectNotFoundException

Find a group by name for the application's assigned directory. This will retrieve the group and all its attributes.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specific group.

addRole

SOAPRole addRole(AuthenticatedToken applicationToken,
                 SOAPRole role)
          throws RemoteException,
                 InvalidAuthorizationTokenException,
                 InvalidRoleException,
                 ApplicationPermissionException

Deprecated.

Adds a role to the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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 occurred adding the role to the directory server.

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

findRoleByName

SOAPRole findRoleByName(AuthenticatedToken applicationToken,
                        String name)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        ObjectNotFoundException

Deprecated.

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specified role.

findPrincipalByToken

SOAPPrincipal findPrincipalByToken(AuthenticatedToken applicationToken,
                                   String key)
                            throws InvalidAuthorizationTokenException,
                                   RemoteException,
                                   InvalidTokenException

Finds a principal by token.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

updatePrincipalAttribute

void updatePrincipalAttribute(AuthenticatedToken applicationToken,
                              String name,
                              SOAPAttribute attribute)
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              ApplicationPermissionException,
                              ObjectNotFoundException

Updates an attribute for a principal who is in the application's assigned directory.. Note: This is the same as calling addAttributeToPrincipal

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specified principal.

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

updateGroupAttribute

void updateGroupAttribute(AuthenticatedToken applicationToken,
                          String group,
                          SOAPAttribute attribute)
                   throws RemoteException,
                          InvalidAuthorizationTokenException,
                          ApplicationPermissionException,
                          ObjectNotFoundException

Updates an attribute for a group that is in the application's assigned directory.. Note: This is the same as calling addAttributeToGroup

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

group - 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.

ObjectNotFoundException - Unable to find the specified group.

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

findPrincipalByName

SOAPPrincipal findPrincipalByName(AuthenticatedToken applicationToken,
                                  String name)
                           throws RemoteException,
                                  InvalidAuthorizationTokenException,
                                  ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specified principal.

findPrincipalWithAttributesByName

SOAPPrincipal findPrincipalWithAttributesByName(AuthenticatedToken applicationToken,
                                                String name)
                                         throws RemoteException,
                                                InvalidAuthorizationTokenException,
                                                ObjectNotFoundException

Finds a principal by name who is in the application's assigned directory. This will retrieve the principal and all its attributes.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specified principal.

addPrincipal

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

Adds a principal to the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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 occurred.

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.

addAllPrincipals

void addAllPrincipals(AuthenticatedToken applicationToken,
                      SOAPPrincipalWithCredential[] principals)
               throws InvalidAuthorizationTokenException,
                      RemoteException,
                      ApplicationPermissionException,
                      BulkAddFailedException

Adds principals to the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

addPrincipalToGroup

void addPrincipalToGroup(AuthenticatedToken applicationToken,
                         String principal,
                         String group)
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         ApplicationPermissionException,
                         ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - the user or group could not be found

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

updatePrincipalCredential

void updatePrincipalCredential(AuthenticatedToken applicationToken,
                               String principal,
                               PasswordCredential credential)
                        throws RemoteException,
                               InvalidAuthorizationTokenException,
                               InvalidCredentialException,
                               ApplicationPermissionException,
                               ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

principal - The name of the principal.

credential - The password.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ObjectNotFoundException - 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.

resetPrincipalCredential

void resetPrincipalCredential(AuthenticatedToken applicationToken,
                              String principal)
                       throws RemoteException,
                              InvalidEmailAddressException,
                              InvalidAuthorizationTokenException,
                              InvalidCredentialException,
                              ApplicationPermissionException,
                              ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to find the specified principal.

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

InvalidEmailAddressException - invalid email address

removeGroup

void removeGroup(AuthenticatedToken applicationToken,
                 String group)
          throws RemoteException,
                 InvalidAuthorizationTokenException,
                 ApplicationPermissionException,
                 ObjectNotFoundException

Removes a group from the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

group - The name of the group.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ObjectNotFoundException - Unable to find the specified group.

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

removeRole

void removeRole(AuthenticatedToken applicationToken,
                String role)
         throws RemoteException,
                InvalidAuthorizationTokenException,
                ApplicationPermissionException,
                ObjectNotFoundException

Removes a role from the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

role - The name of the role.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ObjectNotFoundException - The specified role is invalid.

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

removePrincipal

void removePrincipal(AuthenticatedToken applicationToken,
                     String principal)
              throws RemoteException,
                     InvalidAuthorizationTokenException,
                     ApplicationPermissionException,
                     ObjectNotFoundException

Removes a principal from the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

principal - The name of the principal.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

ObjectNotFoundException - The specified principal is invalid.

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

addPrincipalToRole

void addPrincipalToRole(AuthenticatedToken applicationToken,
                        String principal,
                        String role)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        ApplicationPermissionException,
                        ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Unable to get user the specified user or group (of type Role) by name

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

isGroupMember

boolean isGroupMember(AuthenticatedToken applicationToken,
                      String group,
                      String principal)
               throws RemoteException,
                      InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

isRoleMember

boolean isRoleMember(AuthenticatedToken applicationToken,
                     String role,
                     String principal)
              throws RemoteException,
                     InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

removePrincipalFromGroup

void removePrincipalFromGroup(AuthenticatedToken applicationToken,
                              String principal,
                              String group)
                       throws InvalidAuthorizationTokenException,
                              RemoteException,
                              ApplicationPermissionException,
                              ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - if the user, group or membership could not be found

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

removePrincipalFromRole

void removePrincipalFromRole(AuthenticatedToken applicationToken,
                             String principal,
                             String role)
                      throws InvalidAuthorizationTokenException,
                             RemoteException,
                             ApplicationPermissionException,
                             ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - if the specified user, group (of type Role) or membership could not be found

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

addAttributeToPrincipal

void addAttributeToPrincipal(AuthenticatedToken applicationToken,
                             String principal,
                             SOAPAttribute attribute)
                      throws RemoteException,
                             InvalidAuthorizationTokenException,
                             ApplicationPermissionException,
                             ObjectNotFoundException

Adds an attribute to a principal who is in the application's assigned directory. Note: This is the same as calling updatePrincipalAttribute

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - The specified principal is invalid.

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

addAttributeToGroup

void addAttributeToGroup(AuthenticatedToken applicationToken,
                         String group,
                         SOAPAttribute attribute)
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         ApplicationPermissionException,
                         ObjectNotFoundException

Adds an attribute to a group that is in the application's assigned directory. Note: This is the same as calling updateGroupAttribute

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - if the specified group is invalid.

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

removeAttributeFromPrincipal

void removeAttributeFromPrincipal(AuthenticatedToken applicationToken,
                                  String principal,
                                  String attribute)
                           throws RemoteException,
                                  InvalidAuthorizationTokenException,
                                  ApplicationPermissionException,
                                  ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - The specified principal is invalid.

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

removeAttributeFromGroup

void removeAttributeFromGroup(AuthenticatedToken applicationToken,
                              String group,
                              String attribute)
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              ApplicationPermissionException,
                              ObjectNotFoundException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - The specified group is not found.

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

getCacheTime

long getCacheTime(AuthenticatedToken applicationToken)
           throws RemoteException,
                  InvalidAuthorizationTokenException

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.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

The cache time in minutes.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

isCacheEnabled

boolean isCacheEnabled(AuthenticatedToken applicationToken)
                throws RemoteException,
                       InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

getDomain

String getDomain(AuthenticatedToken applicationToken)
          throws RemoteException,
                 InvalidAuthorizationTokenException

Deprecated. This method has been superceded by getCookieInfo(com.atlassian.crowd.integration.authentication.AuthenticatedToken)

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

findAllPrincipalNames

String[] findAllPrincipalNames(AuthenticatedToken applicationToken)
                        throws RemoteException,
                               InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

The names of all known principals.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

findAllGroupNames

String[] findAllGroupNames(AuthenticatedToken applicationToken)
                    throws RemoteException,
                           InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

A String listing of the group names.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

findAllGroupRelationships

SOAPNestableGroup[] findAllGroupRelationships(AuthenticatedToken applicationToken)
                                       throws RemoteException,
                                              InvalidAuthorizationTokenException

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.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

findAllRoleNames

String[] findAllRoleNames(AuthenticatedToken applicationToken)
                   throws RemoteException,
                          InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

A String listing of the role names.

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

findGroupMemberships

String[] findGroupMemberships(AuthenticatedToken applicationToken,
                              String principalName)
                       throws RemoteException,
                              InvalidAuthorizationTokenException,
                              ObjectNotFoundException

Finds all of the principals who are members of a group that is in the application's assigned directory. This call does not resolve nesting.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Will never throw this exception. Left in to keep compatibility with Crowd 2.0.x.

findRoleMemberships

String[] findRoleMemberships(AuthenticatedToken applicationToken,
                             String principalName)
                      throws RemoteException,
                             InvalidAuthorizationTokenException,
                             ObjectNotFoundException

Finds all of the principals who are members of a role that is in the application's assigned directory.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

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.

ObjectNotFoundException - Will never throw this exception. Left in to keep compatibility with Crowd 2.0.x.

getGrantedAuthorities

String[] getGrantedAuthorities(AuthenticatedToken applicationToken)
                        throws RemoteException,
                               InvalidAuthorizationTokenException

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

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

a list of group names that are associated to the application represented by the application token

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.

getCookieInfo

SOAPCookieInfo getCookieInfo(AuthenticatedToken applicationToken)
                      throws RemoteException,
                             InvalidAuthorizationTokenException

Returns information needed to set the SSO cookie correctly.

Parameters:

applicationToken - The application's authentication token. Obtained from the authenticateApplication method.

Returns:

An object with lots of tasty configuration information

Throws:

RemoteException - An unknown remote exception occurred.

InvalidAuthorizationTokenException - The calling application's applicationToken is invalid.