com.cloudbees.api.oauth

Class OauthToken

java.lang.Object

com.cloudbees.api.OAuthObject

com.cloudbees.api.oauth.AbstractOauthToken

com.cloudbees.api.oauth.OauthToken

All Implemented Interfaces:

Cloneable

public class OauthToken
extends AbstractOauthToken
implements Cloneable

OAuth token and information contained within it as defined by the OAuth spec.

Author:

Vivek Pandey

Field Summary

Fields

Modifier and Type	Field and Description
String	accessToken A short-lived opaque token that you'll send in the "Authorize" HTTP header as "Authorize: bearer valueOfAccessToken"
String	clientId
String	refreshToken Refresh token lasts for a long time and can be used to obtain additional accessTokens.
String	scope White-space separated OAuth scopes of this token.
String	tokenType

Fields inherited from class com.cloudbees.api.oauth.AbstractOauthToken

email, id, uid, userAccountRole

Fields inherited from class com.cloudbees.api.OAuthObject

owner

Constructor Summary

Constructors

Constructor and Description
OauthToken()

Method Summary

Methods

Modifier and Type	Method and Description
Credential	asCredential() Uses this OAuth token as a Credential object.
boolean	belongsToAccount(String account) Checks if this token grants access to the specified account.
OauthToken	clone()
BeesClient	createClient() Creates a new BeesClient that uses the access token encapsulated in this OauthToken
BeesClient	createClient(com.cloudbees.api.BeesClientConfiguration current) Creates a new BeesClient that uses the access token encapsulated in this OauthToken.
Integer	getExpiresIn() The number of seconds the access token will be valid, relative to the point of time where the call is issued to obtain this object (such as via OauthClient.validateToken(String, String...).
List<String>	getScopes() OAuth scopes of this token split by the whitespace.
boolean	isExpired()
Collection<String>	listAccounts() List up all the accounts to which this token grants some access.
void	setAccount(String account)
void	setExpiresIn(int expiresIn)
boolean	validateCapability(URL host, Capability cap) Checks if this token has a scope that matches the given domain name and capability.
boolean	validateScope(String scope) Return true if the given scope is fond in the scopes granted with this token
boolean	validateScopes(String... scopes) Checks if this token has any of the scopes specified

Methods inherited from class com.cloudbees.api.oauth.AbstractOauthToken

delete

Methods inherited from class java.lang.Object

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

Field Detail

accessToken

public String accessToken

A short-lived opaque token that you'll send in the "Authorize" HTTP header as "Authorize: bearer valueOfAccessToken"

refreshToken

public String refreshToken

Refresh token lasts for a long time and can be used to obtain additional accessTokens.

tokenType

public String tokenType

clientId

public String clientId

scope

public String scope

White-space separated OAuth scopes of this token. The meaning of the scope values are up to the applications.

Constructor Detail

OauthToken

public OauthToken()

Method Detail

getScopes

public List<String> getScopes()

OAuth scopes of this token split by the whitespace.

validateScope

@CheckReturnValue
public boolean validateScope(String scope)

Return true if the given scope is fond in the scopes granted with this token

validateScopes

@CheckReturnValue
public boolean validateScopes(String... scopes)

Checks if this token has any of the scopes specified

validateCapability

@CheckReturnValue
public boolean validateCapability(URL host,
                                          Capability cap)

Checks if this token has a scope that matches the given domain name and capability.

Parameters:

host - Represents the endpoint.

belongsToAccount

public boolean belongsToAccount(String account)

Checks if this token grants access to the specified account.

listAccounts

public Collection<String> listAccounts()

List up all the accounts to which this token grants some access.

setAccount

public void setAccount(String account)

getExpiresIn

public Integer getExpiresIn()

The number of seconds the access token will be valid, relative to the point of time where the call is issued to obtain this object (such as via OauthClient.validateToken(String, String...). 0 or less means the token has already expired.

setExpiresIn

public void setExpiresIn(int expiresIn)

isExpired

public boolean isExpired()

clone

public OauthToken clone()

Overrides:

clone in class Object

createClient

public BeesClient createClient()

Creates a new BeesClient that uses the access token encapsulated in this OauthToken

createClient

public BeesClient createClient(com.cloudbees.api.BeesClientConfiguration current)

Creates a new BeesClient that uses the access token encapsulated in this OauthToken.

Parameters:

current - The configuration parameter to inherit from. This method does not mutate this object.

asCredential

public Credential asCredential()

Uses this OAuth token as a Credential object.