Package com.atlassian.bitbucket.jenkins.internal.applink.oauth

Class Token

java.lang.Object

com.atlassian.bitbucket.jenkins.internal.applink.oauth.Token

Direct Known Subclasses:

ServiceProviderToken

public abstract class Token
extends Object

Base type for OAuth tokens. This type should never be used directly. Instead, use the more specific com.atlassian.oauth.serviceprovider.ServiceProviderToken

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Token.TokenBuilder<T,B extends Token.TokenBuilder<T,B>>	Base builder that can be used by Token subclasses to build token instances.
protected static enum	Token.Type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Token(Token.TokenBuilder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
final Consumer	getConsumer()	Returns the Consumer that owns this token.
final Map<String,String>	getProperties()	Returns an immutable map of the tokens properties.
final String	getProperty(String property)	Returns the value of the property, or null if the property doesn't exist.
final Iterable<String>	getPropertyNames()	Returns the names of the properties for this token.
final String	getToken()	Returns the token value used to identify this token in OAuth messages.
final String	getTokenSecret()	Returns the secret used by the Consumer to establish ownership of a given Token.
final boolean	hasProperty(String property)	Returns true if this token contains the optional property, false otherwise.
final boolean	isAccessToken()	Returns true if this is an access token, false otherwise.
final boolean	isRequestToken()	Returns true if this is a request token, false otherwise.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Token

protected Token(Token.TokenBuilder<?,?> builder)

Method Details

getToken

public final String getToken()

Returns the token value used to identify this token in OAuth messages.

Returns:

the token value used to identify this token in OAuth messages

getTokenSecret

public final String getTokenSecret()

Returns the secret used by the Consumer to establish ownership of a given Token.

Returns:

the secret used by the Consumer to establish ownership of a given Token

getConsumer

public final Consumer getConsumer()

Returns the Consumer that owns this token.

Returns:

the Consumer that owns this token

isRequestToken

public final boolean isRequestToken()

Returns true if this is a request token, false otherwise.

Returns:

true if this is a request token, false otherwise.

isAccessToken

public final boolean isAccessToken()

Returns true if this is an access token, false otherwise.

Returns:

true if this is an access token, false otherwise.

hasProperty

public final boolean hasProperty(String property)

Returns true if this token contains the optional property, false otherwise.

Parameters:

property - name of the property to check the token for

Returns:

true if this token contains the optional property, false otherwise.

getProperty

public final String getProperty(String property)

Returns the value of the property, or null if the property doesn't exist.

Parameters:

property - name of the property to whose value is to be returned

Returns:

the value of the property, or null if the property doesn't exist

getPropertyNames

public final Iterable<String> getPropertyNames()

Returns the names of the properties for this token.

Returns:

the names of the properties for this token

getProperties

public final Map<String,String> getProperties()

Returns an immutable map of the tokens properties.

Returns:

an immutable map of the tokens properties

toString

public String toString()

Overrides:

toString in class Object