Class ApiKeyAuthenticationToken

java.lang.Object

com.codename1.backend.security.AbstractAuthenticationToken

com.codename1.backend.security.apikey.ApiKeyAuthenticationToken

All Implemented Interfaces:

Authentication

public final class ApiKeyAuthenticationToken
extends AbstractAuthenticationToken

Who a request is from, when an API key says so. The principal is the ApiKey, the name is the key's owner, and each of the key's scopes is the authority SCOPE_x -- the same authorities a token with those scopes gets, so one set of rules covers both.

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuthenticationToken(ApiKey apiKey)

Method Summary

Modifier and Type	Method	Description
ApiKey	getApiKey()
Object	getCredentials()	Null: the key itself is not kept once it has been recognized.
String	getName()	The principal's name.
Object	getPrincipal()	The identity: a username before authentication, and afterwards usually the UserDetails it was resolved to.

Methods inherited from class AbstractAuthenticationToken

eraseCredentials, getAuthorities, getDetails, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class Object

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

Constructor Details

ApiKeyAuthenticationToken

public ApiKeyAuthenticationToken(ApiKey apiKey)

Method Details

getApiKey

public ApiKey getApiKey()

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity: a username before authentication, and afterwards usually the UserDetails it was resolved to.

getCredentials

public Object getCredentials()

Null: the key itself is not kept once it has been recognized.

getName

public String getName()

Description copied from interface: Authentication

The principal's name.

Specified by:

getName in interface Authentication

Overrides:

getName in class AbstractAuthenticationToken