org.mule.extension.oauth2.internal

Class OAuthOperations

java.lang.Object

org.mule.extension.oauth2.internal.OAuthOperations

public class OAuthOperations
extends Object

Provides management capabilities for the configured tokenManager.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
OAuthOperations()

Method Summary

Modifier and Type	Method and Description
void	invalidateOauthContext(TokenManagerConfig tokenManager, String resourceOwnerId) Clears the oauth context for a token manager and a resource owner id.
String	retrieveAccessToken(TokenManagerConfig tokenManager, String resourceOwnerId) Returns the access token of the token manager for the parametrized resource owner ID
Object	retrieveCustomTokenResponseParam(TokenManagerConfig tokenManager, String resourceOwnerId, String key) Returns the value of the parameter that was extracted during the dance from the token manager for the parametrized resource owner ID
String	retrieveExpiresIn(TokenManagerConfig tokenManager, String resourceOwnerId) Returns the expiration of the oauth context for the parametrized resource owner ID
String	retrieveRefreshToken(TokenManagerConfig tokenManager, String resourceOwnerId) Returns the refresh token of the oauth context for the parametrized resource owner ID
String	retrieveState(TokenManagerConfig tokenManager, String resourceOwnerId) Returns the state of the oauth context for the parametrized resource owner ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthOperations

public OAuthOperations()

Method Detail

invalidateOauthContext

public void invalidateOauthContext(@Expression(value=NOT_SUPPORTED)
                                   TokenManagerConfig tokenManager,
                                   @Optional(defaultValue="default")
                                   String resourceOwnerId)

Clears the oauth context for a token manager and a resource owner id.

Parameters:

tokenManager - The token manager which holds the credentials to invalidate.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

retrieveAccessToken

@MediaType(value="text/plain",
           strict=false)
public String retrieveAccessToken(@Expression(value=NOT_SUPPORTED)
                                                                                          TokenManagerConfig tokenManager,
                                                                                          @Optional(defaultValue="default")
                                                                                          String resourceOwnerId)

Returns the access token of the token manager for the parametrized resource owner ID

Parameters:

tokenManager - The token manager which holds the access token.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

Returns:

access token of the oauth context retrieved by the token request.

retrieveRefreshToken

@MediaType(value="text/plain",
           strict=false)
public String retrieveRefreshToken(@Expression(value=NOT_SUPPORTED)
                                                                                           TokenManagerConfig tokenManager,
                                                                                           @Optional(defaultValue="default")
                                                                                           String resourceOwnerId)

Returns the refresh token of the oauth context for the parametrized resource owner ID

Parameters:

tokenManager - The token manager which holds the refresh token.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

Returns:

refresh token of the oauth context retrieved by the token request.

retrieveExpiresIn

@MediaType(value="text/plain",
           strict=false)
public String retrieveExpiresIn(@Expression(value=NOT_SUPPORTED)
                                                                                        TokenManagerConfig tokenManager,
                                                                                        @Optional(defaultValue="default")
                                                                                        String resourceOwnerId)

Returns the expiration of the oauth context for the parametrized resource owner ID

Parameters:

tokenManager - The token manager which holds the access token.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

Returns:

the expiration of the oauth context retrieved by the token request.

retrieveState

@MediaType(value="text/plain",
           strict=false)
public String retrieveState(@Expression(value=NOT_SUPPORTED)
                                                                                    TokenManagerConfig tokenManager,
                                                                                    @Optional(defaultValue="default")
                                                                                    String resourceOwnerId)

Returns the state of the oauth context for the parametrized resource owner ID

Parameters:

tokenManager - The token manager which holds the access token.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

Returns:

state of the oauth context retrieved by the token request.

retrieveCustomTokenResponseParam

@OutputResolver(output=TokenResponseParameterOutputResolver.class)
public Object retrieveCustomTokenResponseParam(@Expression(value=NOT_SUPPORTED)
                                                                                                                  TokenManagerConfig tokenManager,
                                                                                                                  @Optional(defaultValue="default")
                                                                                                                  String resourceOwnerId,
                                                                                                                  String key)

Returns the value of the parameter that was extracted during the dance from the token manager for the parametrized resource owner ID

Parameters:

tokenManager - The token manager which holds the access token.

resourceOwnerId - The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

key - to look for in the elements that has been extracted after the previous OAuth dance.

Returns:

an element if there was previously introduced by the OAuth dance and the custom parameter extractor. Null otherwise

See Also:

AbstractGrantType.parameterExtractors