com.saperion.ngc.viewer.virtualviewer

Class VirtualViewerContentHandler

java.lang.Object

com.saperion.ngc.viewer.virtualviewer.VirtualViewerContentHandler

All Implemented Interfaces:

com.snowbound.snapserv.servlet.CacheValidator, com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface, com.snowbound.snapserv.servlet.FlexSnapSISaverInterface, FilenameFilter

public class VirtualViewerContentHandler
extends Object
implements com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface, com.snowbound.snapserv.servlet.FlexSnapSISaverInterface, FilenameFilter, com.snowbound.snapserv.servlet.CacheValidator

Server-side component of the client/server variant of VirtualViewer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ANNOTATION_KEY
protected static com.saperion.common.logging.Logger	LOGGER

Fields inherited from interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

PERM_CREATE, PERM_DELETE, PERM_EDIT, PERM_HIDDEN, PERM_PRINT, PERM_PRINT_WATERMARK, PERM_REDACTION, PERM_VIEW, PERM_VIEW_WATERMARK

Constructor Summary

Constructors

Constructor and Description
VirtualViewerContentHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(File dir, String name)
com.snowbound.snapserv.servlet.ContentHandlerResult	deleteAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	eventNotification(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to request the content for the specified annotation key in the form of a byte array.
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationNames(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to request an array of annotation object names for the specified clientInstance and documentKey array.
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationProperties(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to request the properties for a specified annotation layer in the form of a hashtable.
com.snowbound.snapserv.servlet.ContentHandlerResult	getAvailableDocumentIds(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getBookmarkContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to request the content for the specified content key in the form of a byte array.
boolean	hasAnnotations(com.snowbound.snapserv.servlet.ContentHandlerInput input) Returns true if there is annotation content associated with the specified document.
void	init(javax.servlet.ServletConfig config) Performs any necessary configuration tasks.
com.snowbound.snapserv.servlet.ContentHandlerResult	publishDocument(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
protected void	readPrerenderFormats(javax.servlet.ServletConfig config)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to save an annotation layer.
com.snowbound.snapserv.servlet.ContentHandlerResult	saveBookmarkContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentComponents(com.snowbound.snapserv.servlet.ContentHandlerInput input) Called to save all components of a document including the document, annotations, and bookmarks.
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentComponentsAs(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	sendDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
com.snowbound.snapserv.servlet.ContentHandlerResult	validateCache(com.snowbound.snapserv.servlet.ContentHandlerInput contentHandlerInput)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANNOTATION_KEY

public static final String DEFAULT_ANNOTATION_KEY

See Also:

Constant Field Values

LOGGER

protected static final com.saperion.common.logging.Logger LOGGER

Constructor Detail

VirtualViewerContentHandler

public VirtualViewerContentHandler()

Method Detail

accept

public boolean accept(File dir,
             String name)

Specified by:

accept in interface FilenameFilter

See Also:

FilenameFilter.accept(java.io.File, java.lang.String)

publishDocument

public com.snowbound.snapserv.servlet.ContentHandlerResult publishDocument(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                    throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

publishDocument in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

saveAnnotationContent

public com.snowbound.snapserv.servlet.ContentHandlerResult saveAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                          throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Called to save an annotation layer.

Specified by:

saveAnnotationContent in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_HTTP_SERVLET_REQUEST The standard Java HttpServletRequest data.
• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.
• KEY_ANNOTATION_ID (String) The name or ID of the annotation layer.
• KEY_ANNOTATION_CONTENT (byte[]) The annotation data of the document.

Returns:

A ContentHandlerResult object or null. The return value is currently ignored.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

saveBookmarkContent

public com.snowbound.snapserv.servlet.ContentHandlerResult saveBookmarkContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                        throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

saveBookmarkContent in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

saveDocumentComponents

public com.snowbound.snapserv.servlet.ContentHandlerResult saveDocumentComponents(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                           throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Called to save all components of a document including the document, annotations, and bookmarks. This method is invoked by File > Save Document in the applet. Within this method the individual methods saveDocumentContent, saveAnnotationContent and saveBookmarkContent are each typically called to handle saving of each type of content separately. Calling one of those methods alone can cause issues, such as if you have deleted a page and only called saveDocumentContent, the annotations will have an extra page if you do not also save the annotations.

Specified by:

saveDocumentComponents in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_HTTP_SERVLET_REQUEST The standard Java HttpServletRequest object.
• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.
• KEY_DOCUMENT_CONTENT (byte[]) The data of the document.
• KEY_DOCUMENT_FORMAT (Integer) An Integer value indicating the document's format.
• KEY_ANNOTATION_LAYERS (AnnotationLayer[]) The information for all annotation layers.
• KEY_BOOKMARK_CONTENT (byte[]) The XML data for bookmarks.

Returns:

A ContentHandlerResult object containing the following data:

• DOCUMENT_ID_TO_RELOAD (String) The documentId to load after a save is made.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

saveDocumentComponentsAs

public com.snowbound.snapserv.servlet.ContentHandlerResult saveDocumentComponentsAs(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                             throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

saveDocumentComponentsAs in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

saveDocumentContent

public com.snowbound.snapserv.servlet.ContentHandlerResult saveDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                        throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

saveDocumentContent in interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

deleteAnnotation

public com.snowbound.snapserv.servlet.ContentHandlerResult deleteAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                     throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

deleteAnnotation in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

eventNotification

public com.snowbound.snapserv.servlet.ContentHandlerResult eventNotification(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                      throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

eventNotification in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

getAnnotationContent

public com.snowbound.snapserv.servlet.ContentHandlerResult getAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                         throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Called to request the content for the specified annotation key in the form of a byte array.

Specified by:

getAnnotationContent in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.
• KEY_ANNOTATION_ID (String) The name of the annotation layer.

Returns:

A ContentHandlerResult object containing the following data:

• KEY_ANNOTATION_CONTENT (byte[]) The annotation data for a given layer.
• KEY_ANNOTATION_DISPLAY_NAME (String) The display name of the annotation layer.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

getAnnotationNames

public com.snowbound.snapserv.servlet.ContentHandlerResult getAnnotationNames(com.snowbound.snapserv.servlet.ContentHandlerInput input)

Called to request an array of annotation object names for the specified clientInstance and documentKey array.

Specified by:

getAnnotationNames in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.

Returns:

A ContentHandlerResult object containing the following data:

• KEY_ANNOTATION_NAMES (String) The names of all annotation layers.

getAnnotationProperties

public com.snowbound.snapserv.servlet.ContentHandlerResult getAnnotationProperties(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                            throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Called to request the properties for a specified annotation layer in the form of a hashtable.

Specified by:

getAnnotationProperties in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.
• KEY_ANNOTATION_ID (String) The name of the annotation layer.

Returns:

A ContentHandlerResult object containing the following data:

• KEY_ANNOTATION_PROPERTIES (Hashtable) The properties for a given annotation layer.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

getAvailableDocumentIds

public com.snowbound.snapserv.servlet.ContentHandlerResult getAvailableDocumentIds(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                            throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

getAvailableDocumentIds in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

getBookmarkContent

public com.snowbound.snapserv.servlet.ContentHandlerResult getBookmarkContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                       throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

getBookmarkContent in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

getClientPreferencesXML

public com.snowbound.snapserv.servlet.ContentHandlerResult getClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                            throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

getClientPreferencesXML in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

getDocumentContent

public com.snowbound.snapserv.servlet.ContentHandlerResult getDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                       throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Called to request the content for the specified content key in the form of a byte array. For example, The FileRetriever class treats the documentId as a file name, and returns the corresponding contents in the byte array.

Specified by:

getDocumentContent in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_HTTP_SERVLET_REQUEST The standard HttpServletRequest data.
• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.

Returns:

A ContentHandlerResult object containing the following data:

• KEY_DOCUMENT_CONTENT (byte[]) The contents of the document.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

hasAnnotations

public boolean hasAnnotations(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                       throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Returns true if there is annotation content associated with the specified document.

Specified by:

hasAnnotations in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

input - A ContentHandlerInput object containing the following data:

• KEY_CLIENT_INSTANCE_ID (String) Value of the clientInstanceId applet parameter.
• KEY_DOCUMENT_ID (String) The name or ID of the document.

Returns:

True, if there is annotation content associated with the specified document.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

init

public void init(javax.servlet.ServletConfig config)
          throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Performs any necessary configuration tasks.

Specified by:

init in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Parameters:

config - The ServletConfig object for the FlexSnap: SI Servlet.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException - FlexSnapSIAPIException

readPrerenderFormats

protected void readPrerenderFormats(javax.servlet.ServletConfig config)

saveClientPreferencesXML

public com.snowbound.snapserv.servlet.ContentHandlerResult saveClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                             throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

saveClientPreferencesXML in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

sendDocumentContent

public com.snowbound.snapserv.servlet.ContentHandlerResult sendDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
                                                                        throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

sendDocumentContent in interface com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

See Also:

(com.snowbound.snapserv.servlet.ContentHandlerInput)

validateCache

public com.snowbound.snapserv.servlet.ContentHandlerResult validateCache(com.snowbound.snapserv.servlet.ContentHandlerInput contentHandlerInput)

Specified by:

validateCache in interface com.snowbound.snapserv.servlet.CacheValidator