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

A

accessToken(String) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Will query the internal state (the tokensStore parameter passed to the service to build the AuthorizationCodeOAuthDancer) to get the appropriate accessToken.

accessToken() - Method in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Will query the internal state (the tokensStore parameter passed to the service to build the ClientCredentialsOAuthDancer) to get the appropriate accessToken.

addListener(AuthorizationCodeListener) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Adds the listener.

addListener(AuthorizationCodeListener) - Method in interface org.mule.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

Adds the provided listener

afterDanceCallback(BiConsumer<AuthorizationCodeDanceCallbackContext, ResourceOwnerOAuthContext>) - Method in interface org.mule.runtime.oauth.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.runtime.oauth.api.OAuthAuthorizationStatusCode

AUTHORIZATION_STATUS_QUERY_PARAM_KEY - Static variable in class org.mule.runtime.oauth.api.OAuthAuthorizationStatusCode

AuthorizationCodeDanceCallbackContext - Interface in org.mule.runtime.oauth.api.builder

Implementations keep context information between the before and after callbacks set for an AuthorizationCodeOAuthDancer.

authorizationCodeGrantTypeDancerBuilder(LockFactory, Map<String, T>, MuleExpressionLanguage) - Method in interface org.mule.runtime.oauth.api.OAuthService

Creates a builder for an AuthorizationCodeOAuthDancer for authorization code grant type.

AuthorizationCodeListener - Interface in org.mule.runtime.oauth.api.builder

Allows to get notified about certain events related to an OAuth dance with Authorization Code grant type

AuthorizationCodeOAuthDancer - Interface in org.mule.runtime.oauth.api

Implementations provide OAuth dance support for authorization-code grant-type.

AuthorizationCodeRequest - Interface in org.mule.runtime.oauth.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.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

B

beforeDanceCallback(Function<AuthorizationCodeRequest, AuthorizationCodeDanceCallbackContext>) - Method in interface org.mule.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

Allows custom code to be run just before doing the request to the provided tokenUrl.

build() - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

Uses the configuration provided to this builder to create a new dancer.

C

clientCredentials(String, String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

clientCredentialsGrantTypeDancerBuilder(LockFactory, Map<String, T>, MuleExpressionLanguage) - Method in interface org.mule.runtime.oauth.api.OAuthService

Creates a builder for an ClientCredentialsOAuthDancer for client credentials grant type.

ClientCredentialsLocation - Enum in org.mule.runtime.oauth.api.builder

Enum to define where to send the client credentials in an OAuth2 Dance.

ClientCredentialsOAuthDancer - Interface in org.mule.runtime.oauth.api

Implementations provide OAuth dance support for client-credentials grant-type.

customParameters(Map<String, String>) - Method in interface org.mule.runtime.oauth.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(Supplier<Map<String, String>>) - Method in interface org.mule.runtime.oauth.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.

customParametersExtractorsExprs(Map<String, String>) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

D

DEFAULT_RESOURCE_OWNER_ID - Static variable in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

DefaultResourceOwnerOAuthContext - Class in org.mule.runtime.oauth.api.state

OAuth state for a particular resource owner which typically represents an user.

DefaultResourceOwnerOAuthContext(Lock, String) - Constructor for class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

E

encodeClientCredentialsInBody(boolean) - Method in interface org.mule.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

Deprecated.

since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.

encodeClientCredentialsInBody(boolean) - Method in interface org.mule.runtime.oauth.api.builder.OAuthClientCredentialsDancerBuilder

Deprecated.

since 4.2.0. Use OAuthDancerBuilder.withClientCredentialsIn(ClientCredentialsLocation) instead.

encoding(Charset) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

externalCallbackUrl(String) - Method in interface org.mule.runtime.oauth.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 class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getAccessToken() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getAuthorizationUrl() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getClientId() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getClientSecret() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getContext() - Method in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Retrieves the oauth context.

getContextForResourceOwner(String) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Retrieves the oauth context for a particular user.

getExpiresIn() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getExpiresIn() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getParameter(String) - Method in interface org.mule.runtime.oauth.api.builder.AuthorizationCodeDanceCallbackContext

Allows access to an attribute of this context, as defined by the implementation.

getRefreshToken() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getRefreshToken() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getRefreshUserOAuthContextLock() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getResourceOwnerId() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getResourceOwnerId() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getResourceOwnerId() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getScopes() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getState() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

getState() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getState() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getTokenResponseParameters() - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

getTokenResponseParameters() - Method in interface org.mule.runtime.oauth.api.state.ResourceOwnerOAuthContext

getTokenUrl() - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeRequest

H

handleLocalAuthorizationRequest(HttpRequest, HttpResponseReadyCallback) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Handles an http request that will redirect to the access page in authorizationUrl with the configured credentials.

I

invalidateContext(String) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Clears the oauth context for a given user.

invalidateContext() - Method in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Clears the oauth context.

L

localAuthorizationUrlPath(String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

If this attribute is provided mule will automatically create and endpoint in the host server (the same configured for OAuthAuthorizationCodeDancerBuilder.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.runtime.oauth.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.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

The produced AuthorizationCodeOAuthDancer will create an HttpServer to listen on the provided localCallbackUrl.

localCallback(URL, TlsContextFactory) - Method in interface org.mule.runtime.oauth.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.runtime.oauth.api.builder.OAuthAuthorizationCodeDancerBuilder

The produced AuthorizationCodeOAuthDancer will use an existing HttpServer to listen on the provided localCallbackConfigPath.

N

NO_AUTHORIZATION_CODE_STATUS - Static variable in class org.mule.runtime.oauth.api.OAuthAuthorizationStatusCode

O

OAuthAuthorizationCodeDancerBuilder - Interface in org.mule.runtime.oauth.api.builder

Builder that allows to configure the attributes for the authorization code grant type.

OAuthAuthorizationStatusCode - Class in org.mule.runtime.oauth.api

General purpose OAuth constants

OAuthClientCredentialsDancerBuilder - Interface in org.mule.runtime.oauth.api.builder

Builder that allows to configure the attributes for the client credentials grant type.

OAuthDancerBuilder<D> - Interface in org.mule.runtime.oauth.api.builder

Builder that allows to configure the common attributes for any grant type.

OAuthService - Interface in org.mule.runtime.oauth.api

Allows for creation of OAuth dancer implementations for the supported grant types: Authorization Code Grant Type Client Credentials

onAuthorizationCompleted(ResourceOwnerOAuthContext) - Method in interface org.mule.runtime.oauth.api.builder.AuthorizationCodeListener

Invoked when an authorization dance has been completed.

onTokenRefreshed(ResourceOwnerOAuthContext) - Method in interface org.mule.runtime.oauth.api.builder.AuthorizationCodeListener

Invoked each time a refresh token operation has been complted successfully

org.mule.runtime.oauth.api - package org.mule.runtime.oauth.api

org.mule.runtime.oauth.api.builder - package org.mule.runtime.oauth.api.builder

org.mule.runtime.oauth.api.exception - package org.mule.runtime.oauth.api.exception

org.mule.runtime.oauth.api.state - package org.mule.runtime.oauth.api.state

R

refreshToken(String) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Performs the refresh of the access token.

refreshToken(String, boolean) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Performs the refresh of the access token.

refreshToken() - Method in interface org.mule.runtime.oauth.api.ClientCredentialsOAuthDancer

Performs the refresh of the access token.

removeListener(AuthorizationCodeListener) - Method in interface org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer

Removes the listener.

RequestAuthenticationException - Exception in org.mule.runtime.oauth.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.runtime.oauth.api.exception.RequestAuthenticationException

resourceOwnerIdTransformer(Function<String, String>) - Method in interface org.mule.runtime.oauth.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 respurceOwnerIds for different dancers.

ResourceOwnerOAuthContext - Interface in org.mule.runtime.oauth.api.state

OAuth state for a particular resource owner, which typically represents an user.

responseAccessTokenExpr(String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

responseExpiresInExpr(String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

responseRefreshTokenExpr(String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

S

scopes(String) - Method in interface org.mule.runtime.oauth.api.builder.OAuthDancerBuilder

Scopes define permissions over resources.

setAccessToken(String) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

setExpiresIn(String) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

setRefreshToken(String) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

setRefreshUserOAuthContextLock(Lock) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

setState(String) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

setTokenResponseParameters(Map<String, Object>) - Method in class org.mule.runtime.oauth.api.state.DefaultResourceOwnerOAuthContext

state(String) - Method in interface org.mule.runtime.oauth.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.runtime.oauth.api.OAuthAuthorizationStatusCode

TOKEN_URL_CALL_FAILED_STATUS - Static variable in class org.mule.runtime.oauth.api.OAuthAuthorizationStatusCode

TokenNotFoundException - Exception in org.mule.runtime.oauth.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.runtime.oauth.api.exception.TokenNotFoundException

tokenUrl(String) - Method in interface org.mule.runtime.oauth.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.runtime.oauth.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.runtime.oauth.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.runtime.oauth.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.runtime.oauth.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.runtime.oauth.api.exception

There was a problem with the call to the tokenUrl.

TokenUrlResponseException(String, HttpResponse, String) - Constructor for exception org.mule.runtime.oauth.api.exception.TokenUrlResponseException

TokenUrlResponseException(String, Exception) - Constructor for exception org.mule.runtime.oauth.api.exception.TokenUrlResponseException

V

valueOf(String) - Static method in enum org.mule.runtime.oauth.api.builder.ClientCredentialsLocation

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

values() - Static method in enum org.mule.runtime.oauth.api.builder.ClientCredentialsLocation

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

W

withClientCredentialsIn(ClientCredentialsLocation) - Method in interface org.mule.runtime.oauth.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 R S T V W