auth.gui

Class AuthActionApiToken

java.lang.Object

auth.gui.AuthActionApiToken

@Singleton
public class AuthActionApiToken
extends java.lang.Object

Authentication via personal access tokens (API tokens) that can be used with JATOS API. API tokens are associated with a user and have the same access rights as the user. For a successful authentication the token must be put in the 'Authorization' header with a 'Bearer' prefix. JATOS' API token have a prefex 'jap_'. The User and the ApiToken objects are put in the RequestScope for later use during request processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	auth.gui.AuthAction.IAuth.AuthResult Result for an auth attempt.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_TOKEN

Method Summary

Modifier and Type	Method and Description
auth.gui.AuthAction.IAuth.AuthResult	authenticate(play.mvc.Http.Request request, User.Role role)

Methods inherited from class java.lang.Object

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

Field Detail

API_TOKEN

public static final java.lang.String API_TOKEN

See Also:

Constant Field Values

Method Detail

authenticate

public auth.gui.AuthAction.IAuth.AuthResult authenticate(play.mvc.Http.Request request,
                                                         User.Role role)

Parameters:

request - This action's Http.Request object

role - Role the user must have to access the resource

Returns:

Returns a Result only if auth was unsuccessful. Otherwise, the Optional is empty.