com.ibm.ecm.extension

Class BoxPluginServiceCallbacks

java.lang.Object

com.ibm.ecm.extension.BoxPluginServiceCallbacks

public class BoxPluginServiceCallbacks
extends java.lang.Object

Provides a plug-in service with access to the application programming interface (API) of the underlying server and the location of the configuration information for the plug-in.

Method Summary

Modifier and Type	Method and Description
com.box.sdk.BoxAPIConnection	getBoxConnection(java.lang.String repositoryId) Returns a BoxAPIConnection for the given repository.
com.box.sdk.BoxFile	getBoxDocument(java.lang.String repositoryId, java.lang.String documentId, boolean verify) Retrieves a Box document.

Methods inherited from class java.lang.Object

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

Method Detail

getBoxConnection

public com.box.sdk.BoxAPIConnection getBoxConnection(java.lang.String repositoryId)

Returns a BoxAPIConnection for the given repository.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

Returns:

A com.box.sdk.BoxAPIConnection object that provides a connection to the Box repository. If the server is not found, this method returns null.

getBoxDocument

public com.box.sdk.BoxFile getBoxDocument(java.lang.String repositoryId,
                                          java.lang.String documentId,
                                          boolean verify)

Retrieves a Box document.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

verify - A flag indicating whether or not the document existence should be confirmed when making this call. If false, the returned object is a placeholder representing the specified documentId, and may not necessarily represent an existing accessible document.

Returns: