Class OAuth1AuthorizationFlowImpl.Builder

java.lang.Object

org.glassfish.jersey.client.oauth1.OAuth1AuthorizationFlowImpl.Builder

All Implemented Interfaces:

OAuth1Builder.FlowBuilder

Enclosing class:

OAuth1AuthorizationFlowImpl

static class OAuth1AuthorizationFlowImpl.Builder
extends Object
implements OAuth1Builder.FlowBuilder

OAuth1AuthorizationFlowImpl builder.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field	Description
private String	accessTokenUri
private String	authorizationUri
private String	callbackUri
private javax.ws.rs.client.Client	client
private boolean	enableLogging
private final OAuth1Parameters	params
private String	requestTokenUri
private final OAuth1Secrets	secrets

Constructor Summary

Constructors

Constructor	Description
Builder(OAuth1Parameters params, OAuth1Secrets secrets, String requestTokenUri, String accessTokenUri, String authorizationUri)	Create a new builder.

Method Summary

Modifier and Type	Method	Description
OAuth1AuthorizationFlowImpl	build()	Build the OAuth1AuthorizationFlow.
OAuth1Builder.FlowBuilder	callbackUri(String callbackUri)	Set the callback URI to which the user (resource owner) should be redirected after he/she grants access to this application.
OAuth1Builder.FlowBuilder	client(javax.ws.rs.client.Client client)	Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server.
OAuth1Builder.FlowBuilder	enableLogging()	Enable logging (headers and entities) of OAuth requests and responses.

Methods inherited from class Object

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

Field Details

params

private final OAuth1Parameters params

secrets

private final OAuth1Secrets secrets

requestTokenUri

private String requestTokenUri

accessTokenUri

private String accessTokenUri

authorizationUri

private String authorizationUri

client

private javax.ws.rs.client.Client client

callbackUri

private String callbackUri

enableLogging

private boolean enableLogging

Constructor Details

Builder

public Builder(OAuth1Parameters params,
 OAuth1Secrets secrets,
 String requestTokenUri,
 String accessTokenUri,
 String authorizationUri)

Create a new builder.

Parameters:

params - Pre-configured oauth parameters.

secrets - Pre-configured oauth secrets.

requestTokenUri - Request token uri.

accessTokenUri - Access token uri.

authorizationUri - Authorization uri.

Method Details

callbackUri

public OAuth1Builder.FlowBuilder callbackUri(String callbackUri)

Description copied from interface: OAuth1Builder.FlowBuilder

Set the callback URI to which the user (resource owner) should be redirected after he/she grants access to this application. In most cases, the URI is under control of this application and request done on this URI will be used to extract query parameter verifier that will be used in OAuth1AuthorizationFlow.finish(String) method.

If URI is not defined by this method, the default value oob will be used in the Authorization Flow which should cause that verifier will be passed to application in other way than request redirection (for example shown to the user using html page).

Specified by:

callbackUri in interface OAuth1Builder.FlowBuilder

Parameters:

callbackUri - URI that should receive authorization response from the Service Provider.

Returns:

this builder.

client

public OAuth1Builder.FlowBuilder client(javax.ws.rs.client.Client client)

Description copied from interface: OAuth1Builder.FlowBuilder

Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server. If this method is not called, it is up to the implementation to create or get any private client instance to perform these requests. This method could be used mainly for performance reasons to avoid creation of new client instances and have control about created client instances used in the application.

Specified by:

client in interface OAuth1Builder.FlowBuilder

Parameters:

client - Client instance.

Returns:

this builder.

enableLogging

public OAuth1Builder.FlowBuilder enableLogging()

Description copied from interface: OAuth1Builder.FlowBuilder

Enable logging (headers and entities) of OAuth requests and responses.

Specified by:

enableLogging in interface OAuth1Builder.FlowBuilder

Returns:

this builder.

build

public OAuth1AuthorizationFlowImpl build()

Description copied from interface: OAuth1Builder.FlowBuilder

Build the OAuth1AuthorizationFlow.

Specified by:

build in interface OAuth1Builder.FlowBuilder

Returns:

Authorization flow.