org.mule.module.oauth2.internal.authorizationcode

Class DefaultAuthorizationCodeGrantType

java.lang.Object

org.mule.module.oauth2.internal.AbstractGrantType

org.mule.module.oauth2.internal.authorizationcode.DefaultAuthorizationCodeGrantType

All Implemented Interfaces:

MuleContextAware, Initialisable, Startable, org.mule.module.http.api.HttpAuthentication, ApplicationCredentials, AuthorizationCodeGrantType

public class DefaultAuthorizationCodeGrantType
extends AbstractGrantType
implements Initialisable, AuthorizationCodeGrantType, Startable, MuleContextAware

Represents the config element for oauth:authentication-code-config.

This config will: - If the authorization-request is defined then it will create a flow listening for an user call to begin the oauth login. - If the token-request is defined then it will create a flow for listening in the redirect uri so we can get the authentication code and retrieve the access token

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_REDIRECT_URL_PROPERTY

Fields inherited from class org.mule.module.oauth2.internal.AbstractGrantType

clientId, clientSecret, proxyConfig, tlsContextFactory, tokenManagerConfig

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultAuthorizationCodeGrantType()

Method Summary

Modifier and Type	Method and Description
void	authenticate(MuleEvent muleEvent, org.mule.module.http.internal.domain.request.HttpRequestBuilder builder)
ConfigOAuthContext	getConfigOAuthContext()
String	getExternalRedirectionUrl()
AttributeEvaluator	getLocalAuthorizationUrlResourceOwnerIdEvaluator()
String	getRedirectionUrl()
String	getRefreshTokenWhen()
AttributeEvaluator	getResourceOwnerIdEvaluator()
ConfigOAuthContext	getUserOAuthContext()
void	initialise()
void	refreshToken(MuleEvent currentFlowEvent, String resourceOwnerId) Does a refresh token for a particular oauth context id.
void	setAuthorizationRequestHandler(AuthorizationRequestHandler authorizationRequestHandler)
void	setLocalAuthorizationUrlResourceOwnerId(String resourceOwnerId)
void	setMuleContext(MuleContext context)
void	setRedirectionUrl(String redirectionUrl)
void	setResourceOwnerId(String resourceOwnerId)
void	setTokenRequestHandler(AbstractAuthorizationCodeTokenRequestHandler tokenRequestHandler)
boolean	shouldRetry(MuleEvent firstAttemptResponseEvent)
void	start()

Methods inherited from class org.mule.module.oauth2.internal.AbstractGrantType

buildAuthorizationHeaderContent, getClientId, getClientSecret, getTlsContext, setClientId, setClientSecret, setProxyConfig, setTlsContext, setTokenManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.module.oauth2.internal.authorizationcode.AuthorizationCodeGrantType

getTlsContext

Methods inherited from interface org.mule.module.oauth2.internal.ApplicationCredentials

getClientId, getClientSecret

Field Detail

EXTERNAL_REDIRECT_URL_PROPERTY

public static final String EXTERNAL_REDIRECT_URL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DefaultAuthorizationCodeGrantType

public DefaultAuthorizationCodeGrantType()

Method Detail

setRedirectionUrl

public void setRedirectionUrl(String redirectionUrl)

setAuthorizationRequestHandler

public void setAuthorizationRequestHandler(AuthorizationRequestHandler authorizationRequestHandler)

setTokenRequestHandler

public void setTokenRequestHandler(AbstractAuthorizationCodeTokenRequestHandler tokenRequestHandler)

getConfigOAuthContext

public ConfigOAuthContext getConfigOAuthContext()

getRedirectionUrl

public String getRedirectionUrl()

Specified by:

getRedirectionUrl in interface AuthorizationCodeGrantType

Returns:

redirect url as defined in the oauth authentication server.

getExternalRedirectionUrl

public String getExternalRedirectionUrl()

Specified by:

getExternalRedirectionUrl in interface AuthorizationCodeGrantType

Returns:

redirect url to be sent to the client, won't start a server there.

getRefreshTokenWhen

public String getRefreshTokenWhen()

Specified by:

getRefreshTokenWhen in interface AuthorizationCodeGrantType

Returns:

expression to determine if a call to the resource secured with oauth failed because the access token has expired or was revoked.

getLocalAuthorizationUrlResourceOwnerIdEvaluator

public AttributeEvaluator getLocalAuthorizationUrlResourceOwnerIdEvaluator()

Specified by:

getLocalAuthorizationUrlResourceOwnerIdEvaluator in interface AuthorizationCodeGrantType

Returns:

the expression or static value of a certain user authenticated through this config. By being an expression we allow to authenticate several users and hold state (access token, refresh token, etc) for all those users. This expression is used during the local authorization url call to determine the resource owner id.

getResourceOwnerIdEvaluator

public AttributeEvaluator getResourceOwnerIdEvaluator()

Specified by:

getResourceOwnerIdEvaluator in interface AuthorizationCodeGrantType

Returns:

the expression or static value of a certain user authenticated through this config. By being an expression we allow to authenticate several users and hold state (access token, refresh token, etc) for all those users. This expressions is used during http:request execution to determine the resource owner id.

refreshToken

public void refreshToken(MuleEvent currentFlowEvent,
                         String resourceOwnerId)
                  throws MuleException

Description copied from interface: AuthorizationCodeGrantType

Does a refresh token for a particular oauth context id.

Specified by:

refreshToken in interface AuthorizationCodeGrantType

Parameters:

currentFlowEvent - event from the flow that requires a new access token.

resourceOwnerId - the id of the oauth context to refresh.

Throws:

MuleException

getUserOAuthContext

public ConfigOAuthContext getUserOAuthContext()

Specified by:

getUserOAuthContext in interface AuthorizationCodeGrantType

Returns:

the oauth context holder for all the resource owners authenticated in this config.

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

initialise

public void initialise()
                throws InitialisationException

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException

authenticate

public void authenticate(MuleEvent muleEvent,
                         org.mule.module.http.internal.domain.request.HttpRequestBuilder builder)
                  throws MuleException

Specified by:

authenticate in interface org.mule.module.http.api.HttpAuthentication

Throws:

MuleException

shouldRetry

public boolean shouldRetry(MuleEvent firstAttemptResponseEvent)
                    throws MuleException

Specified by:

shouldRetry in interface org.mule.module.http.api.HttpAuthentication

Throws:

MuleException

setLocalAuthorizationUrlResourceOwnerId

public void setLocalAuthorizationUrlResourceOwnerId(String resourceOwnerId)

setResourceOwnerId

public void setResourceOwnerId(String resourceOwnerId)

start

public void start()
           throws MuleException

Specified by:

start in interface Startable

Throws:

MuleException