org.glassfish.jersey.client.oauth1

Interface OAuth1Builder.FlowBuilder

Enclosing interface:

OAuth1Builder

public static interface OAuth1Builder.FlowBuilder

Builder of the OAuth1AuthorizationFlow.

Method Summary

Modifier and Type	Method and Description
OAuth1AuthorizationFlow	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(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.

Method Detail

callbackUri

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. 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).

Parameters:

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

Returns:

this builder.

client

OAuth1Builder.FlowBuilder client(Client client)

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.

Parameters:

client - Client instance.

Returns:

this builder.

enableLogging

OAuth1Builder.FlowBuilder enableLogging()

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

Returns:

this builder.

Since:

2.7

build

OAuth1AuthorizationFlow build()

Build the OAuth1AuthorizationFlow.

Returns:

Authorization flow.