Package com.atlan.auth

Class APITokenManager

java.lang.Object

com.atlan.auth.TokenManager

com.atlan.auth.APITokenManager

public class APITokenManager
extends TokenManager

Manage API tokens.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENVIRONMENT_VARIABLE

Fields inherited from class com.atlan.auth.TokenManager

lock, token

Constructor Summary

Constructors

Constructor	Description
APITokenManager(char[] token)

Method Summary

Modifier and Type	Method	Description
protected String	getAuthHeader()	Retrieve the header to use for Authorization using this token.
protected boolean	refreshToken(AtlanClient client)	Refresh the API token.

Methods inherited from class com.atlan.auth.TokenManager

getHeader, refresh

Methods inherited from class java.lang.Object

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

Field Details

ENVIRONMENT_VARIABLE

public static final String ENVIRONMENT_VARIABLE

See Also:

• Constant Field Values

Constructor Details

APITokenManager

public APITokenManager(char[] token)

Method Details

getAuthHeader

protected String getAuthHeader()

Retrieve the header to use for Authorization using this token.

Specified by:

getAuthHeader in class TokenManager

Returns:

the value for the Authorization header

refreshToken

protected boolean refreshToken(AtlanClient client)
                        throws AtlanException

Refresh the API token.

Specified by:

refreshToken in class TokenManager

Parameters:

client - through which to refresh the token

Returns:

true iff the refresh was successful

Throws:

AtlanException - on any API communication issue