Index (OAuth Client Implementation API 2.0.0 API)

A B C D E G H I L N O Q R S T V W
All Classes All Packages

A

accessToken() - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) to get the appropriate accessToken.
accessToken(String) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Will query the internal state (the tokensStore parameter passed to the service to build the AuthorizationCodeOAuthDancer) to get the appropriate accessToken.
addAdditionalRefreshTokenRequestHeaders(MultiMap<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Adds additional request headers for refreshing the token
addAdditionalRefreshTokenRequestParameters(MultiMap<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Adds additional request parameters for refreshing the token
addListener(String, AuthorizationCodeListener) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Adds the listener.
addListener(AuthorizationCodeListener) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Deprecated.
since 1.1, 1.0.2. Use AuthorizationCodeOAuthDancer.addListener(String, AuthorizationCodeListener) instead to properly handle the events corresponding to a resource owner
addListener(AuthorizationCodeListener) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Adds the provided listener
addListener(ClientCredentialsListener) - Method in interface org.mule.oauth.client.api.builder.OAuthClientCredentialsDancerBuilder: Adds the listener.
addListener(ClientCredentialsListener) - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Adds the listener.
afterDanceCallback(BiConsumer<AuthorizationCodeDanceCallbackContext, ResourceOwnerOAuthContext>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Allows custom code to be run after doing the request to the provided tokenUrl and processing its results.
AUTHORIZATION_CODE_RECEIVED_STATUS - Static variable in class org.mule.oauth.client.api.OAuthAuthorizationStatusCode
AUTHORIZATION_STATUS_QUERY_PARAM_KEY - Static variable in class org.mule.oauth.client.api.OAuthAuthorizationStatusCode
AuthorizationCodeDanceCallbackContext - Interface in org.mule.oauth.client.api.builder: Implementations keep context information between the before and after callbacks set for an AuthorizationCodeOAuthDancer.
AuthorizationCodeListener - Interface in org.mule.oauth.client.api.listener: Allows to get notified about certain events related to an OAuth dance with Authorization Code grant type
AuthorizationCodeOAuthDancer - Interface in org.mule.oauth.client.api: Implementations provide OAuth dance support for authorization-code grant-type.
AuthorizationCodeRequest - Interface in org.mule.oauth.client.api: Provides information about a request to be made to fetch the tokens as part of an OAuth Authorization-code grant type dance.
authorizationUrl(String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder

B

BASIC_AUTH_HEADER - org.mule.oauth.client.api.builder.ClientCredentialsLocation: Send credentials in an Basic Authentication header
beforeDanceCallback(Function<AuthorizationCodeRequest, AuthorizationCodeDanceCallbackContext>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Allows custom code to be run just before doing the request to the provided tokenUrl.
BODY - org.mule.oauth.client.api.builder.ClientCredentialsLocation: Send credentials encoded in HTTP Body
build() - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Uses the configuration provided to this builder to create a new dancer.

C

clientCredentials(String, String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder
ClientCredentialsListener - Interface in org.mule.oauth.client.api.listener: Allows to get notified about certain events related to an OAuth dance with Client Credentials grant type
ClientCredentialsLocation - Enum in org.mule.oauth.client.api.builder: Enum to define where to send the client credentials in an OAuth2 Dance.
ClientCredentialsOAuthDancer - Interface in org.mule.oauth.client.api: Implementations provide OAuth dance support for client-credentials grant-type.
createRefreshOAuthContextLock(String, LockFactory, String) - Static method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState: This utility method is needed for the cases where the context is being queried.
customBodyParameters(Supplier<Map<String, String>>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Adds the customBodyParameters to the body of the token url request.
customBodyParameters(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Adds the customBodyParameters to the body of the token url request.
customBodyParameters(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthClientCredentialsDancerBuilder: Adds the customBodyParameters to the body of the token url request.
customHeaders(Supplier<Map<String, String>>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.
customHeaders(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: There are OAuth implementations that require or allow extra headers to be sent when calling the Authentication URL of the OAS.
customHeaders(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthClientCredentialsDancerBuilder: There are OAuth implementations that require or allow extra headers to be sent when calling the token URL of the OAS.
customParameters(Supplier<Map<String, String>>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.
customParameters(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: There are OAuth implementations that require or allow extra query parameters to be sent when calling the Authentication URL of the OAS.
customParameters(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthClientCredentialsDancerBuilder: There are OAuth implementations that require or allow extra query parameters to be sent when calling the token URL of the OAS.
customParametersExtractorsExprs(Map<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder

D

DancerState - Enum in org.mule.oauth.client.api.state: Represents the possible states that the owner object may be in relative to the Dancer.
DEFAULT_RESOURCE_OWNER_ID - Static variable in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext

E

encodeClientCredentialsInBody(boolean) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Deprecated.
since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.
encodeClientCredentialsInBody(boolean) - Method in interface org.mule.oauth.client.api.builder.OAuthClientCredentialsDancerBuilder: Deprecated.
since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.
encoding(Charset) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder
externalCallbackUrl(String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: The oauth authentication server will use this url to provide the authentication code to the Mule server so the mule server can retrieve the access token.

G

getAccessToken() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getAccessToken() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getAuthorizationUrl() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getClientId() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getClientSecret() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getContext() - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Retrieves the oauth context.
getContextForResourceOwner(String) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Retrieves the oauth context for a particular user.
getDancerState() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getDancerState() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getExpiresIn() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getExpiresIn() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getParameter(String) - Method in interface org.mule.oauth.client.api.builder.AuthorizationCodeDanceCallbackContext: Allows access to an attribute of this context, as defined by the implementation.
getRefreshOAuthContextLock(String, LockFactory) - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext: Obtains a lock to avoid triggering a refresh of the context more than once simultaneously.
getRefreshOAuthContextLock(String, LockFactory) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getRefreshToken() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getRefreshToken() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getResourceOwnerId() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getResourceOwnerId() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getResourceOwnerId() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getScopes() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getState() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest
getState() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getState() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getTokenResponseParameters() - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext
getTokenResponseParameters() - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
getTokenUrl() - Method in interface org.mule.oauth.client.api.AuthorizationCodeRequest

H

handleLocalAuthorizationRequest(HttpRequest, HttpResponseReadyCallback) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Handles an http request that will redirect to the access page in authorizationUrl with the configured credentials.
HAS_TOKEN - org.mule.oauth.client.api.state.DancerState: There is a token present and it is valid to use.

I

includeRedirectUriInRefreshTokenRequest(boolean) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Allows to toggle the inclusion of a redirect_uri parameter on the refresh token request.
invalidateContext() - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Clears the oauth context.
invalidateContext(String) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Clears the oauth context for a given user.

L

localAuthorizationUrlPath(String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: If this attribute is provided mule will automatically create and endpoint in the host server (the same configured for localCallback(java.net.URL)) that the user can hit to authenticate and grant access to the application for his account.
localAuthorizationUrlResourceOwnerId(String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: This attribute is only required when the applications needs to access resources from more than one user in the OAuth authentication server.
localCallback(URL) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: The produced AuthorizationCodeOAuthDancer will create an HttpServer to listen on the provided localCallbackUrl.
localCallback(URL, TlsContextFactory) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: The produced AuthorizationCodeOAuthDancer will create an HttpServer with the provided tlsContextFactory to listen on the provided localCallbackUrl.
localCallback(HttpServer, String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: The produced AuthorizationCodeOAuthDancer will use an existing HttpServer to listen on the provided localCallbackConfigPath.

N

name(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder
NO_AUTHORIZATION_CODE_STATUS - Static variable in class org.mule.oauth.client.api.OAuthAuthorizationStatusCode
NO_TOKEN - org.mule.oauth.client.api.state.DancerState: The owner has not fetched a token yet, or a previous attempt to fetch it has failed.

O

OAuthAuthorizationCodeDancerBuilder - Interface in org.mule.oauth.client.api.builder: Builder that allows to configure the attributes for the authorization code grant type.
OAuthAuthorizationStatusCode - Class in org.mule.oauth.client.api: General purpose OAuth constants
OAuthClientCredentialsDancerBuilder - Interface in org.mule.oauth.client.api.builder: Builder that allows to configure the attributes for the client credentials grant type.
OAuthDancerBuilder<D> - Interface in org.mule.oauth.client.api.builder: Builder that allows to configure the common attributes for any grant type.
OAuthStateListener - Interface in org.mule.oauth.client.api.listener: Allows to get notified about events related to the state of an OAuth authorization
onAuthorizationCompleted(ResourceOwnerOAuthContext) - Method in interface org.mule.oauth.client.api.listener.AuthorizationCodeListener: Invoked when an authorization dance has been completed.
onTokenInvalidated() - Method in interface org.mule.oauth.client.api.listener.OAuthStateListener: Invoked when a tokens gets invalidated by a Mule application.
onTokenRefreshed(ResourceOwnerOAuthContext) - Method in interface org.mule.oauth.client.api.listener.AuthorizationCodeListener: Invoked each time a refresh token operation has been completed successfully
onTokenRefreshed(ResourceOwnerOAuthContext) - Method in interface org.mule.oauth.client.api.listener.ClientCredentialsListener: Invoked each time a refresh token operation has been completed successfully
org.mule.oauth.client.api - module org.mule.oauth.client.api: Provides OAuth authentication client.
org.mule.oauth.client.api - package org.mule.oauth.client.api
org.mule.oauth.client.api.builder - package org.mule.oauth.client.api.builder
org.mule.oauth.client.api.exception - package org.mule.oauth.client.api.exception
org.mule.oauth.client.api.listener - package org.mule.oauth.client.api.listener
org.mule.oauth.client.api.state - package org.mule.oauth.client.api.state

Q

QUERY_PARAMS - org.mule.oauth.client.api.builder.ClientCredentialsLocation: Send credentials as query parameters

R

REFRESHING_TOKEN - org.mule.oauth.client.api.state.DancerState: There is already a request executing to refresh the token.
refreshToken() - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Performs the refresh of the access token.
refreshToken(String) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Performs the refresh of the access token.
refreshToken(String, boolean) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Performs the refresh of the access token.
removeListener(String, AuthorizationCodeListener) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Removes the listener.
removeListener(AuthorizationCodeListener) - Method in interface org.mule.oauth.client.api.AuthorizationCodeOAuthDancer: Deprecated.
since 1.1, 1.0.2. Use AuthorizationCodeOAuthDancer.addListener(String, AuthorizationCodeListener) instead
removeListener(ClientCredentialsListener) - Method in interface org.mule.oauth.client.api.ClientCredentialsOAuthDancer: Removes the listener.
RequestAuthenticationException - Exception in org.mule.oauth.client.api.exception: Exception throw when it's not possible to create the authentication request for a given request.
RequestAuthenticationException(I18nMessage) - Constructor for exception org.mule.oauth.client.api.exception.RequestAuthenticationException
resourceOwnerIdTransformer(Function<String, String>) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Allows to partition a tokensStore and reuse it among different dancers, as long as each dancer has its own proper resourceOwnerIdStoreTransformer and ensures there can be no collissions between the transformed resourceOwnerIds for different dancers.
ResourceOwnerOAuthContext - Interface in org.mule.oauth.client.api.state: OAuth state for a particular resource owner, which typically represents an user.
ResourceOwnerOAuthContextWithRefreshState - Class in org.mule.oauth.client.api.state: OAuth state for a particular resource owner which typically represents an user.
ResourceOwnerOAuthContextWithRefreshState(String) - Constructor for class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
ResourceOwnerOAuthContextWithRefreshState(ResourceOwnerOAuthContext) - Constructor for class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState: Since the runtime can be upgraded when there are already contexts stored, previous versions must be migrated to the new one.
responseAccessTokenExpr(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder
responseExpiresInExpr(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder
responseRefreshTokenExpr(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder

S

scopes(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Scopes define permissions over resources.
setAccessToken(String) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
setDancerState(DancerState) - Method in interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext: Updates the state of the dancer for this context.
setDancerState(DancerState) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
setExpiresIn(String) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
setRefreshToken(String) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
setState(String) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
setTokenResponseParameters(Map<String, Object>) - Method in class org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState
state(String) - Method in interface org.mule.oauth.client.api.builder.OAuthAuthorizationCodeDancerBuilder: Mule will add some internal stuff to the state that is sent to the Authorization server.

T

TOKEN_NOT_FOUND_STATUS - Static variable in class org.mule.oauth.client.api.OAuthAuthorizationStatusCode
TOKEN_URL_CALL_FAILED_STATUS - Static variable in class org.mule.oauth.client.api.OAuthAuthorizationStatusCode
TokenNotFoundException - Exception in org.mule.oauth.client.api.exception: It was not possible to retrieve the access token or the refresh token from the token URL response
TokenNotFoundException(String, HttpResponse, String) - Constructor for exception org.mule.oauth.client.api.exception.TokenNotFoundException
tokenUrl(String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
tokenUrl(String, TlsContextFactory) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
tokenUrl(String, TlsContextFactory, ProxyConfig) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
tokenUrl(String, ProxyConfig) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
tokenUrl(HttpClient, String) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Mule, after receiving the authentication code from the OAuth server (through the redirectUrl) will call this url to get the access token.
TokenUrlResponseException - Exception in org.mule.oauth.client.api.exception: There was a problem with the call to the tokenUrl.
TokenUrlResponseException(String, Exception) - Constructor for exception org.mule.oauth.client.api.exception.TokenUrlResponseException
TokenUrlResponseException(String, HttpResponse, String) - Constructor for exception org.mule.oauth.client.api.exception.TokenUrlResponseException

V

valueOf(String) - Static method in enum org.mule.oauth.client.api.builder.ClientCredentialsLocation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.oauth.client.api.state.DancerState: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mule.oauth.client.api.builder.ClientCredentialsLocation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.oauth.client.api.state.DancerState: Returns an array containing the constants of this enum type, in the order they are declared.

W

withClientCredentialsIn(ClientCredentialsLocation) - Method in interface org.mule.oauth.client.api.builder.OAuthDancerBuilder: Define where the client credentials will be sent in the HTTP requests for the OAuth2 Dance.

A B C D E G H I L N O Q R S T V W
All Classes All Packages