Package 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.crowd.manager.application.ApplicationService

ApplicationService.MembershipsIterable

Constructor Summary

Constructors

Constructor	Description
CachingApplicationService(ApplicationService applicationService, UserAuthorisationCache userAuthorisationCache, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
boolean	isUserAuthorised(Application application, User user)	Returns true if the user is permitted to attempt authentication with the application.
boolean	isUserAuthorised(Application application, String username)	Returns true if the user is permitted to attempt authentication with the application.
void	onApplicationUpdated(ApplicationUpdatedEvent event)
void	onBackupRestored(XMLRestoreFinishedEvent event)
void	onDirectoryDeleted(DirectoryDeletedEvent event)
void	onDirectoryUpdated(DirectoryUpdatedEvent event)
void	registerListener()
void	unregisterListener()

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

addAllUsers, addGroup, addGroupToGroup, addUser, addUser, addUserToGroup, authenticateUser, authenticateUser, createPagedGroupSearcher, createPagedUserSearcher, expireAllPasswords, findGroupByName, findGroupWithAttributesByName, findRemoteUserByName, findUserByKey, findUserByName, findUserWithAttributesByKey, findUserWithAttributesByName, findWebhookById, getApplicationService, getCapabilitiesForNewUsers, getCurrentEventToken, getMemberships, getNewEvents, getUserAvatar, getUserAvatarLink, isGroupDirectGroupMember, isGroupNestedGroupMember, isUserDirectGroupMember, isUserNestedGroupMember, registerWebhook, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameUser, searchDirectGroupRelationships, searchGroups, searchNestedGroupRelationships, searchUsers, setUserStatusLocally, storeGroupAttributes, storeUserAttributes, unregisterWebhook, updateGroup, updateUser, updateUserCredential, userAuthenticated

Methods inherited from class java.lang.Object

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

Constructor Details

CachingApplicationService

public CachingApplicationService(ApplicationService applicationService,
 UserAuthorisationCache userAuthorisationCache,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

registerListener

@PostConstruct
public void registerListener()

unregisterListener

@PreDestroy
public void unregisterListener()

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</tt> if the user is permitted to attempt authentication with the application, otherwise <tt>false. If the user could not be found, false will be returned.

isUserAuthorised

public boolean isUserAuthorised(Application application,
 User user)

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

user - the user that will be checked

Returns:

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

onApplicationUpdated

@EventListener
public void onApplicationUpdated(ApplicationUpdatedEvent event)

onDirectoryUpdated

@EventListener
public void onDirectoryUpdated(DirectoryUpdatedEvent event)

onDirectoryDeleted

@EventListener
public void onDirectoryDeleted(DirectoryDeletedEvent event)

onBackupRestored

@EventListener
public void onBackupRestored(XMLRestoreFinishedEvent event)