org.mule.runtime.module.oauth2.internal.authorizationcode

Class DefaultAuthorizationCodeGrantType

java.lang.Object

org.mule.runtime.module.oauth2.internal.AbstractGrantType

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

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, MuleContextAware, HttpAuthentication, ApplicationCredentials, AuthorizationCodeGrantType

public class DefaultAuthorizationCodeGrantType
extends AbstractGrantType
implements org.mule.runtime.api.lifecycle.Initialisable, AuthorizationCodeGrantType, org.mule.runtime.api.lifecycle.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 inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultAuthorizationCodeGrantType()

Method Summary

Modifier and Type	Method and Description
void	authenticate(Event muleEvent, HttpRequestBuilder builder)
String	getClientId()
String	getClientSecret()
ConfigOAuthContext	getConfigOAuthContext()
String	getExternalCallbackUrl()
AttributeEvaluator	getLocalAuthorizationUrlResourceOwnerIdEvaluator()
HttpListenerConfig	getLocalCallbackConfig()
String	getLocalCallbackConfigPath()
String	getLocalCallbackUrl()
String	getRefreshTokenWhen()
AttributeEvaluator	getResourceOwnerIdEvaluator()
org.mule.runtime.api.tls.TlsContextFactory	getTlsContext()
ConfigOAuthContext	getUserOAuthContext()
void	initialise()
void	refreshToken(Event currentFlowEvent, String resourceOwnerId) Does a refresh token for a particular oauth context id.
void	setAuthorizationRequestHandler(AuthorizationRequestHandler authorizationRequestHandler)
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setExternalCallbackUrl(String externalCallbackUrl)
void	setLocalAuthorizationUrlResourceOwnerId(String resourceOwnerId)
void	setLocalCallbackConfig(HttpListenerConfig localCallbackConfig)
void	setLocalCallbackConfigPath(String localCallbackConfigPath)
void	setLocalCallbackUrl(String localCallbackUrl)
void	setMuleContext(MuleContext context)
void	setResourceOwnerId(String resourceOwnerId)
void	setTlsContext(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)
void	setTokenManager(TokenManagerConfig tokenManagerConfig)
void	setTokenRequestHandler(AbstractAuthorizationCodeTokenRequestHandler tokenRequestHandler)
boolean	shouldRetry(Event firstAttemptResponseEvent)
void	start()

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

buildAuthorizationHeaderContent

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthorizationCodeGrantType

public DefaultAuthorizationCodeGrantType()

Method Detail

setClientId

public void setClientId(String clientId)

setClientSecret

public void setClientSecret(String clientSecret)

setAuthorizationRequestHandler

public void setAuthorizationRequestHandler(AuthorizationRequestHandler authorizationRequestHandler)

setTokenRequestHandler

public void setTokenRequestHandler(AbstractAuthorizationCodeTokenRequestHandler tokenRequestHandler)

setLocalCallbackConfig

public void setLocalCallbackConfig(HttpListenerConfig localCallbackConfig)

setLocalCallbackConfigPath

public void setLocalCallbackConfigPath(String localCallbackConfigPath)

setLocalCallbackUrl

public void setLocalCallbackUrl(String localCallbackUrl)

setExternalCallbackUrl

public void setExternalCallbackUrl(String externalCallbackUrl)

getLocalCallbackConfig

public HttpListenerConfig getLocalCallbackConfig()

Specified by:

getLocalCallbackConfig in interface AuthorizationCodeGrantType

Returns:

callback listener configuration to start the server and define corresponding flow.

getLocalCallbackConfigPath

public String getLocalCallbackConfigPath()

Specified by:

getLocalCallbackConfigPath in interface AuthorizationCodeGrantType

Returns:

callback listener path for the flow to be created according to localCallbackConfig.

getLocalCallbackUrl

public String getLocalCallbackUrl()

Specified by:

getLocalCallbackUrl in interface AuthorizationCodeGrantType

Returns:

local callback URL for the flow to be created.

getExternalCallbackUrl

public String getExternalCallbackUrl()

Specified by:

getExternalCallbackUrl in interface AuthorizationCodeGrantType

Returns:

the external address of the callback, sent to the client.

getConfigOAuthContext

public ConfigOAuthContext getConfigOAuthContext()

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(Event currentFlowEvent,
                         String resourceOwnerId)
                  throws org.mule.runtime.api.exception.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:

org.mule.runtime.api.exception.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.

getClientSecret

public String getClientSecret()

Specified by:

getClientSecret in interface ApplicationCredentials

Returns:

oauth client secret of the hosted application

getClientId

public String getClientId()

Specified by:

getClientId in interface ApplicationCredentials

Returns:

oauth client id of the hosted application

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

getTlsContext

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

Specified by:

getTlsContext in interface AuthorizationCodeGrantType

Returns:

the tls configuration to use for listening and sending http request

setTlsContext

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

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

authenticate

public void authenticate(Event muleEvent,
                         HttpRequestBuilder builder)
                  throws org.mule.runtime.api.exception.MuleException

Specified by:

authenticate in interface HttpAuthentication

Throws:

org.mule.runtime.api.exception.MuleException

shouldRetry

public boolean shouldRetry(Event firstAttemptResponseEvent)
                    throws org.mule.runtime.api.exception.MuleException

Specified by:

shouldRetry in interface HttpAuthentication

Throws:

org.mule.runtime.api.exception.MuleException

setLocalAuthorizationUrlResourceOwnerId

public void setLocalAuthorizationUrlResourceOwnerId(String resourceOwnerId)

setResourceOwnerId

public void setResourceOwnerId(String resourceOwnerId)

setTokenManager

public void setTokenManager(TokenManagerConfig tokenManagerConfig)

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