Package org.glassfish.jersey.client.oauth1

Class OAuth1ClientSupport

java.lang.Object

org.glassfish.jersey.client.oauth1.OAuth1ClientSupport

public final class OAuth1ClientSupport
extends Object

The main class to build the support for OAuth 1 into the Jersey client.

The support for OAuth is divided into two parts:

Authorization Flow: process of acquiring the user approval for accessing user's resources on the Service Provider. The authorization process is managed by an implementation of OAuth1AuthorizationFlow interface. The result of the process is an AccessToken.

Authenticated Requests: requests done by a client are enhanced by an Authorization http header that contains OAuth1 authorization information based on the AccessToken received from Authorization flow. This support is provided by oauth 1 filter feature that is registered into client configuration.

This class contains static method that allows to build both OAuth1 features (authorization flow and client feature).

Since:

2.3

Author:

Miroslav Fuksa

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OAUTH_PROPERTY_ACCESS_TOKEN	Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines access token that should be used when generating OAuth Authorization http header.
static final String	OAUTH_PROPERTY_CONSUMER_CREDENTIALS	Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines consumer credentials that should be used when generating OAuth Authorization http header.
static final String	OAUTH_PROPERTY_OAUTH_PARAMETERS	Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines OAuth1Parameters that should be used when generating OAuth Authorization http header.
static final String	OAUTH_PROPERTY_OAUTH_SECRETS	Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines OAuth1Secrets that should be used when generating OAuth Authorization http header.

Method Summary

Modifier and Type	Method	Description
static OAuth1Builder	builder(ConsumerCredentials consumerCredentials)	Get a new builder of OAuth1 client support.

Methods inherited from class java.lang.Object

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

Field Details

OAUTH_PROPERTY_CONSUMER_CREDENTIALS

public static final String OAUTH_PROPERTY_CONSUMER_CREDENTIALS

Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines consumer credentials that should be used when generating OAuth Authorization http header. The property will override the setting of the internal filter for the current request only.

The value of the property must be ConsumerCredentials instance.

See Also:

• Constant Field Values

OAUTH_PROPERTY_ACCESS_TOKEN

public static final String OAUTH_PROPERTY_ACCESS_TOKEN

Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines access token that should be used when generating OAuth Authorization http header. The property will override the setting of the internal filter for the current request only.

The value of the property must be AccessToken instance.

See Also:

• Constant Field Values

OAUTH_PROPERTY_OAUTH_PARAMETERS

public static final String OAUTH_PROPERTY_OAUTH_PARAMETERS

Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines OAuth1Parameters that should be used when generating OAuth Authorization http header. The property will override the setting of the internal filter for the current request only.

The value of the property must be OAuth1Parameters instance.

This property is for advanced usage and should not be used if not needed as it can make the filter configuration inconsistent for the request and can produce unwanted results.

This property should be used only for configuring an instance of OAuth feature, not the Authorization flow.

See Also:

• Constant Field Values

OAUTH_PROPERTY_OAUTH_SECRETS

public static final String OAUTH_PROPERTY_OAUTH_SECRETS

Key of the property that can be attached to the client request using ClientRequestContext.setProperty(String, Object) and that defines OAuth1Secrets that should be used when generating OAuth Authorization http header. The property will override the setting of the internal filter for the current request only.

The value of the property must be OAuth1Secrets instance.

This property is for advanced usage and should not be used if not needed as it can make the filter configuration inconsistent for the request and can produce unwanted results.

This property should be used only for configuring an instance of OAuth feature, not the Authorization flow.

See Also:

• Constant Field Values

Method Details

builder

public static OAuth1Builder builder(ConsumerCredentials consumerCredentials)

Get a new builder of OAuth1 client support.

Parameters:

consumerCredentials - Consumer credentials issued by the service provider for the application that wants to access data.

Returns:

Builder instance.