com.cloudbees.api.oauth

Class TokenRequest

java.lang.Object

com.cloudbees.api.oauth.TokenRequest

public class TokenRequest
extends Object

Parameters for OauthClient.createToken(TokenRequest) call.

Author:

Vivek Pandey, Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
TokenRequest()
TokenRequest(String note, String noteUrl, String refreshToken, String accountName, String... scopes) Create a Json serializable Oauth token request.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessType()
String	getAccountName()
String	getNote()
String	getNoteUrl()
String	getRefreshToken()
List<String>	getScopes()
String	toString() For assisting debugging.
TokenRequest	withAccountName(String accountName) Sets the account name that the generated token is restricted to.
TokenRequest	withGenerateRequestToken(boolean b) Request that the refresh token be generated aside from access token.
TokenRequest	withNote(String note)
TokenRequest	withNote(String note, String noteUrl)
TokenRequest	withRefreshToken(String refreshToken) Instead of authenticating the create token request with the parameters you set in BeesClientConfiguration (such as API key + secret, or username + password), authenticate the call with the specified refresh token generated earlier.
TokenRequest	withScope(CloudResource res, Capability capability)
TokenRequest	withScope(String scope) Adds more scopes to this request.
TokenRequest	withScope(URL cloudResource, Capability capability)
TokenRequest	withScopes(String... scopes)

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenRequest

public TokenRequest(String note,
            String noteUrl,
            String refreshToken,
            String accountName,
            String... scopes)

Create a Json serializable Oauth token request.

Parameters:

note - optional. Tells something about the oauth application

noteUrl - optional. Your application URL

refreshToken - optional. Refresh token that should be used to generate a new token.

accountName - required. Name of the account

scopes - Optional. array of scopes to be granted with this token. The default scope is https://api.cloudbees.com/v2/users/user, which is user read and write scope. If you are creating token to crete other tokens with specific scopes you must ask for https://api.cloudbees.com/v2/users/user/generate_token scope scope.

Throws:

IllegalArgumentException - In case there is an error

TokenRequest

public TokenRequest()

Method Detail

getNote

public String getNote()

getNoteUrl

public String getNoteUrl()

withNote

public TokenRequest withNote(String note)

withNote

public TokenRequest withNote(String note,
                    String noteUrl)

Parameters:

note - One liner human readable text describing who requested this token. This will aid users in reviewing and revoking tokens later. Can be null.

noteUrl - URL that provides more details about the note. Can be null.

getScopes

public List<String> getScopes()

withScope

public TokenRequest withScope(String scope)

Adds more scopes to this request. A scope needs to look like an URI.

withScopes

public TokenRequest withScopes(String... scopes)

withScope

public TokenRequest withScope(CloudResource res,
                     Capability capability)

withScope

public TokenRequest withScope(URL cloudResource,
                     Capability capability)

getRefreshToken

public String getRefreshToken()

withRefreshToken

public TokenRequest withRefreshToken(String refreshToken)

Instead of authenticating the create token request with the parameters you set in BeesClientConfiguration (such as API key + secret, or username + password), authenticate the call with the specified refresh token generated earlier.

getAccountName

public String getAccountName()

withAccountName

public TokenRequest withAccountName(String accountName)

Sets the account name that the generated token is restricted to. An OAuth token is always restricted to just one account (out of all the accounts that the user has access to.)

getAccessType

public String getAccessType()

withGenerateRequestToken

public TokenRequest withGenerateRequestToken(boolean b)

Request that the refresh token be generated aside from access token. Unlike access token which will expire automatically in a short amount of time (currently an hour), a refresh token allows the client to generate more access tokens in the future.

See Also:

withRefreshToken(String)

toString

public String toString()

For assisting debugging.

Overrides:

toString in class Object