Module org.mule.oauth.client.api

Package org.mule.oauth.client.api.state

Class ResourceOwnerOAuthContextWithRefreshState

java.lang.Object

org.mule.oauth.client.api.state.ResourceOwnerOAuthContextWithRefreshState

All Implemented Interfaces:

Serializable, ResourceOwnerOAuthContext

public final class ResourceOwnerOAuthContextWithRefreshState
extends Object
implements ResourceOwnerOAuthContext, Serializable

OAuth state for a particular resource owner which typically represents an user.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.mule.oauth.client.api.state.ResourceOwnerOAuthContext

DEFAULT_RESOURCE_OWNER_ID

Constructor Summary

Constructors

Constructor	Description
ResourceOwnerOAuthContextWithRefreshState(String resourceOwnerId)
ResourceOwnerOAuthContextWithRefreshState(ResourceOwnerOAuthContext original)	Since the runtime can be upgraded when there are already contexts stored, previous versions must be migrated to the new one.

Method Summary

Modifier and Type	Method	Description
static Lock	createRefreshOAuthContextLock(String lockNamePrefix, org.mule.runtime.api.lock.LockFactory lockProvider, String resourceOwnerId)	This utility method is needed for the cases where the context is being queried.
String	getAccessToken()
DancerState	getDancerState()
String	getExpiresIn()
Lock	getRefreshOAuthContextLock(String lockNamePrefix, org.mule.runtime.api.lock.LockFactory lockProvider)	Obtains a lock to avoid triggering a refresh of the context more than once simultaneously.
String	getRefreshToken()
String	getResourceOwnerId()
String	getState()
Map<String,Object>	getTokenResponseParameters()
void	setAccessToken(String accessToken)
void	setDancerState(DancerState dancerState)	Updates the state of the dancer for this context.
void	setExpiresIn(String expiresIn)
void	setRefreshToken(String refreshToken)
void	setState(String state)
void	setTokenResponseParameters(Map<String,Object> tokenResponseParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceOwnerOAuthContextWithRefreshState

public ResourceOwnerOAuthContextWithRefreshState(String resourceOwnerId)

ResourceOwnerOAuthContextWithRefreshState

public ResourceOwnerOAuthContextWithRefreshState(ResourceOwnerOAuthContext original)

Since the runtime can be upgraded when there are already contexts stored, previous versions must be migrated to the new one. The newly added state cannot be added to the previous version because that would break the java serialization of those objects.

Parameters:

original - the context to migrate

Method Detail

getAccessToken

public String getAccessToken()

Specified by:

getAccessToken in interface ResourceOwnerOAuthContext

Returns:

access token of the oauth context retrieved by the token request

getRefreshToken

public String getRefreshToken()

Specified by:

getRefreshToken in interface ResourceOwnerOAuthContext

Returns:

refresh token of the oauth context retrieved by the token request

getState

public String getState()

Specified by:

getState in interface ResourceOwnerOAuthContext

Returns:

state of the oauth context send in the authorization request

setAccessToken

public void setAccessToken(String accessToken)

setRefreshToken

public void setRefreshToken(String refreshToken)

setExpiresIn

public void setExpiresIn(String expiresIn)

getExpiresIn

public String getExpiresIn()

Specified by:

getExpiresIn in interface ResourceOwnerOAuthContext

Returns:

expires in value retrieved by the token request.

setState

public void setState(String state)

getTokenResponseParameters

public Map<String,Object> getTokenResponseParameters()

Specified by:

getTokenResponseParameters in interface ResourceOwnerOAuthContext

Returns:

custom token request response parameters configured for extraction.

setTokenResponseParameters

public void setTokenResponseParameters(Map<String,Object> tokenResponseParameters)

getResourceOwnerId

public String getResourceOwnerId()

Specified by:

getResourceOwnerId in interface ResourceOwnerOAuthContext

Returns:

id for the oauth state.

getDancerState

public DancerState getDancerState()

Specified by:

getDancerState in interface ResourceOwnerOAuthContext

Returns:

the state of the dance for the resource owner of this context.

setDancerState

public void setDancerState(DancerState dancerState)

Description copied from interface: ResourceOwnerOAuthContext

Updates the state of the dancer for this context.

Note that calling this just updates the internal state of this object. Calling this method does not persist this change in any store. That has to be done explicitly after calling this method.

Specified by:

setDancerState in interface ResourceOwnerOAuthContext

Parameters:

dancerState - the state of the dance for the resource owner of this context.

getRefreshOAuthContextLock

public Lock getRefreshOAuthContextLock(String lockNamePrefix,
                                       org.mule.runtime.api.lock.LockFactory lockProvider)

Description copied from interface: ResourceOwnerOAuthContext

Obtains a lock to avoid triggering a refresh of the context more than once simultaneously.

Specified by:

getRefreshOAuthContextLock in interface ResourceOwnerOAuthContext

Parameters:

lockNamePrefix - a prefix to uniquely identify the locks in the provided lockFactory.

lockProvider - the object to get the locks from. This will ensure that the same lock instance is used after serialization/deserialization of this context.

Returns:

a lock that can be used to avoid concurrency problems trying to update oauth context.

createRefreshOAuthContextLock

public static Lock createRefreshOAuthContextLock(String lockNamePrefix,
                                                 org.mule.runtime.api.lock.LockFactory lockProvider,
                                                 String resourceOwnerId)

This utility method is needed for the cases where the context is being queried. There is still no context created, but the same lock that this context would use is required for querying thread-safely.