AccessToken

java.lang.Object

com.polarion.platform.security.login.AccessToken

All Implemented Interfaces:: ILoginAuthenticator

public final class AccessToken extends Object implements ILoginAuthenticator

Authenticator type to use with personal access token

Since:: 3.22.1

Field Summary

Fields

Modifier and Type

Field

Description

static final String

MECHANISM
Constructor Summary

Constructors

Constructor

Description

AccessToken()
Method Summary

Modifier and Type

Method

Description

String

getId()

Get an authenticator ID.

static AccessToken

id()

Create a typed authenticator ID.

static IToken<AccessToken>

token(String token)

Prepare and create a typed personal access token instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- MECHANISM
  
  public static final String MECHANISM
  See Also:
  
  Constant Field Values
Constructor Details
- AccessToken
  
  public AccessToken()
Method Details
- id
  
  @NotNull public static AccessToken id()
  
  Create a typed authenticator ID.
  
  Returns:
  
  typed authenticator ID.
- getId
  
  @NotNull public String getId()
  
  Description copied from interface: ILoginAuthenticator
  
  Get an authenticator ID.
  
  Specified by:
  
  getId in interface ILoginAuthenticator
  
  Returns:
  
  authenticator ID.
- token
  
  @NotNull public static IToken<AccessToken> token(@NotNull String token)
  
  Prepare and create a typed personal access token instance.
  
  Parameters:
  
  token - raw personal access token as it is received.
  
  Returns:
  
  typed and prepared token instance.