org.mule.modules.box.config

Class OAuth2ServerToServerConfig

java.lang.Object

org.mule.modules.box.config.AbstractConfig

org.mule.modules.box.config.OAuth2ServerToServerConfig

@ConnectionManagement(configElementName="config-oauth-server-to-server",
                      friendlyName="OAuth 2.0 Server to Server")
public class OAuth2ServerToServerConfig
extends AbstractConfig

Config for app-auth. This authentication method is meant for server-to-server applications and replaces the first leg of the standard 3-legged OAuth 2.0. Because your application authenticates directly to Box, this process removes the friction of multiple logins and services for your users. App Auth allows your application to request OAuth 2.0 access tokens necessary to make calls to the Box Content API. Your application may request one of two token types: Enterprise access token: Used to provision users via the /users endpoint. User access token: Used to make API calls to endpoints of the Content API.

Constructor Summary

Constructors

Constructor and Description
OAuth2ServerToServerConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(String clientId, String clientSecret) Establishes a connection with the Box API.
String	connectionId() Returns the connection ID
void	disconnect() Disconnect the current connection
ConnectionType	getConnectionType()
com.box.sdk.EncryptionAlgorithm	getEncryptionAlgorithm()
String	getEntityId()
org.mule.api.MuleContext	getMuleContext()
String	getPrivateKeyPassword()
String	getPrivateKeyPath()
String	getPublicKeyId()
boolean	isConnected() Are we connected?
void	setConnectionType(ConnectionType connectionType)
void	setEncryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)
void	setEntityId(String entityId)
void	setMuleContext(org.mule.api.MuleContext muleContext)
void	setPrivateKeyPassword(String privateKeyPassword)
void	setPrivateKeyPath(String privateKeyPath)
void	setPublicKeyId(String publicKeyId)

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

OAuth2ServerToServerConfig

public OAuth2ServerToServerConfig()

Method Detail

connect

@Connect(strategy=SINGLE_INSTANCE)
@TestConnectivity
public void connect(@ConnectionKey
                                    String clientId,
                                    String clientSecret)
             throws org.mule.api.ConnectionException

Establishes a connection with the Box API.

Parameters:

clientId - The client ID of your application.

clientSecret - The client password of your application.

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.

setMuleContext

public void setMuleContext(org.mule.api.MuleContext muleContext)

getMuleContext

public org.mule.api.MuleContext getMuleContext()

getPrivateKeyPath

public String getPrivateKeyPath()

setPrivateKeyPath

public void setPrivateKeyPath(String privateKeyPath)

getPublicKeyId

public String getPublicKeyId()

setPublicKeyId

public void setPublicKeyId(String publicKeyId)

getConnectionType

public ConnectionType getConnectionType()

setConnectionType

public void setConnectionType(ConnectionType connectionType)

getEncryptionAlgorithm

public com.box.sdk.EncryptionAlgorithm getEncryptionAlgorithm()

setEncryptionAlgorithm

public void setEncryptionAlgorithm(com.box.sdk.EncryptionAlgorithm encryptionAlgorithm)

getEntityId

public String getEntityId()

setEntityId

public void setEntityId(String entityId)

getPrivateKeyPassword

public String getPrivateKeyPassword()

setPrivateKeyPassword

public void setPrivateKeyPassword(String privateKeyPassword)