org.mule.api.annotations.oauth
Annotation Type OAuth

@Target(value=TYPE)
@Retention(value=SOURCE)
@Documented
public @interface OAuth

A class annotated with @OAuth is applied to a @Module that uses the OAuth 1.0a protocol for authentication. Basic information about the Service Provider is required to go through the OAuth 1.0a flow.

Required Element Summary

String	accessTokenUrl The URL defined by the Service Provider to obtain an Access Token
String	authorizationUrl The URL defined by the Service Provider where the Resource Owner will be redirected to grant authorization to the Consumer
String	requestTokenUrl The URL defined by the Service Provider used to obtain an un-authorized Request Token

Optional Element Summary

OAuthAuthorizationParameter[]	authorizationParameters Extra authorization parameters that will be appended as a query string arguments when building the authorization URL.
OAuthMessageSigner	messageSigner The signature method to be used in the OAuth 1.0a flow.
Class<?>	provider Default SignPost OAuth provider
OAuthSigningStrategy	signingStrategy Defines where the OAuth 1.0a parameters should be included.
String	verifierRegex A Java regular expression used to extract the verifier from the Service Provider response as a result of the Resource Owner authorizing the Consumer.

Element Detail

requestTokenUrl

public abstract String requestTokenUrl

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

accessTokenUrl

public abstract String accessTokenUrl

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

authorizationUrl

public abstract String authorizationUrl

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

messageSigner

public abstract OAuthMessageSigner messageSigner

The signature method to be used in the OAuth 1.0a flow. This method will be included in the auth_signature_method parameter.

Default:

org.mule.api.annotations.oauth.OAuthMessageSigner.HMAC_SHA1

signingStrategy

public abstract OAuthSigningStrategy signingStrategy

Defines where the OAuth 1.0a parameters should be included.

Default:

org.mule.api.annotations.oauth.OAuthSigningStrategy.AUTHORIZATION_HEADER

provider

public abstract Class<?> provider

Default SignPost OAuth provider

Default:

java.lang.Object.class

verifierRegex

public abstract String verifierRegex

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

Default:

"oauth_verifier=([^&]+)"

authorizationParameters

public abstract OAuthAuthorizationParameter[] authorizationParameters

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

Default:

{}