oracle.stellent.ridc.auth.impl

Class BearerTokenCredentials

java.lang.Object

oracle.stellent.ridc.auth.impl.BearerTokenCredentials

All Implemented Interfaces:

Credentials, Credentials.BearerTokenCredentials

@Exported
public class BearerTokenCredentials
extends Object
implements Credentials.BearerTokenCredentials

Credentials to use for Bearer Token Auth requests. Note - this credential should be not be shared across threads in the event setter methods will be triggered post construction. In its current format, it is not thread-safe for post construction updates.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.stellent.ridc.auth.Credentials

Credentials.AppIdClientCredentials, Credentials.BasicCredentials, Credentials.BearerTokenCredentials, Credentials.HeaderCredentials, Credentials.HttpClientCredentials, Credentials.UserNameOnlyCredentials

Constructor Summary

Constructors

Constructor and Description
BearerTokenCredentials(char[] token) Constructor wrapping a bearer token applicable for all realms with no expiry time
BearerTokenCredentials(char[] token, String realm, long expiryTime) Constructor wrapping a bearer token applicable for the specified realm and value until the specified expiryTime
BearerTokenCredentials(String token) Constructor wrapping a bearer token applicable for all realms with no expiry time

Method Summary

Modifier and Type	Method and Description
String	getCredentialsClassName()
long	getExpiryTime()
String	getLogId()
String	getRealm()
char[]	getToken()
String	getUserName()
static String	maskToken(char[] token)
void	setExpiryTime(long expiryTime) set the expiry time of the token An expiryTime value less than or equal to 0 indicates the token never expires.
void	setRealm(String realm) set the realm name to which the token applies (null indicates all realms)
void	setToken(char[] token) set the bearer token
void	wipeToken() erase the bearer token

Methods inherited from class java.lang.Object

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

Constructor Detail

BearerTokenCredentials

public BearerTokenCredentials(String token)

Constructor wrapping a bearer token applicable for all realms with no expiry time

Parameters:

token - the bearer token

BearerTokenCredentials

public BearerTokenCredentials(char[] token)

Constructor wrapping a bearer token applicable for all realms with no expiry time

Parameters:

token - the bearer token

BearerTokenCredentials

public BearerTokenCredentials(char[] token,
                              String realm,
                              long expiryTime)

Constructor wrapping a bearer token applicable for the specified realm and value until the specified expiryTime

Parameters:

token - the bearer token

realm - the realm to which the token applies (null indicates all realms)

expiryTime - the number of milliseconds post epoch at which point the token expires. An expiryTime value less than or equal to 0 indicates the token never expires.

Method Detail

getToken

public char[] getToken()

Specified by:

getToken in interface Credentials.BearerTokenCredentials

Returns:

the bearer token

setToken

public void setToken(char[] token)

set the bearer token

Parameters:

token - the bearer token

getRealm

public String getRealm()

Specified by:

getRealm in interface Credentials.BearerTokenCredentials

Returns:

the realm name to which the token applies (null indicates all realms)

setRealm

public void setRealm(String realm)

set the realm name to which the token applies (null indicates all realms)

Parameters:

realm - the token's associated realm

getExpiryTime

public long getExpiryTime()

Specified by:

getExpiryTime in interface Credentials.BearerTokenCredentials

Returns:

the number of milliseconds post epoch at which point the token expires. An expiryTime value less than or equal to 0 indicates the token never expires.

setExpiryTime

public void setExpiryTime(long expiryTime)

set the expiry time of the token An expiryTime value less than or equal to 0 indicates the token never expires.

Parameters:

expiryTime - the number of milliseconds post epoch at which point the token expires.

wipeToken

public void wipeToken()

erase the bearer token

getUserName

public String getUserName()

Specified by:

getUserName in interface Credentials

Returns:

the user name associated with the credential

getCredentialsClassName

public String getCredentialsClassName()

Specified by:

getCredentialsClassName in interface Credentials

Returns:

the name of the credentials class

getLogId

public String getLogId()

Specified by:

getLogId in interface Credentials

Returns:

the identifier used for these credentials, used for logging messages

maskToken

public static String maskToken(char[] token)