org.mule.modules.box.config

Class OAuth2DevTokenConfig

java.lang.Object

org.mule.modules.box.config.AbstractConfig

org.mule.modules.box.config.OAuth2DevTokenConfig

@ConnectionManagement(configElementName="config-oauth-dev-token",
                      friendlyName="OAuth 2.0 Developer Token")
public class OAuth2DevTokenConfig
extends AbstractConfig

Connection to Box using developer token. A developer token can only be used to access a user's own apps hence this Config should not be used for production. A developer token is simply a short-lived access token that cannot be refreshed and can only be used with your own account. Therefore, they're only useful for testing an app and aren't suitable for production. One can obtain a developer token from your application's developer console.

Constructor Summary

Constructors

Constructor and Description
OAuth2DevTokenConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(String developerToken) Establishes a connection with the Box API.
String	connectionId() Returns the connection ID
void	disconnect() Disconnect the current connection
boolean	isConnected() Are we connected?
void	testConnect(String developerToken)

Methods inherited from class org.mule.modules.box.config.AbstractConfig

getAssignmentclient, getBoxAPIConnection, getCollaborationClient, getCommentClient, getFileClient, getFolderClient, getGroupClient, getMembershipClient, getTaskClient, getTrashClient, getUserClient, getVersionClient, setBoxAPIConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2DevTokenConfig

public OAuth2DevTokenConfig()

Method Detail

connect

@Connect(strategy=SINGLE_INSTANCE)
public void connect(@ConnectionKey@FriendlyName(value="Developer Token")
                   String developerToken)
             throws org.mule.api.ConnectionException

Establishes a connection with the Box API.

Parameters:

developerToken - A token that behaves just like a full OAuth2 bearer token. It gives you access to your account on a temporary basis. Limitations:

• It expires after 1 hour.
• It is only valid for your own account (so you can't use them to test other people using your app).
• There is no refresh token paired with the token.

Throws:

org.mule.api.ConnectionException

testConnect

@TestConnectivity
public void testConnect(@ConnectionKey@FriendlyName(value="Developer Token")
                                String developerToken)
                 throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

connectionId

@ConnectionIdentifier
public String connectionId()

Returns the connection ID

Returns:

String with the connection Id

disconnect

@Disconnect
public void disconnect()

Disconnect the current connection

isConnected

@ValidateConnection
public boolean isConnected()

Are we connected?

Returns:

boolean true if the connection is still valid or false otherwise.