com.atlassian.crowd.cache

Interface UserAuthorisationCache

All Known Implementing Classes:

ClusterAwareUserAuthorisationCache, DelegatingUserAuthorisationCache, UserAuthorisationCacheImpl

public interface UserAuthorisationCache

Cache to determine whether a user is authorised to authenticate with an application. Was public api until 3.0.

Since:

v2.2

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the user authorisation cache.
Boolean	isPermitted(User user, String applicationName) Returns whether the user is permitted to authenticate with the application.
void	setPermitted(User user, String applicationName, boolean permitted) Sets whether the user is permitted to authenticate with the application.

Method Detail

setPermitted

void setPermitted(User user,
                  String applicationName,
                  boolean permitted)

Sets whether the user is permitted to authenticate with the application.

Parameters:

user - the user to cache fore

applicationName - name of the application to authenticate

permitted - set to true if the user is allowed to authenticate with the application, otherwise false.

isPermitted

@Nullable
Boolean isPermitted(User user,
                              String applicationName)

Returns whether the user is permitted to authenticate with the application.

Parameters:

user - the user to check for

applicationName - name of the application the user is authenticating against

Returns:

true if the user is permitted to authenticate with the application, false if the user is not permitted to authenticate, and null if the result is not in the cache.

clear

void clear()

Clears the user authorisation cache.