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

Interface AuthorizationCodeGrantType

All Superinterfaces:

ApplicationCredentials

All Known Implementing Classes:

DefaultAuthorizationCodeGrantType

public interface AuthorizationCodeGrantType
extends ApplicationCredentials

Provides access to the general configuration of an authorization code oauth config.

Method Summary

Modifier and Type	Method and Description
String	getExternalCallbackUrl()
AttributeEvaluator	getLocalAuthorizationUrlResourceOwnerIdEvaluator()
HttpListenerConfig	getLocalCallbackConfig()
String	getLocalCallbackConfigPath()
String	getLocalCallbackUrl()
String	getRefreshTokenWhen()
AttributeEvaluator	getResourceOwnerIdEvaluator()
org.mule.runtime.api.tls.TlsContextFactory	getTlsContext()
ConfigOAuthContext	getUserOAuthContext()
void	refreshToken(Event currentFlowEvent, String resourceOwnerId) Does a refresh token for a particular oauth context id.

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

getClientId, getClientSecret

Method Detail

getLocalCallbackConfig

HttpListenerConfig getLocalCallbackConfig()

Returns:

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

getLocalCallbackConfigPath

String getLocalCallbackConfigPath()

Returns:

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

getLocalCallbackUrl

String getLocalCallbackUrl()

Returns:

local callback URL for the flow to be created.

getExternalCallbackUrl

String getExternalCallbackUrl()

Returns:

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

getRefreshTokenWhen

String getRefreshTokenWhen()

Returns:

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

getLocalAuthorizationUrlResourceOwnerIdEvaluator

AttributeEvaluator getLocalAuthorizationUrlResourceOwnerIdEvaluator()

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

AttributeEvaluator getResourceOwnerIdEvaluator()

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

void refreshToken(Event currentFlowEvent,
                  String resourceOwnerId)
           throws org.mule.runtime.api.exception.MuleException

Does a refresh token for a particular oauth context id.

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

ConfigOAuthContext getUserOAuthContext()

Returns:

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

getTlsContext

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

Returns:

the tls configuration to use for listening and sending http request