A B C D E F G H I M N O P R S T U V W

A

AccessToken - Class in net.oauth2

A Java object model binding for the standard OAuth 2 access token format.

AccessToken(String, String, long, String, Collection<String>) - Constructor for class net.oauth2.AccessToken

Initializes an oauth token object from standard properties.

AccessToken(Map<String, Object>) - Constructor for class net.oauth2.AccessToken

Initialize from map of properties such as "access_token" and "expires_in".

AccessTokenGrantRequest - Class in net.oauth2

The basis OAuth access token grant request type.

AccessTokenGrantRequest(String, String, String, Collection<String>) - Constructor for class net.oauth2.AccessTokenGrantRequest

Initializes grant request from properties.

asMap(T, Map<String, String>) - Static method in class net.oauth2.BeanUtils

The method transforms a oauth payload object properties (grant or token) to a properties map by introspection.

attach(TokenChangeObserver<T>) - Method in interface net.oauth2.client.TokenChangeObservable

Subscribes an observer to notification upon Access Token changes.

AuthorizationCodeGrantRequest - Class in net.oauth2

Models the "authorization_code" type of oauth token grant requests.

AuthorizationCodeGrantRequest(String, String, String, String, Collection<String>) - Constructor for class net.oauth2.AuthorizationCodeGrantRequest

B

BeanUtils - Class in net.oauth2

Utility class for operations on bean-like classes.

BeanUtils() - Constructor for class net.oauth2.BeanUtils

C

ClientCredentialsGrantRequest - Class in net.oauth2

Models the "client_credentials" type of oauth token grant requests.

ClientCredentialsGrantRequest(String, String, Collection<String>) - Constructor for class net.oauth2.ClientCredentialsGrantRequest

Constructs a "client_credentials" type of grant request from properties.

CollectionDeserializer() - Constructor for class net.oauth2.client.http.FormEncodeDataBinding.CollectionDeserializer

CollectionSerializer() - Constructor for class net.oauth2.client.http.FormEncodeDataBinding.CollectionSerializer

create(T) - Static method in class net.oauth2.TemporalAccessToken

Static object factory defaulting the initial moment of token validitiy to the current moment.

D

DataBindingProvider<O> - Interface in net.oauth2.client.http

An abstraction for the data binding operations performed by TokenServiceHttpClient.

DEFAULT_PATH - Static variable in interface net.oauth2.client.http.TokenServiceHttpClient

The default URL path string to an authorization server token service with value "token".

DEFAULT_URL_PATH - Static variable in interface net.oauth2.client.TokenService

delimiter(String) - Method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionDeserializer

deserialize(String) - Method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionDeserializer

E

encode(T, Map<String, WwwFormUrlEncodedCodec.Serializer>) - Method in class net.oauth2.client.http.FormEncodeDataBinding

Encodes a parameters map grant/token payload into www.form-encode string

equals(Object) - Method in class net.oauth2.AccessTokenGrantRequest

equals(Object) - Method in class net.oauth2.AuthorizationCodeGrantRequest

equals(Object) - Method in class net.oauth2.PasswordCredentialsGrantRequest

equals(Object) - Method in class net.oauth2.ProtocolError

equals(Object) - Method in class net.oauth2.RefreshTokenGrantRequest

equals(Object) - Method in class net.oauth2.TemporalAccessToken

estimatedRepetitionsDelay() - Method in interface net.oauth2.client.TokenProviderJob

Provides the real estimated delay between two token renew repetitions.

F

fetch() - Method in interface net.oauth2.client.TokenService

Sends a request for an Access Token to the backend Token Service.

format(AccessToken) - Static method in class net.oauth2.client.http.ResourceOAuthHeader

Formats a OAuth access token into standard OAuth value for the Authorization HTTP request header

formatToDelimitedString(Collection<T>) - Static method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionSerializer

FormEncodeDataBinding - Class in net.oauth2.client.http

A www.form-encode codec for oauth payloads posted to OAuth Token Service.

FormEncodeDataBinding() - Constructor for class net.oauth2.client.http.FormEncodeDataBinding

FormEncodeDataBinding.CollectionDeserializer<T> - Class in net.oauth2.client.http

Deserizalizer for scope strings into collection.

FormEncodeDataBinding.CollectionSerializer<T> - Class in net.oauth2.client.http

Collection serializer for grant/token scopes that uses whitespace as delimeter.

from(String, Class<T>, Map<String, WwwFormUrlEncodedCodec.Deserializer>) - Method in class net.oauth2.client.http.FormEncodeDataBinding

Decodes a www.form-encode string into grant/token object of the given targetClass type T.

G

get() - Method in interface net.oauth2.client.TokenProvider

Return token synchronously

getAccessToken() - Method in class net.oauth2.AccessToken

Returns the "access_token" string in this oauth token.

getClientId() - Method in class net.oauth2.AccessTokenGrantRequest

getClientSecret() - Method in class net.oauth2.AccessTokenGrantRequest

getCode() - Method in class net.oauth2.AuthorizationCodeGrantRequest

getDescription() - Method in class net.oauth2.ProtocolError

getError() - Method in exception net.oauth2.client.OAuth2ProtocolException

getError() - Method in class net.oauth2.ProtocolError

getErrorType() - Method in class net.oauth2.ProtocolError

getExpiresIn() - Method in class net.oauth2.AccessToken

Returns the "expires_in" number in this access token.

getGrantType() - Method in class net.oauth2.AccessTokenGrantRequest

Returns the grant type of this grant request.

getPassword() - Method in class net.oauth2.PasswordCredentialsGrantRequest

getPropertyMap() - Static method in class net.oauth2.AccessToken

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getPropertyMap() - Static method in class net.oauth2.AccessTokenGrantRequest

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getPropertyMap() - Static method in class net.oauth2.AuthorizationCodeGrantRequest

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getPropertyMap() - Static method in class net.oauth2.PasswordCredentialsGrantRequest

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getPropertyMap() - Static method in class net.oauth2.ProtocolError

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getPropertyMap() - Static method in class net.oauth2.RefreshTokenGrantRequest

Maps Bean introspection property descriptors name to OAuth2 valid payload property names.

getRedirectUri() - Method in class net.oauth2.AuthorizationCodeGrantRequest

getRefreshToken() - Method in class net.oauth2.AccessToken

Returns the "refresh_token" string in this oauth token.

getRefreshToken() - Method in class net.oauth2.RefreshTokenGrantRequest

getScopes() - Method in class net.oauth2.AccessToken

Returns the "scope" in this oauth token, modeled as collection of scope strings.

getScopes() - Method in class net.oauth2.AccessTokenGrantRequest

getState() - Method in class net.oauth2.ProtocolError

getTokenType() - Method in class net.oauth2.AccessToken

Returns the "token_type" string in this oauth token.

getType() - Method in enum net.oauth2.ProtocolErrorType

getUri() - Method in class net.oauth2.ProtocolError

getUsername() - Method in class net.oauth2.PasswordCredentialsGrantRequest

H

hashCode() - Method in class net.oauth2.AccessTokenGrantRequest

hashCode() - Method in class net.oauth2.AuthorizationCodeGrantRequest

hashCode() - Method in class net.oauth2.PasswordCredentialsGrantRequest

hashCode() - Method in class net.oauth2.ProtocolError

hashCode() - Method in class net.oauth2.RefreshTokenGrantRequest

hashCode() - Method in class net.oauth2.TemporalAccessToken

hasScope(String) - Method in class net.oauth2.AccessToken

Checks if scope is one of the configured scopes for this access token.

HTTP_HEADER_NAME_AUTHORIZATION - Static variable in class net.oauth2.client.http.ResourceOAuthHeader

I

isActive() - Method in interface net.oauth2.client.TokenProviderJob

Convenience check that returns the active status of this Token Provider Job.

isExpired() - Method in class net.oauth2.TemporalAccessToken

Checks if this token has expired.

isExpired(T, Instant, TemporalUnit) - Static method in class net.oauth2.TemporalAccessToken

Static check for tokens whether they are still valid if they have been active since the provided moment.

M

map() - Method in class net.oauth2.AccessToken

Returns the properties of this token object as map.

map() - Method in class net.oauth2.AccessTokenGrantRequest

map() - Method in class net.oauth2.AuthorizationCodeGrantRequest

map() - Method in interface net.oauth2.ParametersMap

map() - Method in class net.oauth2.PasswordCredentialsGrantRequest

map() - Method in class net.oauth2.ProtocolError

map() - Method in class net.oauth2.RefreshTokenGrantRequest

maxRetries() - Method in interface net.oauth2.client.RetryPolicy

N

net.oauth2 - package net.oauth2

net.oauth2.client - package net.oauth2.client

net.oauth2.client.http - package net.oauth2.client.http

O

OAuth2ProtocolException - Exception in net.oauth2.client

Exception wrapper for OAuth protocol error payloads

OAuth2ProtocolException(ProtocolError) - Constructor for exception net.oauth2.client.OAuth2ProtocolException

OAuthPayloadProperty - Annotation Type in net.oauth2

Marks a class property as significant to an OAuth services payload, i.e.

onException(Throwable) - Method in interface net.oauth2.client.RetryPolicy

P

ParametersMap - Interface in net.oauth2

Models an oauth payload object model as a key-value map.

parse(String) - Static method in enum net.oauth2.ProtocolErrorType

parseDelimitedString(String, String, boolean) - Static method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionDeserializer

parseError(String, Class<T>) - Method in interface net.oauth2.client.http.DataBindingProvider

parseToken(String, Class<T>) - Method in interface net.oauth2.client.http.DataBindingProvider

PasswordCredentialsGrantRequest - Class in net.oauth2

Models the "password" type of oauth token grant requests.

PasswordCredentialsGrantRequest(String, String, String, String, Collection<String>) - Constructor for class net.oauth2.PasswordCredentialsGrantRequest

periodBetweenRetries() - Method in interface net.oauth2.client.RetryPolicy

post(String, AccessTokenGrantRequest) - Method in interface net.oauth2.client.http.TokenServiceHttpClient

ProtocolError - Class in net.oauth2

Models oauth-2 standard protocol error payload https://tools.ietf.org/html/rfc6749#section-4.1.2.1

ProtocolError(String, String, URI, String) - Constructor for class net.oauth2.ProtocolError

ProtocolError(Map<String, Object>) - Constructor for class net.oauth2.ProtocolError

ProtocolErrorType - Enum in net.oauth2

Enumeration for standard oauth-2 protocol error types.

R

raw() - Method in interface net.oauth2.client.http.DataBindingProvider

refresh(String) - Method in interface net.oauth2.client.TokenService

Sends a refresh token request to the Token Service using the supplied refreshTokenSeting.

refreshToken - Variable in class net.oauth2.RefreshTokenGrantRequest

RefreshTokenGrantRequest - Class in net.oauth2

Models the "refresh_token" type of oauth grant requests.

RefreshTokenGrantRequest(String, String, String, Collection<String>) - Constructor for class net.oauth2.RefreshTokenGrantRequest

renew(AccessTokenGrantRequest, String, Collection<String>) - Static method in class net.oauth2.RefreshTokenGrantRequest

ResourceOAuthHeader - Class in net.oauth2.client.http

Utility class for formatting OAuth HTTP request headers

ResourceOAuthHeader() - Constructor for class net.oauth2.client.http.ResourceOAuthHeader

Resumable<T extends AccessToken> - Interface in net.oauth2.client

Functional interface for resumable, TokenProviderJobs providers.

resume(T, Instant, boolean) - Method in interface net.oauth2.client.Resumable

Resumes a suspended refreshing task.

RetryPolicy - Interface in net.oauth2.client

Models a retry policy in fetching tokens within continuous operations for OAuth token provisioning.

S

schedule(double) - Method in interface net.oauth2.client.TokenProviderJob

Schedules the repeated executions by setting their delay as percentage of the Time-To-Live (TTL) of the Access Token.

serialize(Collection<T>) - Method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionSerializer

setScopes(Collection<String>) - Method in class net.oauth2.AccessTokenGrantRequest

start() - Method in interface net.oauth2.client.TokenProviderJob

Starts a token refresh background job after successfully fetching an AccessToken from TokenService.

stop(boolean) - Method in interface net.oauth2.client.TokenProviderJob

Stops the asynchronous refreshing job started by this provider (if any)

T

TemporalAccessToken<T extends AccessToken> - Class in net.oauth2

Convenience wrapper for temporal operations with access tokens.

TemporalAccessToken(T, Instant, TemporalUnit) - Constructor for class net.oauth2.TemporalAccessToken

Constructs temporal access token wrappers considering the supplied moment as initial moment of the validity of the token and using the supplied temporal unit as reference unit for temporal operations including operands such as the expires_in property.

TemporalAccessToken(T, Instant) - Constructor for class net.oauth2.TemporalAccessToken

Constructs temporal access token wrapper using the supplied moment as first moment of validity for the token and defaulting to ChornoUnit.SECONDS as reference temporal unit for temporal properties such as expires-in.

token() - Method in class net.oauth2.TemporalAccessToken

Returns the wrapped token instance

tokenChanged(TemporalAccessToken<T>, TemporalAccessToken<T>) - Method in interface net.oauth2.client.TokenChangeObserver

Fired by TokenChangeObservable when a token value has changed, either because it was fetched for the first time, or because it was refreshed.

TokenChangeObservable<T extends AccessToken> - Interface in net.oauth2.client

Functional capability to install listeners for token updates and support asynchronous push notification on changes.

TokenChangeObserver<T extends AccessToken> - Interface in net.oauth2.client

Functional interface for listeners to asynchronous (push) provisioning of Access Token update events.

TokenProvider - Interface in net.oauth2.client

Functional capability for synchronous provisioning of Access Tokens.

TokenProviderJob<T extends AccessToken> - Interface in net.oauth2.client

A Token Provider that continuously provides Access Token.

TokenService - Interface in net.oauth2.client

OAuth 2.0 Token Service delegate with functional capabilities to fetch and refresh tokens.

TokenServiceHttpClient - Interface in net.oauth2.client.http

An interface to implementations encapsulating the HTTP transport communication to an Authorization Server Token Service, and the conversion between the HTTP request/response payloads and this client's Java object model for authorization grant's and access tokens.

toString() - Method in class net.oauth2.AccessToken

toString() - Method in class net.oauth2.AccessTokenGrantRequest

toString() - Method in class net.oauth2.AuthorizationCodeGrantRequest

toString() - Method in class net.oauth2.ClientCredentialsGrantRequest

toString() - Method in class net.oauth2.PasswordCredentialsGrantRequest

toString() - Method in class net.oauth2.ProtocolError

toString() - Method in enum net.oauth2.ProtocolErrorType

toString() - Method in class net.oauth2.RefreshTokenGrantRequest

toString() - Method in class net.oauth2.TemporalAccessToken

ttl() - Method in class net.oauth2.TemporalAccessToken

Returns the time-to-live duration in which the token is valid.

ttlLeft() - Method in class net.oauth2.TemporalAccessToken

Returns the remaining time-to-live until this token expires as duration.

ttlLeft(ChronoUnit) - Method in class net.oauth2.TemporalAccessToken

Returns the remaining time-to-live until this token expires, as long value in the requested temporal units.

ttlUnit(TemporalUnit) - Method in class net.oauth2.TemporalAccessToken

Sets the reference temporal unit used in this wrapper and returns its instance for method chaining.

ttlUnit() - Method in class net.oauth2.TemporalAccessToken

Returns the reference temporal unit used in this wrapper.

U

unmodifiable(boolean) - Method in class net.oauth2.client.http.FormEncodeDataBinding.CollectionDeserializer

V

validSince() - Method in class net.oauth2.TemporalAccessToken

Returns the java.time.Instant since the token is valid (was issued)

valueOf(String) - Static method in enum net.oauth2.ProtocolErrorType

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.oauth2.ProtocolErrorType

Returns an array containing the constants of this enum type, in the order they are declared.

W

with(O) - Method in interface net.oauth2.client.http.DataBindingProvider

with(String, WwwFormUrlEncodedCodec.Serializer<T>) - Method in class net.oauth2.client.http.FormEncodeDataBinding

Register custom serializer, e.g.

with(String, WwwFormUrlEncodedCodec.Deserializer<T>) - Method in class net.oauth2.client.http.FormEncodeDataBinding

Register custom deserializer, e.g.

A B C D E F G H I M N O P R S T U V W