com.atlassian.confluence.rpc.auth
Class TokenAuthenticationManager

java.lang.Object
  com.atlassian.confluence.rpc.auth.TokenAuthenticationManager

public class TokenAuthenticationManager
extends java.lang.Object

Manages tokens used to authenticate users for Confluence's remote API. This implementation is also responsible for checking permission to access the application and the remote API before returning tokens.

Uses a cache with an appropriate expiry delay to store the tokens. The default timeout is 30 minutes.

Field Summary

static java.lang.String

TOKEN_CACHE

Constructor Summary

TokenAuthenticationManager()

Method Summary

boolean	hasUseConfluencePermission(com.atlassian.user.User user) Determines whether user has access to Confluence
java.lang.String	login(java.lang.String username, java.lang.String password) Logs the user with username and password into the Remote API system The token is stored for a period of time, and invalidated after an idle period.
boolean	logout(java.lang.String token) Logs the user out of the RPC system
ConfluenceUser	makeAnonymousConfluenceUser() Returns the anonymous user
com.atlassian.user.User	makeAnonymousUser() Deprecated. since 5.2. Use makeAnonymousConfluenceUser() instead.
ConfluenceUser	makeNonAnonymousConfluenceUserFromToken(java.lang.String token) Retrieves the user for a particular token
com.atlassian.user.User	makeNonAnonymousUserFromToken(java.lang.String token) Deprecated. since 5.2. Use makeNonAnonymousConfluenceUserFromToken(String) instead.
void	setCacheManager(com.atlassian.cache.CacheManager cacheManager)
void	setEventManager(com.atlassian.event.EventManager eventManager)
void	setLoginManager(LoginManager loginManager)
void	setPermissionManager(PermissionManager permissionManager)
void	setSettingsManager(SettingsManager settingsManager)
void	setUserAccessor(UserAccessor userAccessor)

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_CACHE

public static final java.lang.String TOKEN_CACHE

Constructor Detail

TokenAuthenticationManager

public TokenAuthenticationManager()

Method Detail

login

public java.lang.String login(java.lang.String username,
                              java.lang.String password)
                       throws RemoteException

Logs the user with username and password into the Remote API system

The token is stored for a period of time, and invalidated after an idle period.

Parameters:

username - The user's login name

password - The password

Returns:

The authentication token for use with other RPC calls

Throws:

AuthenticationFailedException - if a user called username could not be found or the password was incorrect

RemoteException

logout

public boolean logout(java.lang.String token)
               throws RemoteException

Logs the user out of the RPC system

Parameters:

token - The authenticated user token

Returns:

true if the logout was successful, otherwise false

Throws:

RemoteException - if the user could not be logged out

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setPermissionManager

public void setPermissionManager(PermissionManager permissionManager)

setCacheManager

public void setCacheManager(com.atlassian.cache.CacheManager cacheManager)

setEventManager

public void setEventManager(com.atlassian.event.EventManager eventManager)

setLoginManager

public void setLoginManager(LoginManager loginManager)

makeNonAnonymousConfluenceUserFromToken

public ConfluenceUser makeNonAnonymousConfluenceUserFromToken(java.lang.String token)
                                                       throws InvalidSessionException

Retrieves the user for a particular token

Parameters:

token - The authenticated user token

Returns:

The User for the token

Throws:

InvalidSessionException - if a user could not be retrieved for token

Since:

5.2

makeNonAnonymousUserFromToken

@Deprecated
public com.atlassian.user.User makeNonAnonymousUserFromToken(java.lang.String token)
                                                      throws InvalidSessionException

Deprecated. since 5.2. Use makeNonAnonymousConfluenceUserFromToken(String) instead.

Throws:

InvalidSessionException

makeAnonymousConfluenceUser

public ConfluenceUser makeAnonymousConfluenceUser()
                                           throws NotPermittedException

Returns the anonymous user

Returns:

The anonymous user (null)

Throws:

NotPermittedException - if anonymous access to the Remote API is disabled

Since:

5.2

makeAnonymousUser

@Deprecated
public com.atlassian.user.User makeAnonymousUser()
                                          throws NotPermittedException

Deprecated. since 5.2. Use makeAnonymousConfluenceUser() instead.

Throws:

NotPermittedException

hasUseConfluencePermission

public boolean hasUseConfluencePermission(com.atlassian.user.User user)

Determines whether user has access to Confluence

Parameters:

user - The User to be checked

Returns:

true if the user has access, false otherwise