org.mule.runtime.oauth.api

Interface OAuthService

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject, org.mule.runtime.api.service.Service, org.mule.runtime.api.artifact.SplashMessageProvider

public interface OAuthService
extends org.mule.runtime.api.service.Service

Allows for creation of OAuth dancer implementations for the supported grant types:

• Authorization Code Grant Type
• Client Credentials

Since:

4.0

Method Summary

Modifier and Type	Method and Description
<T> OAuthAuthorizationCodeDancerBuilder	authorizationCodeGrantTypeDancerBuilder(org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,T> tokensStore, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator) Creates a builder for an AuthorizationCodeOAuthDancer for authorization code grant type.
<T> OAuthClientCredentialsDancerBuilder	clientCredentialsGrantTypeDancerBuilder(org.mule.runtime.api.lock.LockFactory lockProvider, Map<String,T> tokensStore, org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator) Creates a builder for an ClientCredentialsOAuthDancer for client credentials grant type.

Methods inherited from interface org.mule.runtime.api.service.Service

getSplashMessage

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

clientCredentialsGrantTypeDancerBuilder

<T> OAuthClientCredentialsDancerBuilder clientCredentialsGrantTypeDancerBuilder(org.mule.runtime.api.lock.LockFactory lockProvider,
                                                                                Map<String,T> tokensStore,
                                                                                org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Creates a builder for an ClientCredentialsOAuthDancer for client credentials grant type. The dancer will use the given lockProvider and tokensStore to manage its internal state.

Parameters:

lockProvider - a factory for Locks, uniquely identified by the name passed to LockFactory.createLock(String).

tokensStore - the repository for the tokens for the returned dancer.

expressionEvaluator - the object used to evaluate expressions.

Returns:

a builder for a client-credentials grant type dancer.

authorizationCodeGrantTypeDancerBuilder

<T> OAuthAuthorizationCodeDancerBuilder authorizationCodeGrantTypeDancerBuilder(org.mule.runtime.api.lock.LockFactory lockProvider,
                                                                                Map<String,T> tokensStore,
                                                                                org.mule.runtime.api.el.MuleExpressionLanguage expressionEvaluator)

Creates a builder for an AuthorizationCodeOAuthDancer for authorization code grant type. The dancer will use the given lockProvider and tokensStore to manage its internal state.

Parameters:

lockProvider - a factory for Locks, uniquely identified by the name passed to LockFactory.createLock(String).

tokensStore - the repository for the tokens for the returned dancer.

expressionEvaluator - the object used to evaluate expressions.

Returns:

a builder for an authorization-code grant type dancer.