com.sap.cloud.security.servlet

Interface TokenAuthenticationResult

public interface TokenAuthenticationResult

Class that represents the result of the authentication check performed by a TokenAuthenticator.

Method Summary

Modifier and Type	Method and Description
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()

Method Detail

getToken

@Nullable
Token getToken()

The token that was checked for authentication.

Returns:

the token.

getPrincipal

@Nullable
Principal getPrincipal()

The principal associated with the request.

Returns:

the principal.

getScopes

Collection<String> getScopes()

The authentication scopes. Can be empty.

Returns:

the scopes as a list of strings.

isAuthenticated

boolean isAuthenticated()

Returns:

true if authenticated.

getUnauthenticatedReason

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.