org.mule.extension.oauth2.api.authorizationcode

Class DefaultAuthorizationCodeGrantType

java.lang.Object

org.mule.extension.oauth2.internal.AbstractGrantType

org.mule.extension.oauth2.api.authorizationcode.DefaultAuthorizationCodeGrantType

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

@Alias(value="authorization-code-grant-type")
 @NoExtend
 @NoInstantiate
public class DefaultAuthorizationCodeGrantType
extends AbstractGrantType

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 class org.mule.extension.oauth2.internal.AbstractGrantType

customParameterExtractors, expressionEvaluator, lockFactory, muleContext, oAuthService, resolver, responseAccessToken, responseExpiresIn, responseRefreshToken, tokenManager

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
DefaultAuthorizationCodeGrantType()

Method Summary

Modifier and Type	Method and Description
void	authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder)
void	doInitialize()
boolean	equals(Object obj)
String	getAuthorizationUrl()
Map<String,String>	getCustomParameters()
org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer	getDancer()
String	getExternalCallbackUrl()
org.mule.runtime.http.api.HttpService	getHttpService()
String	getLocalAuthorizationUrl()
org.mule.runtime.extension.api.runtime.parameter.Literal<String>	getLocalAuthorizationUrlResourceOwnerId()
String	getLocalCallbackConfig()
String	getLocalCallbackConfigPath()
String	getLocalCallbackUrl()
org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<String>	getResourceOwnerId()
org.mule.runtime.extension.api.runtime.parameter.Literal<String>	getState()
ConfigOAuthContext	getUserOAuthContext()
int	hashCode()
boolean	isEncodeClientCredentialsInBody()
void	retryIfShould(org.mule.runtime.extension.api.runtime.operation.Result<Object,org.mule.extension.http.api.HttpResponseAttributes> firstAttemptResult, Runnable retryCallback, Runnable notRetryCallback)
void	setAuthorizationUrl(String authorizationUrl)
void	setEncodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)
void	setExternalCallbackUrl(String externalCallbackUrl)
void	setHttpService(org.mule.runtime.http.api.HttpService httpService)
void	setLocalAuthorizationUrl(String localAuthorizationUrl)
void	setLocalAuthorizationUrlResourceOwnerId(org.mule.runtime.extension.api.runtime.parameter.Literal<String> localAuthorizationUrlResourceOwnerId)
void	setLocalCallbackConfig(String localCallbackConfig)
void	setLocalCallbackConfigPath(String localCallbackConfigPath)
void	setLocalCallbackUrl(String localCallbackUrl)
void	setResourceOwnerId(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<String> resourceOwnerId)
void	setState(org.mule.runtime.extension.api.runtime.parameter.Literal<String> state)
boolean	shouldRetry(org.mule.runtime.extension.api.runtime.operation.Result<Object,org.mule.extension.http.api.HttpResponseAttributes> firstAttemptResult)

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

buildAuthorizationHeaderContent, configureBaseDancer, dispose, getClientId, getClientSecret, getCustomParameterExtractors, getRefreshTokenWhen, getResponseAccessToken, getResponseExpiresIn, getResponseRefreshToken, getScopes, getTlsContextFactory, getTokenUrl, initialise, initTokenManager, isDefaultTokenManager, readsAuthenticatedResponseBody, setRefreshTokenWhen, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAuthorizationCodeGrantType

public DefaultAuthorizationCodeGrantType()

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractGrantType

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractGrantType

setLocalCallbackConfig

public void setLocalCallbackConfig(String localCallbackConfig)

setLocalCallbackConfigPath

public void setLocalCallbackConfigPath(String localCallbackConfigPath)

setLocalCallbackUrl

public void setLocalCallbackUrl(String localCallbackUrl)

setExternalCallbackUrl

public void setExternalCallbackUrl(String externalCallbackUrl)

getState

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

setState

public void setState(org.mule.runtime.extension.api.runtime.parameter.Literal<String> state)

getLocalAuthorizationUrlResourceOwnerId

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

setLocalAuthorizationUrlResourceOwnerId

public void setLocalAuthorizationUrlResourceOwnerId(org.mule.runtime.extension.api.runtime.parameter.Literal<String> localAuthorizationUrlResourceOwnerId)

getLocalAuthorizationUrl

public String getLocalAuthorizationUrl()

setLocalAuthorizationUrl

public void setLocalAuthorizationUrl(String localAuthorizationUrl)

getAuthorizationUrl

public String getAuthorizationUrl()

setAuthorizationUrl

public void setAuthorizationUrl(String authorizationUrl)

getCustomParameters

public Map<String,String> getCustomParameters()

getResourceOwnerId

public org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<String> getResourceOwnerId()

setResourceOwnerId

public void setResourceOwnerId(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<String> resourceOwnerId)

setEncodeClientCredentialsInBody

public void setEncodeClientCredentialsInBody(boolean encodeClientCredentialsInBody)

getHttpService

public org.mule.runtime.http.api.HttpService getHttpService()

setHttpService

public void setHttpService(org.mule.runtime.http.api.HttpService httpService)

getLocalCallbackConfig

public String getLocalCallbackConfig()

getLocalCallbackConfigPath

public String getLocalCallbackConfigPath()

getLocalCallbackUrl

public String getLocalCallbackUrl()

getExternalCallbackUrl

public String getExternalCallbackUrl()

getUserOAuthContext

public ConfigOAuthContext getUserOAuthContext()

doInitialize

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

Overrides:

doInitialize in class AbstractGrantType

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

authenticate

public void authenticate(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder builder)
                  throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

shouldRetry

public boolean shouldRetry(org.mule.runtime.extension.api.runtime.operation.Result<Object,org.mule.extension.http.api.HttpResponseAttributes> firstAttemptResult)
                    throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

retryIfShould

public void retryIfShould(org.mule.runtime.extension.api.runtime.operation.Result<Object,org.mule.extension.http.api.HttpResponseAttributes> firstAttemptResult,
                          Runnable retryCallback,
                          Runnable notRetryCallback)
                   throws org.mule.runtime.extension.api.exception.ModuleException

Throws:

org.mule.runtime.extension.api.exception.ModuleException

getDancer

public org.mule.runtime.oauth.api.AuthorizationCodeOAuthDancer getDancer()

Specified by:

getDancer in class AbstractGrantType

isEncodeClientCredentialsInBody

public boolean isEncodeClientCredentialsInBody()

Specified by:

isEncodeClientCredentialsInBody in class AbstractGrantType