public class

BoxConnectorCapabilitiesAdapter

extends BoxConnector
implements Capabilities

java.lang.Object
↳	org.mule.modules.boxnet.BoxConnector
	↳	org.mule.modules.boxnet.adapters.BoxConnectorCapabilitiesAdapter

Known Direct Subclasses

BoxConnectorMetadataAdapater

Known Indirect Subclasses

BoxConnectorLifecycleAdapter, BoxConnectorProcessAdapter

Class Overview

A BoxConnectorCapabilitiesAdapter is a wrapper around BoxConnector that implements org.mule.api.Capabilities interface.

Summary

[Expand]

Inherited Constants

From class org.mule.modules.boxnet.BoxConnector

[Expand]

Inherited Fields

From class org.mule.modules.boxnet.BoxConnector

private String	apiKey	The API key obtained when registering a project with the Box platform.
private AuthCallbackAdapter	authCallback
private String	authToken
private String	callbackPath	The url where box.net will direct the authentication callback.
private Integer	callbackPort	The port where the authentication callback will be listening on Defaults to 8080
private BoxExternalAPI	client
private static final Base64Decoder	decoder
private Connector	httpConnector	The http connector to be used when serving the authorization callback.
private static final Logger	logger
private MuleContext	muleContext
private String	postAuthFlow	The name of a flow to be invoked after an authorization callback is received.
private Flow	postAuthorizationFlow
private String	restoreAuthTokenFlow	The name of a flow to be executed each time the authentication token needs to be used.
private Flow	restoreTokenFlow	Actual restore token flow egarly fetched
private String	saveAuthTokenFlow	The name of a flow to be executed each time an authentication token is received.
private Flow	saveTokenFlow	Actual save token flow egarly fetched
private boolean	usesCallback	If true, an http inbound endpoint will be set in place to receive a callback from box.net with the authToken once the user has authenticated.

Public Constructors
	BoxConnectorCapabilitiesAdapter()

Public Methods
boolean	isCapableOf(Capability capability) Returns true if this module implements such capability

[Expand]

Inherited Methods

From class org.mule.modules.boxnet.BoxConnector

String	addToTag(MuleMessage message, String csvTags, Target target, String targetId) This processor adds file or folder to tags list.
void	authToken(MuleMessage message, String ticket) After the user authenticates the ticket obtained with the get-ticket processor, there're two ways to get the required auth token: You can configure box.net to make a callback returning the ticket and authToken, in which case you need to set the usesCallback and callbackPath config attributes accordingly You can use this processor to obtain the authentication token explicitly.
void	authorizeTicket(MuleMessage message, String ticket) Redirects the browser to box authorization page so that the user can enter his credentials.
CreateFolderResponse	createFolder(MuleMessage message, String parentFolderId, String folderName, Boolean share) Create a new folder
DeleteResponse	delete(MuleMessage message, Target target, String targetId) Deletes a file or folder
byte[]	download(MuleMessage message, String fileId) Downloads a file an returns its contents as a byte[]
String	exportTags(MuleMessage message, String encoding) This processor returns all the user's tags.
String	getApiKey()
String	getCallbackPath()
Integer	getCallbackPort()
GetFileInfoResponse	getFileInfo(MuleMessage message, String fileId) Gets information about a file
Connector	getHttpConnector()
String	getPostAuthFlow()
String	getRestoreAuthTokenFlow()
String	getSaveAuthTokenFlow()
String	getTicket(MuleMessage message, Boolean redirect) Get and access ticket using the configured apiKey.
GetAccountTreeResponse	getTreeStructure(MuleMessage message, String folderId, String csvParams, String encoding) This processor is used to get a user's files and folders tree.
void	init() This method initiaes the box client and the auth callback.
boolean	isUsesCallback()
LogoutResponse	logout(MuleMessage message) Logs out the user associated with the authorization token
String	move(MuleMessage message, Target target, String targetId, String destinationId) This processor moves a file or folder to another folder.
void	onStop()
String	privateShare(MuleMessage muleMessage, Target target, String targetId, String csvMails, Boolean notify, String message) This processor privately shares a file or folder with another user(s).
PublicShareResponse	publicShare(MuleMessage muleMessage, Target target, String targetId, String password, String message) Makes a public share of a file or folder
String	publicUnshare(MuleMessage message, Target target, String targetId) This processor unshares a public shared file or folder
RegisterNewUserResponse	registerNewUser(String email, String password) Create a new user in box.net
String	rename(MuleMessage message, Target target, String targetId, String newName) This processor renames a file or folder.
MuleMessage	saveAuthToken(MuleMessage message, String ticket, String authToken)
void	setApiKey(String apiKey)
void	setCallbackPath(String callbackPath)
void	setCallbackPort(Integer callbackPort)
String	setDescription(MuleMessage message, Target target, String targetId, String description) This processor sets a description to a file or folder.
void	setHttpConnector(Connector httpConnector)
void	setMuleContext(MuleContext context)
void	setPostAuthFlow(String postAuthFlow)
void	setRestoreAuthTokenFlow(String restoreAuthTokenFlow)
void	setSaveAuthTokenFlow(String saveAuthTokenFlow)
void	setUsesCallback(boolean usesCallback)
UploadResponse	uploadFiles(MuleMessage message, List<String> paths, String folderId) Receives a comma separated list of paths and uploads the corresponding files.
UploadResponse	uploadStream(MuleMessage message, String folderId, String filename, InputStream input) Receives an input stream and uploads its content as a file
String	verifyRegistrationEmail(MuleMessage message, String loginName) This method is used to verify user registration email

From class java.lang.Object

From interface org.mule.api.Capabilities

From interface org.mule.api.context.MuleContextAware

Public Constructors

public BoxConnectorCapabilitiesAdapter ()

Public Methods

public boolean isCapableOf (Capability capability)

Returns true if this module implements such capability

Parameters

capability

Classes

BoxConnectorCapabilitiesAdapter

Class Overview

Summary

Public Constructors

public BoxConnectorCapabilitiesAdapter ()

Public Methods

public boolean isCapableOf (Capability capability)

Parameters