public interface OAuthCapability
OAuth2
)
must have in order to trigger the generation of the OAuth2/1 featureModifier 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.
|
OAuthVersion getOAuthVersion()
Field getConsumerKeyField()
OAuthConsumerKey
Field getConsumerSecretField()
OAuthConsumerSecret
Field getAccessTokenField()
OAuthAccessToken
Field getScopeField()
OAuthScope
Field getAccessTokenSecretField()
OAuthAccessTokenSecret
String getVerifierRegex()
String getRequestTokenUrl()
String getAccessTokenUrl()
String getAuthorizationUrl()
String getExpirationRegex()
String getAccessTokenRegex()
String getRefreshTokenRegex()
Method<OAuthModule> getPostAuthorizationMethod()
List<OAuthAuthorizationParameter> getAuthorizationParameters()
List<OAuthCallbackParameterField> getCallbackParameters()
Method<OAuthModule> getUserIdentifierMethod()
OAuthAccessTokenIdentifier
DeclaredType getOAuthProvider()
org.mule.security.oauth.OnNoTokenPolicy getTokenPolicy()
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.