BoxConnector

The url where the user needs to enter his credentials

The API key obtained when registering a project with the Box platform. For more information about this field please refer to http://developers.box.net/

The url where box.net will direct the authentication callback. For more info look at http://developers.box.net/w/page/12923915/ApiAuthentication Defaults to box_auth_callback

The port where the authentication callback will be listening on Defaults to 8080

The http connector to be used when serving the authorization callback. If usesCallback is false then this connector is not used. If not provided, the default http connector will be used. However, specifying an https connector instead is adviced.

The name of a flow to be invoked after an authorization callback is received. If usesCallback is false then this flow will never be invoked. This flow will receive a copy of the current mule message carrying two additional invocation variables:

• boxAuthTicket: The ticket for which the authorization token was generated
• boxAuthToken: The obtained authorization token

The name of a flow to be executed each time the authentication token needs to be used. If this attribute is specified, then a flow with this named will be fetch on the registry and invoked every time the auth token is needed. This flow will receive a copy of the current mule message and must set the payload to a valid auth token. If the flow fails to accomplish that, an exception will be thrown For example: <box:config apiKey="${apiKey}" restoreAuthTokenFlow="restoreTokenFlow" saveAuthTokenFlow="saveTokenFlow"/> <flow name="restoreTokenFlow"> <objectstore:retrieve key="flowVars['currentUserId']"/> </flow> <flow name="save"> <objectstore:store key="flowVars['currentUserId']" value-ref="#[flowVars['boxAuthToken']]"/> </flow> If this attribute is not specified, then the token will be fetched from memory. Notice that this means the token won't survive an application restart and that the connector would be incapable of handling two different concurrent accounts

Actual restore token flow egarly fetched

The name of a flow to be executed each time an authentication token is received. If this attribute is specified, then a flow with this name will be fetch on the registry and invoked every time the auth token is obtained. This flow will receive a copy of the current mule message carrying two additional invocation variables:

• boxAuthTicket: The ticket for which the authorization token was generated
• boxAuthToken: The obtained authorization token

Actual save token flow egarly fetched

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. If this callback is in place, there's no need for you to manually invoke the get-auth-token processor. For more info look at http://developers.box.net/w/page/12923915/ApiAuthentication Defaults to false

This processor adds file or folder to tags list.

After the user authenticates the ticket obtained with the get-ticket processor, there're two ways to get the required auth token:

1. 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
2. You can use this processor to obtain the authentication token explicitly.

Redirects the browser to box authorization page so that the user can enter his credentials. The new location will be https://www.box.net/api/1.0/auth/<<ticket>>

Create a new folder

Deletes a file or folder

Downloads a file an returns its contents as a byte[]

This processor returns all the user's tags. On successful you will get an xml representing the tags that looks like this: music mp3 If the result wasn't successful, status field can be: not_logged_id, application_restricted.

Gets information about a file

Get and access ticket using the configured apiKey. Optionally, you can ask the connector to automatically redirect the browser to box authorization page so that the user can enter his credentials. This is done by invoking org.mule.modules.boxnet.BoxConnector.authorizeTicket(MuleMessage, String) Otherwise, the user needs to manually go to https://www.box.net/api/1.0/auth/<<ticket>> Either way, the connector WILL NOT be responsible for storing this ticket. For more info look at http://developers.box.net/w/page/12923915/ApiAuthentication

This processor is used to get a user's files and folders tree. 'folderId' param defines root folder from which the tree begins. 'csvParams' is comma separated list where you can set additional parameters, which are: onelevel - make a tree of one level depth, so you will get only files and folders stored in folder which folder_id you have provided. nofiles - include folders only in result tree, no files. nozip - do not zip tree xml. On successful result you will receive 'listing_ok' as status and the tree xml. if you haven't set 'nozip' as a parameter (it's set by default), then you have to unzip it. Then you will get xml like this: (note that updatedand createdare UNIX timestamps in PST).

This method initiaes the box client and the auth callback. Also, it fetches the save/restore flows (if specified). If those are specified but don't exist in the registry, then IllegalArgumentException is thrown

Logs out the user associated with the authorization token

This processor moves a file or folder to another folder. On a successful result, status will be 's_move_node'. If the result wasn't successful, status field can be: 'e_move_node', 'not_logged_in', 'application_restricted'.

This processor privately shares a file or folder with another user(s). 'target' param, 'target_id' is . 'emails' params is an array of emails of users' to share files with. if 'notify' param is , 'message' param . Note: currently only files can be shared privately.

Makes a public share of a file or folder

This processor unshares a public shared file or folder

Create a new user in box.net

This processor renames a file or folder.

This processor sets a description to a file or folder.

Receives a comma separated list of paths and uploads the corresponding files.

Receives an input stream and uploads its content as a file

This method is used to verify user registration email