org.mule.extension.oauth2.internal.authorizationcode

Class AutoAuthorizationCodeTokenRequestHandler

java.lang.Object

org.mule.extension.oauth2.internal.AbstractTokenRequestHandler

org.mule.extension.oauth2.internal.authorizationcode.AbstractAuthorizationCodeTokenRequestHandler

org.mule.extension.oauth2.internal.authorizationcode.AutoAuthorizationCodeTokenRequestHandler

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, MuleContextAware

public class AutoAuthorizationCodeTokenRequestHandler
extends AbstractAuthorizationCodeTokenRequestHandler

Represents the Token request and response handling behaviour of the OAuth 2.0 dance. It provides support for standard OAuth server implementations of the token acquisition part plus a couple of configuration attributes to customize behaviour.

Nested Class Summary

Nested classes/interfaces inherited from class org.mule.extension.oauth2.internal.AbstractTokenRequestHandler

AbstractTokenRequestHandler.TokenResponse, AbstractTokenRequestHandler.TokenUrlResponseException

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZATION_STATUS_QUERY_PARAM_KEY
static int	FAILURE_PROCESSING_REDIRECT_URL_REQUEST_STATUS
static int	NO_AUTHORIZATION_CODE_STATUS
static int	TOKEN_NOT_FOUND_STATUS
static int	TOKEN_URL_CALL_FAILED_STATUS

Fields inherited from class org.mule.extension.oauth2.internal.AbstractTokenRequestHandler

muleContext, parameterExtractors, responseAccessToken, responseExpiresIn, responseRefreshToken

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AutoAuthorizationCodeTokenRequestHandler()

Method Summary

Modifier and Type	Method and Description
protected Function<org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpRequestAttributes>,org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>>	createRedirectUrlProcessor()
void	doRefreshToken(ResourceOwnerOAuthContext resourceOwnerOAuthContext) Executes a refresh token for a particular user.
void	init() Starts the http listener for the redirect url callback.

Methods inherited from class org.mule.extension.oauth2.internal.authorizationcode.AbstractAuthorizationCodeTokenRequestHandler

createListenerForCallbackUrl, getOauthConfig, refreshToken, setOauthConfig, start, stop

Methods inherited from class org.mule.extension.oauth2.internal.AbstractTokenRequestHandler

getMuleContext, getRefreshTokenWhen, getTokenUrl, initialise, invokeTokenUrl, isEmpty, processTokenResponse, setMuleContext, setTlsContextFactory, setTokenUrl, tokenResponseContentIsValid

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORIZATION_STATUS_QUERY_PARAM_KEY

public static final String AUTHORIZATION_STATUS_QUERY_PARAM_KEY

See Also:

Constant Field Values

NO_AUTHORIZATION_CODE_STATUS

public static final int NO_AUTHORIZATION_CODE_STATUS

See Also:

Constant Field Values

TOKEN_URL_CALL_FAILED_STATUS

public static final int TOKEN_URL_CALL_FAILED_STATUS

See Also:

Constant Field Values

TOKEN_NOT_FOUND_STATUS

public static final int TOKEN_NOT_FOUND_STATUS

See Also:

Constant Field Values

FAILURE_PROCESSING_REDIRECT_URL_REQUEST_STATUS

public static final int FAILURE_PROCESSING_REDIRECT_URL_REQUEST_STATUS

See Also:

Constant Field Values

Constructor Detail

AutoAuthorizationCodeTokenRequestHandler

public AutoAuthorizationCodeTokenRequestHandler()

Method Detail

init

public void init()
          throws org.mule.runtime.api.exception.MuleException

Starts the http listener for the redirect url callback. This will create a flow with an endpoint on the provided OAuth redirect uri parameter. The OAuth Server will call this url to provide the authentication code required to get the access token.

Overrides:

init in class AbstractAuthorizationCodeTokenRequestHandler

Throws:

org.mule.runtime.api.exception.MuleException - if the listener couldn't be created.

createRedirectUrlProcessor

protected Function<org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpRequestAttributes>,org.mule.runtime.extension.api.runtime.operation.Result<String,HttpResponseAttributes>> createRedirectUrlProcessor()

Specified by:

createRedirectUrlProcessor in class AbstractAuthorizationCodeTokenRequestHandler

doRefreshToken

public void doRefreshToken(ResourceOwnerOAuthContext resourceOwnerOAuthContext)

Executes a refresh token for a particular user. It will call the OAuth Server token url and provide the refresh token to get a new access token.

Specified by:

doRefreshToken in class AbstractAuthorizationCodeTokenRequestHandler

Parameters:

resourceOwnerOAuthContext - oauth context for who we need to update the access token.