Package com.snowbound.contenthandler.interfaces

Interface CreateDocumentInterface

All Known Implementing Classes:

FileContentHandler, RestfulHttpContentHandler

public interface CreateDocumentInterface

Allows a user to upload a document through the client interface.

Method Summary

Modifier and Type	Method	Description
ContentHandlerResult	createDocument(ContentHandlerInput input)

Method Detail

createDocument

ContentHandlerResult createDocument(ContentHandlerInput input)
                             throws VirtualViewerAPIException

Parameters:

input - ContentHandlerInput containing the following values:

Every row is an expected value in the ContentHandlerInput. The first column is the string key for the value. The second column is the type of the value. The third column is the detailed description of the value.

Key	Type	Description
KEY_DOCUMENT_CONTENT	byte[]	The new document's data to be saved. Can be retrieved with byte[] data = input.getDocumentContent(); .
KEY_DOCUMENT_ID	java.lang.String	The key the new document should be saved under. Can be retrieved with String documentId = input.getDocumentId(); .
KEY_CLIENT_INSTANCE_ID	java.lang.String	Custom configurable value used to pass data from client to content handler. If not set then will be the session ID. Can be retrieved with String clientInstanceId = input.getClientInstanceId();
KEY_HTTP_SERVLET_REQUEST	javax.servlet.http.HttpServletRequest	Request that called this method. Can be retrieved with HttpServletRequest request = input.getHttpServletRequest();

Returns:

ContentHandlerResult with no values currently expected.

Throws:

VirtualViewerAPIException - if content handler throws exception