| Package | Description |
|---|---|
| org.mule.security.oauth | |
| org.mule.security.oauth.process | |
| org.mule.security.oauth.processor |
| Modifier and Type | Class and Description |
|---|---|
class |
BaseOAuth2Manager<C extends OAuth2Adapter> |
interface |
OAuth2Manager<C extends OAuth2Adapter>
Wrapper around
org.mule.api.annotations.oauth.OAuth2 annotated class that
will infuse it with access token management capabilities. |
| Modifier and Type | Method and Description |
|---|---|
OAuth2Adapter |
BaseOAuth2Manager.acquireAccessToken(String accessTokenId)
Borrow an access token from the pool
|
OAuth2Adapter |
BaseOAuth2Manager.createAdapter(MuleEvent event,
String verifier)
Create a new adapter using the specified verifier and insert it into the pool.
|
OAuth2Adapter |
BaseOAuth2Manager.getDefaultUnauthorizedConnector()
Retrieves defaultUnauthorizedConnector
|
protected abstract OAuth2Adapter |
BaseOAuth2Manager.instantiateAdapter()
Creates a concrete instance of the OAuth2Adapter that corresponds with this
OAuthManager
|
OAuth2Adapter |
BaseOAuthClientFactory.makeObject(String key)
This method creates an instance of
OAuth2Adapter which concrete type depends on
the return of
BaseOAuthClientFactory.getAdapterClass() The
adapter is fully initialized and interfaces such as
Initialisable,
MuleContextAware and
Startable are respected by invoking the
corresponding methods in case the adapter implements them. |
| Modifier and Type | Method and Description |
|---|---|
protected abstract org.apache.commons.pool.KeyedPoolableObjectFactory<String,OAuth2Adapter> |
BaseOAuth2Manager.createPoolFactory(OAuth2Manager<OAuth2Adapter> oauthManager,
ObjectStore<Serializable> objectStore)
Returns the concrete instance of
KeyedPoolableObjectFactory that's going to be
in charge of creating the objects in the pool |
org.apache.commons.pool.KeyedPoolableObjectFactory<String,OAuth2Adapter> |
BaseOAuth2Manager.getAccessTokenPoolFactory()
Retrieves accessTokenPoolFactory
|
org.apache.commons.pool.KeyedPoolableObjectFactory<String,OAuth2Adapter> |
OAuth2Manager.getAccessTokenPoolFactory()
Retrieves accessTokenPoolFactory
|
protected abstract Class<? extends OAuth2Adapter> |
BaseOAuthClientFactory.getAdapterClass()
Returns the class of the concrete implementation of
OAuth2Adapter that this factory is supposed to
generate |
<T> ProcessTemplate<T,OAuth2Adapter> |
BaseOAuth2Manager.getProcessTemplate() |
<T> ProcessTemplate<T,OAuth2Adapter> |
OAuth2Manager.getProcessTemplate() |
| Modifier and Type | Method and Description |
|---|---|
void |
BaseOAuthClientFactory.activateObject(String key,
OAuth2Adapter obj)
This default implementation does nothing
|
void |
BaseOAuth2Manager.destroyAccessToken(String userId,
OAuth2Adapter connector)
Destroy an access token
|
void |
BaseOAuthClientFactory.destroyObject(String key,
OAuth2Adapter obj)
If obj implements
Stoppable or
Disposable, the object is destroyed by invoking
the corresponding methods |
void |
BaseOAuth2Manager.fetchAccessToken(OAuth2Adapter adapter,
String redirectUri)
Makes an http call to the adapter's accessTokenUrl and extracts the access
token, which is then set into the adapter
|
void |
OAuth2Manager.fetchAccessToken(OAuth2Adapter adapter,
String redirectUri)
Makes an http call to the adapter's accessTokenUrl and extracts the access
token, which is then set into the adapter
|
protected abstract void |
BaseOAuth2Manager.fetchCallbackParameters(OAuth2Adapter adapter,
String response)
Extracts any custom parameters from the OAuth response and sets them
accordingly on the adapter
|
void |
BaseOAuth2Manager.hasBeenAuthorized(OAuth2Adapter adapter)
Validates that there's an access token for the given adapter.
|
void |
OAuth2Manager.hasBeenAuthorized(OAuth2Adapter adapter)
Validates that there's an access token for the given adapter.
|
void |
BaseOAuthClientFactory.passivateObject(String key,
OAuth2Adapter connector)
Passivates the object by updating the state of the persisted object with the
one of the given one.
|
void |
BaseOAuth2Manager.postAuth(OAuth2Adapter adapter,
String accessTokenId)
Calls the
org.mule.security.oauth.OAuth2Connector.postAuth() on the
adapter. |
void |
OAuth2Manager.postAuth(OAuth2Adapter adapter,
String accessTokenId)
Calls the
org.mule.security.oauth.OAuth2Connector.postAuth() on the
adapter. |
void |
BaseOAuth2Manager.refreshAccessToken(OAuth2Adapter adapter,
String accessTokenId)
if refresh token is available, then it makes an http call to refresh the
access token.
|
void |
OAuth2Manager.refreshAccessToken(OAuth2Adapter adapter,
String accessTokenId)
if refresh token is available, then it makes an http call to refresh the
access token.
|
void |
DefaultRefreshTokenManager.refreshToken(OAuth2Adapter adapter,
String accessTokenId)
Refreshes the token of the given id for the given adapter.
|
void |
RefreshTokenManager.refreshToken(OAuth2Adapter adapter,
String accessTokenId)
Refreshes the token of the given id for the given adapter.
|
void |
BaseOAuth2Manager.releaseAccessToken(String userId,
OAuth2Adapter connector)
Return an access token to the pool
|
protected abstract void |
BaseOAuthClientFactory.setCustomAdapterProperties(OAuth2Adapter adapter,
org.mule.common.security.oauth.OAuthState state)
Implementors can levarage this method to move custom property values from the
state to the adapter You can leave this method blank if not needed in your
case.
|
protected abstract void |
BaseOAuth2Manager.setCustomProperties(OAuth2Adapter adapter)
Populates the adapter with custom properties not accessible from the base
interface.
|
protected abstract void |
BaseOAuthClientFactory.setCustomStateProperties(OAuth2Adapter adapter,
org.mule.common.security.oauth.OAuthState state)
Implementos can leverage this method to move custom property values from the
adapter to the state.
|
protected void |
BaseOAuth2Manager.setDefaultUnauthorizedConnector(OAuth2Adapter defaultUnauthorizedConnector) |
boolean |
BaseOAuthClientFactory.validateObject(String key,
OAuth2Adapter obj)
Validates the object by checking that it exists at the object store and that
the state of the given object is consisten with the persisted state
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract org.apache.commons.pool.KeyedPoolableObjectFactory<String,OAuth2Adapter> |
BaseOAuth2Manager.createPoolFactory(OAuth2Manager<OAuth2Adapter> oauthManager,
ObjectStore<Serializable> objectStore)
Returns the concrete instance of
KeyedPoolableObjectFactory that's going to be
in charge of creating the objects in the pool |
protected void |
BaseOAuth2Manager.setAccessTokenPool(org.apache.commons.pool.impl.GenericKeyedObjectPool<String,OAuth2Adapter> accessTokenPool) |
| Constructor and Description |
|---|
BaseOAuthClientFactory(OAuth2Manager<OAuth2Adapter> oauthManager,
ObjectStore<Serializable> objectStore) |
| Modifier and Type | Method and Description |
|---|---|
T |
RefreshTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
Filter filter,
MuleMessage event) |
T |
ManagedAccessTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
Filter filter,
MuleMessage message) |
T |
RefreshTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
MessageProcessor messageProcessor,
MuleEvent event) |
T |
ManagedAccessTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
MessageProcessor messageProcessor,
MuleEvent event) |
| Modifier and Type | Method and Description |
|---|---|
P |
ManagedAccessTokenProcessTemplate.execute(ProcessCallback<P,OAuth2Adapter> processCallback,
Filter filter,
MuleMessage message) |
P |
ManagedAccessTokenProcessTemplate.execute(ProcessCallback<P,OAuth2Adapter> processCallback,
MessageProcessor messageProcessor,
MuleEvent event) |
T |
RefreshTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
Filter filter,
MuleMessage event) |
T |
ManagedAccessTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
Filter filter,
MuleMessage message) |
T |
RefreshTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
MessageProcessor messageProcessor,
MuleEvent event) |
T |
ManagedAccessTokenProcessInterceptor.execute(ProcessCallback<T,OAuth2Adapter> processCallback,
OAuth2Adapter object,
MessageProcessor messageProcessor,
MuleEvent event) |
| Constructor and Description |
|---|
ManagedAccessTokenProcessInterceptor(ProcessInterceptor<T,OAuth2Adapter> next,
OAuth2Manager<OAuth2Adapter> oauthManager) |
ManagedAccessTokenProcessInterceptor(ProcessInterceptor<T,OAuth2Adapter> next,
OAuth2Manager<OAuth2Adapter> oauthManager) |
ManagedAccessTokenProcessTemplate(OAuth2Manager<OAuth2Adapter> oauthManager,
MuleContext muleContext) |
RefreshTokenProcessInterceptor(ProcessInterceptor<T,OAuth2Adapter> next,
MuleContext context) |
| Modifier and Type | Class and Description |
|---|---|
class |
BaseOAuth2AuthorizeMessageProcessor<T extends OAuth2Manager<OAuth2Adapter>> |
class |
BaseOAuth2UnauthorizeMessageProcessor<T extends OAuth2Manager<OAuth2Adapter>> |
| Modifier and Type | Method and Description |
|---|---|
protected OAuth2Manager<OAuth2Adapter> |
BaseOAuth2AuthorizeMessageProcessor.getOAuthManager() |
protected OAuth2Manager<OAuth2Adapter> |
BaseOAuth2UnauthorizeMessageProcessor.getOAuthManager() |
| Constructor and Description |
|---|
OAuth2FetchAccessTokenMessageProcessor(OAuth2Manager<OAuth2Adapter> oauthManager,
String accessTokenId) |
Copyright © 2003–2016 MuleSoft, Inc.. All rights reserved.