org.mule.extension.oauth2.internal

Class AbstractTokenRequestHandler

java.lang.Object

org.mule.extension.oauth2.internal.AbstractTokenRequestHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAuthorizationCodeTokenRequestHandler, ClientCredentialsTokenRequestHandler

public abstract class AbstractTokenRequestHandler
extends Object
implements org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, MuleContextAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTokenRequestHandler.TokenResponse
protected class	AbstractTokenRequestHandler.TokenUrlResponseException

Field Summary

Fields

Modifier and Type	Field and Description
protected MuleContext	muleContext
protected List<ParameterExtractor>	parameterExtractors
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String>	responseAccessToken MEL expression to extract the access token parameter from the response of the call to tokenUrl.
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String>	responseExpiresIn MEL expression to extract the expiresIn parameter from the response of the call to tokenUrl.
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String>	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
AbstractTokenRequestHandler()

Method Summary

Modifier and Type	Method and Description
protected MuleContext	getMuleContext()
org.mule.runtime.extension.api.runtime.operation.ParameterResolver<Boolean>	getRefreshTokenWhen()
protected String	getTokenUrl()
void	initialise()
protected org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes>	invokeTokenUrl(Map<String,String> tokenRequestFormToSend, String authorization)
protected boolean	isEmpty(String value)
AbstractTokenRequestHandler.TokenResponse	processTokenResponse(org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes> tokenUrlResponse, boolean retrieveRefreshToken)
void	setMuleContext(MuleContext context)
void	setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)
void	setTokenUrl(String tokenUrl)
void	start()
void	stop()
protected boolean	tokenResponseContentIsValid(AbstractTokenRequestHandler.TokenResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

muleContext

protected MuleContext muleContext

responseAccessToken

@Parameter
 @Optional(defaultValue="#[(payload match /.*\"access_token\"[ ]*:[ ]*\"([^\\\"]*)\".*/)[1]]")
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String> responseAccessToken

MEL expression to extract the access token parameter from the response of the call to tokenUrl.

responseRefreshToken

@Parameter
 @Optional(defaultValue="#[(payload match /.*\"refresh_token\"[ ]*:[ ]*\"([^\\\"]*)\".*/)[1]]")
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String> responseRefreshToken

responseExpiresIn

@Parameter
 @Optional(defaultValue="#[(payload match /.*\"expires_in\"[ ]*:[ ]*\"([^\\\"]*)\".*/)[1]]")
protected org.mule.runtime.extension.api.runtime.operation.ParameterResolver<String> responseExpiresIn

MEL expression to extract the expiresIn parameter from the response of the call to tokenUrl.

parameterExtractors

@Parameter
 @Alias(value="custom-parameter-extractors")
 @Optional
protected List<ParameterExtractor> parameterExtractors

Constructor Detail

AbstractTokenRequestHandler

public AbstractTokenRequestHandler()

Method Detail

getRefreshTokenWhen

public org.mule.runtime.extension.api.runtime.operation.ParameterResolver<Boolean> getRefreshTokenWhen()

getMuleContext

protected MuleContext getMuleContext()

setTokenUrl

public void setTokenUrl(String tokenUrl)

setTlsContextFactory

public void setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

invokeTokenUrl

protected org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes> invokeTokenUrl(Map<String,String> tokenRequestFormToSend,
                                                                                                                String authorization)
                                                                                                         throws org.mule.runtime.api.exception.MuleException,
                                                                                                                AbstractTokenRequestHandler.TokenUrlResponseException

Throws:

org.mule.runtime.api.exception.MuleException

AbstractTokenRequestHandler.TokenUrlResponseException

getTokenUrl

protected String getTokenUrl()

processTokenResponse

public AbstractTokenRequestHandler.TokenResponse processTokenResponse(org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes> tokenUrlResponse,
                                                                      boolean retrieveRefreshToken)

tokenResponseContentIsValid

protected boolean tokenResponseContentIsValid(AbstractTokenRequestHandler.TokenResponse response)

isEmpty

protected boolean isEmpty(String value)

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

stop

public void stop()

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware