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 (ataillefer@nuxeo.com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenAuthenticationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and 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	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.
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

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

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)

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