org.mule.extension.oauth2.internal

Class AbstractGrantType

java.lang.Object

org.mule.extension.oauth2.internal.AbstractGrantType

All Implemented Interfaces:

org.mule.extension.http.api.request.authentication.HttpRequestAuthentication, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Direct Known Subclasses:

ClientCredentialsGrantType, DefaultAuthorizationCodeGrantType

public abstract class AbstractGrantType
extends Object
implements org.mule.extension.http.api.request.authentication.HttpRequestAuthentication, org.mule.runtime.api.lifecycle.Lifecycle

Common interface for all grant types must extend this interface.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ParameterExtractor>	customParameterExtractors
protected org.mule.runtime.api.el.MuleExpressionLanguage	expressionEvaluator
protected org.mule.runtime.api.lock.LockFactory	lockFactory
protected org.mule.runtime.core.api.MuleContext	muleContext
protected org.mule.runtime.oauth.api.OAuthService	oAuthService
protected DeferredExpressionResolver	resolver
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String>	responseAccessToken Expression to extract the access token parameter from the response of the call to tokenUrl.
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String>	responseExpiresIn Expression to extract the expiresIn parameter from the response of the call to tokenUrl.
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String>	responseRefreshToken
protected TokenManagerConfig	tokenManager The token manager configuration to use for this grant type.

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

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractGrantType()

Method Summary

Modifier and Type	Method and Description
protected String	buildAuthorizationHeaderContent(String accessToken)
protected org.mule.runtime.oauth.api.builder.OAuthDancerBuilder	configureBaseDancer(org.mule.runtime.oauth.api.builder.OAuthDancerBuilder dancerBuilder)
void	dispose()
boolean	equals(Object obj)
String	getClientId()
String	getClientSecret()
List<ParameterExtractor>	getCustomParameterExtractors()
abstract Object	getDancer()
org.mule.runtime.extension.api.runtime.parameter.Literal<Boolean>	getRefreshTokenWhen()
org.mule.runtime.extension.api.runtime.parameter.Literal<String>	getResponseAccessToken()
org.mule.runtime.extension.api.runtime.parameter.Literal<String>	getResponseExpiresIn()
org.mule.runtime.extension.api.runtime.parameter.Literal<String>	getResponseRefreshToken()
String	getScopes()
org.mule.runtime.api.tls.TlsContextFactory	getTlsContextFactory()
String	getTokenUrl()
int	hashCode()
void	initialise()
protected void	initTokenManager()
boolean	isDefaultTokenManager()
abstract boolean	isEncodeClientCredentialsInBody()
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.extension.http.api.request.authentication.HttpRequestAuthentication

authenticate, retryIfShould, shouldRetry

Field Detail

muleContext

@Inject
protected org.mule.runtime.core.api.MuleContext muleContext

lockFactory

@Inject
protected org.mule.runtime.api.lock.LockFactory lockFactory

expressionEvaluator

@Inject
protected org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator

resolver

protected DeferredExpressionResolver resolver

tokenManager

@Parameter
 @Optional
 @Expression(value=NOT_SUPPORTED)
protected TokenManagerConfig tokenManager

The token manager configuration to use for this grant type.

responseAccessToken

@Parameter
 @Optional(defaultValue="#[payload.access_token]")
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String> responseAccessToken

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

responseRefreshToken

@Parameter
 @Optional(defaultValue="#[payload.refresh_token]")
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String> responseRefreshToken

responseExpiresIn

@Parameter
 @Optional(defaultValue="#[payload.expires_in]")
protected org.mule.runtime.extension.api.runtime.parameter.Literal<String> responseExpiresIn

Expression to extract the expiresIn parameter from the response of the call to tokenUrl.

customParameterExtractors

@Parameter
 @Optional
protected List<ParameterExtractor> customParameterExtractors

oAuthService

@Inject
protected org.mule.runtime.oauth.api.OAuthService oAuthService

Constructor Detail

AbstractGrantType

public AbstractGrantType()

Method Detail

initTokenManager

protected void initTokenManager()
                         throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

configureBaseDancer

protected org.mule.runtime.oauth.api.builder.OAuthDancerBuilder configureBaseDancer(org.mule.runtime.oauth.api.builder.OAuthDancerBuilder dancerBuilder)
                                                                             throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getDancer

public abstract Object getDancer()

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()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

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

Throws:

org.mule.runtime.api.exception.MuleException

stop

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

Specified by:

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

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

buildAuthorizationHeaderContent

protected String buildAuthorizationHeaderContent(String accessToken)

Parameters:

accessToken - an oauth access token

Returns:

the content of the HTTP authentication header.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getClientSecret

public String getClientSecret()

getClientId

public String getClientId()

isEncodeClientCredentialsInBody

public abstract boolean isEncodeClientCredentialsInBody()

getScopes

public String getScopes()

getTokenUrl

public String getTokenUrl()

getRefreshTokenWhen

public org.mule.runtime.extension.api.runtime.parameter.Literal<Boolean> getRefreshTokenWhen()

getResponseAccessToken

public org.mule.runtime.extension.api.runtime.parameter.Literal<String> getResponseAccessToken()

getResponseRefreshToken

public org.mule.runtime.extension.api.runtime.parameter.Literal<String> getResponseRefreshToken()

getResponseExpiresIn

public org.mule.runtime.extension.api.runtime.parameter.Literal<String> getResponseExpiresIn()

getCustomParameterExtractors

public List<ParameterExtractor> getCustomParameterExtractors()

getTlsContextFactory

public org.mule.runtime.api.tls.TlsContextFactory getTlsContextFactory()

isDefaultTokenManager

public boolean isDefaultTokenManager()