com.atlassian.crowd.manager.application

Class CachingApplicationService

java.lang.Object

com.atlassian.crowd.manager.application.AbstractDelegatingApplicationService

com.atlassian.crowd.manager.application.CachingApplicationService

All Implemented Interfaces:

ApplicationService

@Transactional
public class CachingApplicationService
extends AbstractDelegatingApplicationService

Implementation of ApplicationService which caches the result of ApplicationService methods.

Since:

v2.2

Constructor Summary

Constructors

Constructor and Description
CachingApplicationService(ApplicationService applicationService, UserAuthorisationCache userAuthorisationCache)

Method Summary

Modifier and Type	Method and Description
boolean	isUserAuthorised(Application application, String username) Returns true if the user is permitted to attempt authentication with the application.
void	removeUser(Application application, String user) Removes the user from the first active directory they are found in.
User	renameUser(Application application, String oldUserName, String newUsername) Renames the user in the first active directory the users exists in.

Methods inherited from class com.atlassian.crowd.manager.application.AbstractDelegatingApplicationService

addAllUsers, addGroup, addGroupToGroup, addUser, addUserToGroup, authenticateUser, findGroupByName, findGroupWithAttributesByName, findUserByKey, findUserByName, findUserWithAttributesByKey, findUserWithAttributesByName, findWebhookById, getApplicationService, getCapabilitiesForNewUsers, getCurrentEventToken, getNewEvents, isGroupDirectGroupMember, isGroupNestedGroupMember, isUserDirectGroupMember, isUserNestedGroupMember, registerWebhook, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUserAttributes, removeUserFromGroup, searchDirectGroupRelationships, searchGroups, searchNestedGroupRelationships, searchUsers, searchUsersAllowingDuplicateNames, storeGroupAttributes, storeUserAttributes, unregisterWebhook, updateGroup, updateUser, updateUserCredential

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingApplicationService

public CachingApplicationService(ApplicationService applicationService,
                                 UserAuthorisationCache userAuthorisationCache)

Method Detail

isUserAuthorised

public boolean isUserAuthorised(Application application,
                                String username)

Description copied from interface: ApplicationService

Returns true if the user is permitted to attempt authentication with the application. If the user could not be found, then false is returned.

For a user to have access to an application:

1. the Application must be active.
2. and either:
   • the User is stored in a directory which is associated to the Application and the "allow all to authenticate" flag is true.
   • the User is a member of a Group that is allowed to authenticate with the Application and both the User and Group are from the same RemoteDirectory.

Specified by:

isUserAuthorised in interface ApplicationService

Overrides:

isUserAuthorised in class AbstractDelegatingApplicationService

Parameters:

application - application user is authenticating against

username - username

Returns:

true if the user is permitted to attempt authentication with the application, otherwise false. If the user could not be found, false will be returned.

renameUser

public User renameUser(Application application,
                       String oldUserName,
                       String newUsername)
                throws UserNotFoundException,
                       OperationFailedException,
                       ApplicationPermissionException,
                       InvalidUserException

Description copied from interface: ApplicationService

Renames the user in the first active directory the users exists in.

If the user does not exist in ANY of the application's active assigned directories, then a UserNotFoundException will be thrown.

If the rename operation is not allowed on the User's directory, an ApplicationPermissionException is thrown.

If the rename operation fails on a directory for any other reason, such as directory failure, update failure, etc., an Exception is thrown immediately.

Returns the renamed User.

Specified by:

renameUser in interface ApplicationService

Overrides:

renameUser in class AbstractDelegatingApplicationService

Parameters:

application - application with assigned directories to operate on.

oldUserName - current username of the user to rename.

newUsername - new username of the renamed user.

Returns:

the renamed User.

Throws:

UserNotFoundException - user does not exist in any of the associated active directories of the application.

OperationFailedException - underlying directory implementation failed to execute the operation.

ApplicationPermissionException - if the User's directory is not allowed to perform operations of type OperationType.UPDATE_USER.

InvalidUserException - if the new username does not meet the username requirements for an associated directory.

removeUser

public void removeUser(Application application,
                       String user)
                throws OperationFailedException,
                       UserNotFoundException,
                       ApplicationPermissionException

Description copied from interface: ApplicationService

Removes the user from the first active directory they are found in.

If the user does not exist in ANY of the application's assigned directories, then a UserNotFoundException will be thrown.

If the remove operation fails because of permission restrictions, an ApplicationPermissionException is thrown.

Specified by:

removeUser in interface ApplicationService

Overrides:

removeUser in class AbstractDelegatingApplicationService

Parameters:

application - remove from application's assigned directories.

user - the name of the user to remove.

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

UserNotFoundException - if user with given name does not exist in ANY assigned directory.

ApplicationPermissionException - if the User's directory does not have permission to perform operations of type OperationType.DELETE_USER.