public class

BoxConnectorOAuthManager

extends BoxConnectorHttpCallbackAdapter
implements MuleContextAware Initialisable Capabilities MetadataAware OAuthManager<C extends OAuthAdapter> ProcessAdapter<O>
java.lang.Object
   ↳ org.mule.modules.box.adapters.BoxConnectorHttpCallbackAdapter
     ↳ org.mule.modules.box.oauth.BoxConnectorOAuthManager

Class Overview

A BoxConnectorOAuthManager is a wrapper around BoxConnector that adds access token management capabilities to the pojo.

Summary

Constants
String DEVKIT_BUILD
String DEVKIT_VERSION
String MODULE_NAME
String MODULE_VERSION
[Expand]
Inherited Constants
From interface org.mule.api.lifecycle.Initialisable
Fields
private ObjectStore accessTokenObjectStore
private GenericKeyedObjectPool accessTokenPool Access Token Pool
private KeyedPoolableObjectFactory accessTokenPoolFactory Access Token Pool Factory
private String accessTokenUrl
private String authorizationUrl
private String baseUrl
private String clientId
private String clientSecret
private BoxConnectorOAuth2Adapter defaultUnauthorizedConnector
protected FlowConstruct flowConstruct Flow Construct
private static Logger logger
protected MuleContext muleContext muleContext
private String uploadUrl
private boolean useGzip
[Expand]
Inherited Fields
From class org.mule.modules.box.adapters.BoxConnectorHttpCallbackAdapter
Public Constructors
BoxConnectorOAuthManager()
Public Methods
BoxConnectorOAuth2Adapter acquireAccessToken(String userId)
Borrow an access token from the pool
String authorize(Map<String, String> extraParameters, String authorizationUrl, String redirectUri)
BoxConnectorOAuth2Adapter createAccessToken(String verifier)
Create a new access token using the specified verifier and insert it into the pool
void destroyAccessToken(String userId, BoxConnectorOAuth2Adapter connector)
void dispose()
ObjectStore getAccessTokenObjectStore()
Retrieves accessTokenObjectStore
KeyedPoolableObjectFactory getAccessTokenPoolFactory()
Retrieves accessTokenPoolFactory
String getAccessTokenUrl()
Retrieves accessTokenUrl
String getAuthorizationUrl()
Retrieves authorizationUrl
String getBaseUrl()
Retrieves baseUrl
String getClientId()
Retrieves clientId
String getClientSecret()
Retrieves clientSecret
BoxConnectorOAuth2Adapter getDefaultUnauthorizedConnector()
Retrieves defaultUnauthorizedConnector
String getDevkitBuild()
Returns the build of the DevKit used to create this module
String getDevkitVersion()
Returns the version of the DevKit used to create this module
FlowConstruct getFlowConstruct()
Retrieves flowConstruct
String getModuleName()
Returns the user-friendly name of this module
String getModuleVersion()
Returns the version of this module
MuleContext getMuleContext()
Retrieves muleContext
<P> ProcessTemplate<P, BoxConnectorOAuth2Adapter> getProcessTemplate()
String getUploadUrl()
Retrieves uploadUrl
boolean getUseGzip()
Retrieves useGzip
void initialise()
boolean isCapableOf(Capability capability)
Returns true if this module implements such capability
void releaseAccessToken(String userId, BoxConnectorOAuth2Adapter connector)
void setAccessTokenObjectStore(ObjectStore value)
Sets accessTokenObjectStore
void setAccessTokenUrl(String value)
Sets accessTokenUrl
void setAuthorizationUrl(String value)
Sets authorizationUrl
void setBaseUrl(String value)
Sets baseUrl
void setClientId(String value)
Sets clientId
void setClientSecret(String value)
Sets clientSecret
void setFlowConstruct(FlowConstruct flowConstruct)
void setMuleContext(MuleContext muleContext)
void setUploadUrl(String value)
Sets uploadUrl
void setUseGzip(boolean value)
Sets useGzip
void start()
void stop()
[Expand]
Inherited Methods
From class org.mule.modules.box.adapters.BoxConnectorHttpCallbackAdapter
From class java.lang.Object
From interface org.mule.api.context.MuleContextAware
From interface org.mule.api.lifecycle.Initialisable
From interface org.mule.modules.box.adapter.HttpCallbackAdapter
From interface org.mule.modules.box.basic.Capabilities
From interface org.mule.modules.box.basic.MetadataAware
From interface org.mule.modules.box.oauth.OAuthManager
From interface org.mule.modules.box.process.ProcessAdapter

Constants

private static final String DEVKIT_BUILD

Constant Value: "3.4.0.1555.8df15c1"

private static final String DEVKIT_VERSION

Constant Value: "3.4.0"

private static final String MODULE_NAME

Constant Value: "Box"

private static final String MODULE_VERSION

Constant Value: "2.0.2"

Fields

private ObjectStore accessTokenObjectStore

private GenericKeyedObjectPool accessTokenPool

Access Token Pool

private KeyedPoolableObjectFactory accessTokenPoolFactory

Access Token Pool Factory

private String accessTokenUrl

private String authorizationUrl

private String baseUrl

private String clientId

private String clientSecret

private BoxConnectorOAuth2Adapter defaultUnauthorizedConnector

protected FlowConstruct flowConstruct

Flow Construct

private static Logger logger

protected MuleContext muleContext

muleContext

private String uploadUrl

private boolean useGzip

Public Constructors

public BoxConnectorOAuthManager ()

Public Methods

public BoxConnectorOAuth2Adapter acquireAccessToken (String userId)

Borrow an access token from the pool

Parameters
userId User identification used to borrow the access token
Returns
  • An existing authorized connector
Throws
Exception

public String authorize (Map<String, String> extraParameters, String authorizationUrl, String redirectUri)

Parameters
extraParameters
authorizationUrl
redirectUri

public BoxConnectorOAuth2Adapter createAccessToken (String verifier)

Create a new access token using the specified verifier and insert it into the pool

Parameters
verifier OAuth verifier
Returns
  • A newly created connector
Throws
Exception

public void destroyAccessToken (String userId, BoxConnectorOAuth2Adapter connector)

Parameters
userId
connector
Throws
Exception

public void dispose ()

public ObjectStore getAccessTokenObjectStore ()

Retrieves accessTokenObjectStore

public KeyedPoolableObjectFactory getAccessTokenPoolFactory ()

Retrieves accessTokenPoolFactory

public String getAccessTokenUrl ()

Retrieves accessTokenUrl

public String getAuthorizationUrl ()

Retrieves authorizationUrl

public String getBaseUrl ()

Retrieves baseUrl

public String getClientId ()

Retrieves clientId

public String getClientSecret ()

Retrieves clientSecret

public BoxConnectorOAuth2Adapter getDefaultUnauthorizedConnector ()

Retrieves defaultUnauthorizedConnector

public String getDevkitBuild ()

Returns the build of the DevKit used to create this module

public String getDevkitVersion ()

Returns the version of the DevKit used to create this module

public FlowConstruct getFlowConstruct ()

Retrieves flowConstruct

public String getModuleName ()

Returns the user-friendly name of this module

public String getModuleVersion ()

Returns the version of this module

public MuleContext getMuleContext ()

Retrieves muleContext

public ProcessTemplate<P, BoxConnectorOAuth2Adapter> getProcessTemplate ()

public String getUploadUrl ()

Retrieves uploadUrl

public boolean getUseGzip ()

Retrieves useGzip

public void initialise ()

Throws
InitialisationException

public boolean isCapableOf (Capability capability)

Returns true if this module implements such capability

Parameters
capability The capability to test for
Returns
  • True if it does, false otherwise

public void releaseAccessToken (String userId, BoxConnectorOAuth2Adapter connector)

Parameters
userId
connector
Throws
Exception

public void setAccessTokenObjectStore (ObjectStore value)

Sets accessTokenObjectStore

Parameters
value Value to set

public void setAccessTokenUrl (String value)

Sets accessTokenUrl

Parameters
value Value to set

public void setAuthorizationUrl (String value)

Sets authorizationUrl

Parameters
value Value to set

public void setBaseUrl (String value)

Sets baseUrl

Parameters
value Value to set

public void setClientId (String value)

Sets clientId

Parameters
value Value to set

public void setClientSecret (String value)

Sets clientSecret

Parameters
value Value to set

public void setFlowConstruct (FlowConstruct flowConstruct)

Parameters
flowConstruct

public void setMuleContext (MuleContext muleContext)

Parameters
muleContext

public void setUploadUrl (String value)

Sets uploadUrl

Parameters
value Value to set

public void setUseGzip (boolean value)

Sets useGzip

Parameters
value Value to set

public void start ()

Throws
MuleException

public void stop ()

Throws
MuleException