com.docusign.esign.client.auth

Class OAuth

java.lang.Object

com.docusign.esign.client.auth.OAuth

All Implemented Interfaces:

Authentication

public class OAuth
extends Object
implements Authentication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth.Account Account model with the following properties: accountId: the account ID GUID.
static class	OAuth.Link Link model with the following properties: rel: currently the only value is "self".
static class	OAuth.OAuthToken OAuthToken model with the following properties: accessToken: the token you will use in the Authorization header of calls to the DocuSign API.
static class	OAuth.Organization Organization model with the following properties: organizationId: the organization ID GUID if DocuSign Org Admin is enabled.
static class	OAuth.UserInfo UserInfo model with the following properties: sub: the user ID GUID.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE used by public/native client applications.
static String	DEMO_OAUTH_BASEPATH sandbox/demo base path
static String	GRANT_TYPE_JWT JWT grant type
static String	PRODUCTION_OAUTH_BASEPATH live/production base path
static String	Scope_EXTENDED obtain a refresh token with an extended lifetime.
static String	Scope_IMPERSONATION obtain access to the user’s account when the user is not present.
static String	Scope_SIGNATURE create and send envelopes, and obtain links for starting signing sessions.
static String	STAGE_OAUTH_BASEPATH stage base path
static String	TOKEN used by private/trusted client application.

Constructor Summary

Constructors

Constructor and Description
OAuth()
OAuth(javax.ws.rs.client.Client client, org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder, org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder authenticationRequestBuilder)
OAuth(javax.ws.rs.client.Client client, OAuthFlow flow, String authorizationUrl, String tokenUrl, String scopes)
OAuth(OAuthFlow flow, String authorizationUrl, String tokenUrl, String scopes)

Method Summary

Modifier and Type	Method and Description
void	applyToParams(List<Pair> queryParams, Map<String,String> headerParams) Apply authentication settings to header and query params.
String	getAccessToken()
org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder	getAuthenticationRequestBuilder()
org.apache.oltu.oauth2.client.OAuthClient	getOauthClient()
org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder	getTokenRequestBuilder()
void	registerAccessTokenListener(AccessTokenListener accessTokenListener)
void	setAccessToken(String accessToken, Long expiresIn)
void	setAuthenticationRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder authenticationRequestBuilder)
void	setOauthClient(javax.ws.rs.client.Client client)
void	setOauthClient(org.apache.oltu.oauth2.client.OAuthClient oauthClient)
void	setTokenRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)
void	updateAccessToken()

Methods inherited from class java.lang.Object

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

Field Detail

Scope_SIGNATURE

public static final String Scope_SIGNATURE

create and send envelopes, and obtain links for starting signing sessions.

See Also:

Constant Field Values

Scope_EXTENDED

public static final String Scope_EXTENDED

obtain a refresh token with an extended lifetime.

See Also:

Constant Field Values

Scope_IMPERSONATION

public static final String Scope_IMPERSONATION

obtain access to the user’s account when the user is not present.

See Also:

Constant Field Values

CODE

public static final String CODE

used by public/native client applications.

See Also:

Constant Field Values

TOKEN

public static final String TOKEN

used by private/trusted client application.

See Also:

Constant Field Values

PRODUCTION_OAUTH_BASEPATH

public static final String PRODUCTION_OAUTH_BASEPATH

live/production base path

See Also:

Constant Field Values

DEMO_OAUTH_BASEPATH

public static final String DEMO_OAUTH_BASEPATH

sandbox/demo base path

See Also:

Constant Field Values

STAGE_OAUTH_BASEPATH

public static final String STAGE_OAUTH_BASEPATH

stage base path

See Also:

Constant Field Values

GRANT_TYPE_JWT

public static final String GRANT_TYPE_JWT

JWT grant type

See Also:

Constant Field Values

Constructor Detail

OAuth

public OAuth()

OAuth

public OAuth(javax.ws.rs.client.Client client,
             org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder,
             org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder authenticationRequestBuilder)

OAuth

public OAuth(javax.ws.rs.client.Client client,
             OAuthFlow flow,
             String authorizationUrl,
             String tokenUrl,
             String scopes)

OAuth

public OAuth(OAuthFlow flow,
             String authorizationUrl,
             String tokenUrl,
             String scopes)

Method Detail

applyToParams

public void applyToParams(List<Pair> queryParams,
                          Map<String,String> headerParams)

Description copied from interface: Authentication

Apply authentication settings to header and query params.

Specified by:

applyToParams in interface Authentication

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters

updateAccessToken

public void updateAccessToken()
                       throws ApiException

Throws:

ApiException

registerAccessTokenListener

public void registerAccessTokenListener(AccessTokenListener accessTokenListener)

getAccessToken

public String getAccessToken()

setAccessToken

public void setAccessToken(String accessToken,
                           Long expiresIn)

getTokenRequestBuilder

public org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder getTokenRequestBuilder()

setTokenRequestBuilder

public void setTokenRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder tokenRequestBuilder)

getAuthenticationRequestBuilder

public org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder getAuthenticationRequestBuilder()

setAuthenticationRequestBuilder

public void setAuthenticationRequestBuilder(org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder authenticationRequestBuilder)

getOauthClient

public org.apache.oltu.oauth2.client.OAuthClient getOauthClient()

setOauthClient

public void setOauthClient(org.apache.oltu.oauth2.client.OAuthClient oauthClient)

setOauthClient

public void setOauthClient(javax.ws.rs.client.Client client)