org.mule.devkit.model.module.oauth

Interface OAuthCapability

All Known Subinterfaces:

OAuth2Component, OAuthModule

public interface OAuthCapability

Interface that sums up the complete behaviour that a Component/Module(OAuth2) must have in order to trigger the generation of the OAuth2/1 feature

Method Summary

Methods

Modifier and Type	Method and Description
Field	getAccessTokenField() Retrieve the field annotated with OAuthAccessToken
String	getAccessTokenRegex() A Java regular expression used to extract the Access Token from the Service Provider response.
Field	getAccessTokenSecretField() Retrieve the field annotated with OAuthAccessTokenSecret
String	getAccessTokenUrl() The URL defined by the Service Provider to obtain an Access Token
List<OAuthAuthorizationParameter>	getAuthorizationParameters() Extra authorization parameters that will be appended as a query string arguments when building the authorization URL.
String	getAuthorizationUrl() The URL defined by the Service Provider where the Resource Owner will be redirected to grant authorization to the Consumer
List<OAuthCallbackParameterField>	getCallbackParameters() Retrieve a list of fields that need to be populated once the callback in OAuth is executed.
Field	getConsumerKeyField() Retrieve the field annotated with OAuthConsumerKey
Field	getConsumerSecretField() Retrieve the field annotated with OAuthConsumerSecret
String	getExpirationRegex() A Java regular expression used to extract the expiration time of the Access Token (in seconds) from the Service Provider response.
DeclaredType	getOAuthProvider()
OAuthVersion	getOAuthVersion()
Method<OAuthModule>	getPostAuthorizationMethod() Retrieve the method that should be executed once the authorization process has ended.
String	getRefreshTokenRegex() A Java regular expression used to extract the Refresh Token from the Service Provider response.
String	getRequestTokenUrl() The URL defined by the Service Provider used to obtain an un-authorized Request Token
Field	getScopeField() Retrieve the field annotated with OAuthScope
org.mule.security.oauth.OnNoTokenPolicy	getTokenPolicy()
Method<OAuthModule>	getUserIdentifierMethod() Retrieve the method marked with OAuthAccessTokenIdentifier
String	getVerifierRegex() A Java regular expression used to extract the verifier from the Service Provider response as a result of the Resource Owner authorizing the Consumer.

Method Detail

getOAuthVersion

OAuthVersion getOAuthVersion()

getConsumerKeyField

Field getConsumerKeyField()

Retrieve the field annotated with OAuthConsumerKey

getConsumerSecretField

Field getConsumerSecretField()

Retrieve the field annotated with OAuthConsumerSecret

getAccessTokenField

Field getAccessTokenField()

Retrieve the field annotated with OAuthAccessToken

getScopeField

Field getScopeField()

Retrieve the field annotated with OAuthScope

getAccessTokenSecretField

Field getAccessTokenSecretField()

Retrieve the field annotated with OAuthAccessTokenSecret

getVerifierRegex

String getVerifierRegex()

A Java regular expression used to extract the verifier from the Service Provider response as a result of the Resource Owner authorizing the Consumer.

getRequestTokenUrl

String getRequestTokenUrl()

The URL defined by the Service Provider used to obtain an un-authorized Request Token

getAccessTokenUrl

String getAccessTokenUrl()

The URL defined by the Service Provider to obtain an Access Token

getAuthorizationUrl

String getAuthorizationUrl()

The URL defined by the Service Provider where the Resource Owner will be redirected to grant authorization to the Consumer

getExpirationRegex

String getExpirationRegex()

A Java regular expression used to extract the expiration time of the Access Token (in seconds) from the Service Provider response. If the this regular expression is not found in the Service Provider response (whether the regular expression is wrong or the Access Token never expires), the Access Token will be treated as if it would never expire.

getAccessTokenRegex

String getAccessTokenRegex()

A Java regular expression used to extract the Access Token from the Service Provider response.

getRefreshTokenRegex

String getRefreshTokenRegex()

A Java regular expression used to extract the Refresh Token from the Service Provider response.

getPostAuthorizationMethod

Method<OAuthModule> getPostAuthorizationMethod()

Retrieve the method that should be executed once the authorization process has ended.

getAuthorizationParameters

List<OAuthAuthorizationParameter> getAuthorizationParameters()

Extra authorization parameters that will be appended as a query string arguments when building the authorization URL.

getCallbackParameters

List<OAuthCallbackParameterField> getCallbackParameters()

Retrieve a list of fields that need to be populated once the callback in OAuth is executed.

getUserIdentifierMethod

Method<OAuthModule> getUserIdentifierMethod()

Retrieve the method marked with OAuthAccessTokenIdentifier

getOAuthProvider

DeclaredType getOAuthProvider()

getTokenPolicy

org.mule.security.oauth.OnNoTokenPolicy getTokenPolicy()