com.sap.cloud.security.servlet

Class TokenAuthenticationResult

java.lang.Object

com.sap.cloud.security.servlet.TokenAuthenticationResult

public class TokenAuthenticationResult
extends Object

Class to collect the result of the authentication performed by a TokenAuthenticator.

Method Summary

Modifier and Type	Method and Description
static TokenAuthenticationResult	createAuthenticated(Collection<String> scopes, Token token)
static TokenAuthenticationResult	createUnauthenticated(String reason) Creates an unauthenticated result with a reason.
Principal	getPrincipal() The principal associated with the request.
Collection<String>	getScopes() The authentication scopes.
Token	getToken() The token that was checked for authentication.
String	getUnauthenticatedReason() If not authenticated, this returns the reason why as text.
boolean	isAuthenticated()

Methods inherited from class java.lang.Object

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

Method Detail

createUnauthenticated

public static final TokenAuthenticationResult createUnauthenticated(String reason)

Creates an unauthenticated result with a reason.

Parameters:

reason - the reason why the request is not authenticated.

Returns:

a TokenAuthenticationResult.

createAuthenticated

public static TokenAuthenticationResult createAuthenticated(Collection<String> scopes,
                                                            Token token)

Parameters:

scopes - the authentication scopes. Can be empty.

token - the token that was checked for authentication.

Returns:

a TokenAuthenticationResult.

getToken

@Nullable
public Token getToken()

The token that was checked for authentication.

Returns:

the token.

getPrincipal

@Nullable
public Principal getPrincipal()

The principal associated with the request.

Returns:

the principal.

getScopes

public Collection<String> getScopes()

The authentication scopes. Can be empty.

Returns:

the scopes as a list of strings.

isAuthenticated

public boolean isAuthenticated()

Returns:

true if authenticated.

getUnauthenticatedReason

public String getUnauthenticatedReason()

If not authenticated, this returns the reason why as text.

Returns:

the textual description why the request was not authenticated. Empty string if authenticated.