Package org.nuxeo.ecm.tokenauth.service

Class TokenAuthenticationServiceImpl

java.lang.Object

org.nuxeo.ecm.tokenauth.service.TokenAuthenticationServiceImpl

All Implemented Interfaces:

Serializable, TokenAuthenticationService

public class TokenAuthenticationServiceImpl
extends Object
implements TokenAuthenticationService

Default implementation of the TokenAuthenticationService.

The token is generated by the UUID.randomUUID() method which guarantees its uniqueness. The storage back-end is a SQL Directory.

Since:

5.7

Author:

Antoine Taillefer ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	APPLICATION_NAME_FIELD
protected static String	CREATION_DATE_FIELD
protected static String	DEVICE_DESCRIPTION_FIELD
protected static String	DEVICE_ID_FIELD
protected static String	DIRECTORY_NAME
protected static String	DIRECTORY_SCHEMA
protected static String	PERMISSION_FIELD
protected static String	TOKEN_FIELD
protected static String	USERNAME_FIELD

Constructor Summary

Constructors

Constructor	Description
TokenAuthenticationServiceImpl()

Method Summary

Modifier and Type	Method	Description
String	acquireToken(String userName, String applicationName, String deviceId, String deviceDescription, String permission)	Acquires a unique token for the specified user, application, and device.
String	acquireToken(javax.servlet.http.HttpServletRequest request)	Acquires a unique token for the specified request.
protected DocumentModel	getBareAuthTokenModel(DirectoryService directoryService)
String	getToken(String userName, String applicationName, String deviceId)	Gets the token for the specified user, application, and device.
DocumentModelList	getTokenBindings(String userName)	Gets the token bindings for the specified user.
DocumentModelList	getTokenBindings(String userName, String applicationName)	Gets the token bindings for the specified user and application.
String	getUserName(String token)	Gets the user name bound to the specified token.
void	revokeToken(String token)	Removes the token from the back-end.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTORY_NAME

protected static final String DIRECTORY_NAME

See Also:

Constant Field Values

DIRECTORY_SCHEMA

protected static final String DIRECTORY_SCHEMA

See Also:

Constant Field Values

USERNAME_FIELD

protected static final String USERNAME_FIELD

See Also:

Constant Field Values

TOKEN_FIELD

protected static final String TOKEN_FIELD

See Also:

Constant Field Values

APPLICATION_NAME_FIELD

protected static final String APPLICATION_NAME_FIELD

See Also:

Constant Field Values

DEVICE_ID_FIELD

protected static final String DEVICE_ID_FIELD

See Also:

Constant Field Values

DEVICE_DESCRIPTION_FIELD

protected static final String DEVICE_DESCRIPTION_FIELD

See Also:

Constant Field Values

PERMISSION_FIELD

protected static final String PERMISSION_FIELD

See Also:

Constant Field Values

CREATION_DATE_FIELD

protected static final String CREATION_DATE_FIELD

See Also:

Constant Field Values

Constructor Detail

TokenAuthenticationServiceImpl

public TokenAuthenticationServiceImpl()

Method Detail

acquireToken

public String acquireToken(String userName,
                           String applicationName,
                           String deviceId,
                           String deviceDescription,
                           String permission)
                    throws TokenAuthenticationException

Description copied from interface: TokenAuthenticationService

Acquires a unique token for the specified user, application, and device.

If such a token exist in the back-end for the specified (userName, applicationName, deviceId) triplet, just returns it, else generates it and stores it in the back-end with the triplet attributes, the specified device description and permission.

Specified by:

acquireToken in interface TokenAuthenticationService

Throws:

TokenAuthenticationException - if one of the required parameters is null or empty (all parameters are required except for the device description)

acquireToken

public String acquireToken(javax.servlet.http.HttpServletRequest request)
                    throws TokenAuthenticationException

Description copied from interface: TokenAuthenticationService

Acquires a unique token for the specified request.

Parameters needed (applicationName, deviceId, deviceDescription, permission) to acquire the token are extracted from the request itself.

If such a token exist in the back-end for the specified (userName, applicationName, deviceId) triplet, just returns it, else generates it and stores it in the back-end with the triplet attributes, the specified device description and permission.

Specified by:

acquireToken in interface TokenAuthenticationService

Returns:

a token or null for no principal or for anonymous principal unless 'allowAnonymous' parameter is explicitly set to true in the authentication plugin configuration.

Throws:

TokenAuthenticationException - if one of the required parameters is null or empty (all parameters are required except for the device description)

getToken

public String getToken(String userName,
                       String applicationName,
                       String deviceId)
                throws TokenAuthenticationException

Description copied from interface: TokenAuthenticationService

Gets the token for the specified user, application, and device.

Specified by:

getToken in interface TokenAuthenticationService

Returns:

null if such a token doesn't exist

Throws:

TokenAuthenticationException - if one of the required parameters is null or empty (all parameters are required except for the device description)

getUserName

public String getUserName(String token)

Description copied from interface: TokenAuthenticationService

Gets the user name bound to the specified token.

Specified by:

getUserName in interface TokenAuthenticationService

Returns:

The user name bound to the specified token, or null if the token does not exist in the back-end.

revokeToken

public void revokeToken(String token)

Description copied from interface: TokenAuthenticationService

Removes the token from the back-end.

Specified by:

revokeToken in interface TokenAuthenticationService

getTokenBindings

public DocumentModelList getTokenBindings(String userName)

Description copied from interface: TokenAuthenticationService

Gets the token bindings for the specified user.

Specified by:

getTokenBindings in interface TokenAuthenticationService

getTokenBindings

public DocumentModelList getTokenBindings(String userName,
                                          String applicationName)

Description copied from interface: TokenAuthenticationService

Gets the token bindings for the specified user and application.

Specified by:

getTokenBindings in interface TokenAuthenticationService

getBareAuthTokenModel

protected DocumentModel getBareAuthTokenModel(DirectoryService directoryService)