org.mule.extension.oauth2.internal.authorizationcode

Class DefaultAuthorizationCodeGrantType

java.lang.Object

org.mule.extension.oauth2.internal.AbstractGrantType

org.mule.extension.oauth2.internal.authorizationcode.DefaultAuthorizationCodeGrantType

All Implemented Interfaces:

HttpAuthentication, ApplicationCredentials, AuthorizationCodeGrantType, 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, MuleContextAware

@Alias(value="authorization-code-grant-type")
public class DefaultAuthorizationCodeGrantType
extends AbstractGrantType
implements org.mule.runtime.api.lifecycle.Lifecycle, AuthorizationCodeGrantType

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

muleContext, resolver, 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(HttpRequestBuilder builder)
void	dispose()
String	getClientId()
String	getClientSecret()
String	getExternalCallbackUrl()
HttpListenerConfig	getLocalCallbackConfig()
String	getLocalCallbackConfigPath()
String	getLocalCallbackUrl()
HttpServer	getServer()
org.mule.runtime.api.tls.TlsContextFactory	getTlsContext()
ConfigOAuthContext	getUserOAuthContext()
void	initialise()
void	setMuleContext(MuleContext muleContext)
boolean	shouldRetry(org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes> firstAttemptResult)
void	start()
void	stop()

Methods inherited from class org.mule.extension.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

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.

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

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

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(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(org.mule.runtime.extension.api.runtime.operation.Result<Object,HttpResponseAttributes> firstAttemptResult)
                    throws org.mule.runtime.api.exception.MuleException

Specified by:

shouldRetry in interface HttpAuthentication

Throws:

org.mule.runtime.api.exception.MuleException

setMuleContext

public void setMuleContext(MuleContext muleContext)

Specified by:

setMuleContext in interface MuleContextAware

Overrides:

setMuleContext in class AbstractGrantType

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

getServer

public HttpServer getServer()

Specified by:

getServer in interface AuthorizationCodeGrantType

Returns:

the http server to listen for requests during the OAuth dance.