com.atlassian.crowd.cache

Interface UserAuthorisationCache

All Known Implementing Classes:

UserAuthorisationCacheImpl

public interface UserAuthorisationCache

Cache to determine whether a user is authorised to authenticate with an application.

Since:

v2.2

Method Summary

Methods

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

Method Detail

setPermitted

void setPermitted(String userName,
                String applicationName,
                boolean permitted)

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

Parameters:

userName - username

applicationName - name of the application to authenticate

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

isPermitted

Boolean isPermitted(String userName,
                  String applicationName)

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

Parameters:

userName - username

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.

clear

void clear(String userName,
         String applicationName)

Clears a user from the user authorisation cache.

Parameters:

userName - username

applicationName - name of the application to authenticate