com.saperion.ngc.viewer.virtualviewer.html5

Class VirtualViewerHTML5ContentHandler

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.snowbound.snapserv.servlet.ContentHandlerResult

com.saperion.ngc.viewer.virtualviewer.DummyContentHandler

com.saperion.ngc.viewer.virtualviewer.AbstractContentHandler

com.saperion.ngc.viewer.virtualviewer.html5.VirtualViewerHTML5ContentHandler

All Implemented Interfaces:

com.snowbound.clientcontentserver.BasicContentHandlerInterface, com.snowbound.clientcontentserver.FlexSnapSISaverInterface, com.snowbound.snapserv.servlet.CacheValidator, com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface, FilenameFilter, Serializable, Cloneable, Map

public class VirtualViewerHTML5ContentHandler
extends AbstractContentHandler

Server-side component of the HTML5 variant of VirtualViewer.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.saperion.ngc.viewer.virtualviewer.AbstractContentHandler

AbstractContentHandler.BeanNotFoundException, AbstractContentHandler.SessionNotFoundException

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

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

Fields inherited from class com.saperion.ngc.viewer.virtualviewer.AbstractContentHandler

DEFAULT_ANNOTATION_KEY, servletContext, useRenderEngine, useViewerSessionMap, vectorPDF

Fields inherited from class com.snowbound.snapserv.servlet.ContentHandlerResult

DOCUMENT_ID_TO_RELOAD, ERROR_MESSAGE, KEY_ALL_ANNOTATIONS_HASH, KEY_ANNOTATION_CONTENT, KEY_ANNOTATION_CREATED_DATE, KEY_ANNOTATION_DELETABLE, KEY_ANNOTATION_DISPLAY_NAME, KEY_ANNOTATION_ID, KEY_ANNOTATION_IMAGE_DOCUMENT_ID, KEY_ANNOTATION_NAMES, KEY_ANNOTATION_OWNER, KEY_ANNOTATION_PERMISSION, KEY_ANNOTATION_PROPERTIES, KEY_ANNOTATION_SESSION_ID, KEY_AVAILABLE_DISPLAY_NAMES, KEY_AVAILABLE_DOCUMENT_IDS, KEY_BOOKMARK_CONTENT, KEY_CLIENT_INSTANCE_ID, KEY_CLIENT_PREFERENCES_XML, KEY_CURRENT_USER_NAME, KEY_DOCUMENT_CONTENT, KEY_DOCUMENT_CONTENT_ELEMENTS, KEY_DOCUMENT_DISPLAY_NAME, KEY_DOCUMENT_FILE, KEY_DOCUMENT_ID, KEY_DOCUMENT_INPUT_STREAM, KEY_DOCUMENT_SPARSE_ELEMENTS, KEY_DOCUMENT_SPARSE_PAGE_INDEX, KEY_DOCUMENT_SPARSE_RETURN_PAGE_COUNT, KEY_DOCUMENT_SPARSE_TOTAL_PAGE_COUNT, KEY_EVENT, KEY_EVENT_EXPORT_FORMAT_NAME, KEY_EVENT_PAGE_REQUESTED_NUMBER, KEY_EVENT_PRINT_PAGE_NUMBERS, KEY_EVENT_ROTATE_DEGREES, KEY_EVENT_ROTATE_PAGE, KEY_EVENT_SAVE_ANNOTATION_LAYER_NAME_BASE, KEY_EXTERNAL_REFERENCE_CONTENT_ELEMENTS, KEY_METADATA_HASHTABLE, KEY_NOTES_CONTENT, KEY_NOTES_PERMISSIONS, KEY_NOTES_TEMPLATES, KEY_PUBLISH_STATUS, KEY_RETRIEVED_EXTERNAL_REFERENCES, KEY_USE_OF_CACHE_ALLOWED, KEY_USERS_AND_GROUPS, KEY_WATERMARK_CONTENT, VALUE_EVENT_CLOSE_DOCUMENT, VALUE_EVENT_DOCUMENT_RETRIEVED_FROM_CACHE, VALUE_EVENT_EXPORT, VALUE_EVENT_PAGE_REQUESTED, VALUE_EVENT_PRINT, VALUE_EVENT_ROTATE_DEGREES, VALUE_EVENT_ROTATE_PAGE, VALUE_EVENT_SAVE_ANNOTATION, VALUE_EVENT_SAVE_DOCUMENT, VALUE_FALSE, VALUE_PUBLISH_ERROR, VALUE_PUBLISH_SUCCESS, VALUE_TRUE, VOID

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

Fields inherited from interface com.snowbound.clientcontentserver.BasicContentHandlerInterface

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
VirtualViewerHTML5ContentHandler()

Method Summary

Modifier and Type	Method and Description
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationNames(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationProperties(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input) Deprecated.
com.snowbound.snapserv.servlet.ContentHandlerResult	getDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput input) Snowbound uses this method get the file content that needs to be displayed
protected String	getHdocFromContentHandlerInput(com.snowbound.snapserv.servlet.ContentHandlerInput input)
void	init(javax.servlet.ServletConfig config)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveAnnotationContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentComponents(com.snowbound.snapserv.servlet.ContentHandlerInput input)

Methods inherited from class com.saperion.ngc.viewer.virtualviewer.AbstractContentHandler

accept, convertToContentHandlerInput, convertTxtToPdfIfRequired, deleteAnnotation, documentCanBeRendered, eventNotification, getAnnotationContentInternal, getAnnotationNamesInternal, getAnnotationPropertiesInternal, getAvailableDocumentIds, getBookmarkContent, getClientPreferencesXmlInternal, getDocumentBytes, getIniAnnotation, getIXOSAnnotation, getOpenDocumentBean, getPageFileNumber, getSession, getTemporaryDocumentBytes, handleIXOSFiles, hasAnnotations, isPageFile, readPrecheckFormats, readPrerenderFormats, saveAnnotationContentInternal, saveClientPreferencesXML, saveDocumentComponentsAs, saveDocumentComponentsInternal, saveDocumentContent, securityCheck, sendDocumentContent, setErrorFlagInBean, validateCache

Methods inherited from class com.saperion.ngc.viewer.virtualviewer.DummyContentHandler

createDocument, deleteAnnotation, eventNotification, getAnnotationContent, getAnnotationNames, getAnnotationProperties, getAvailableDocumentIds, getBookmarkContent, getDocumentContent, getWatermarkContent, saveAnnotationContent, saveBookmarkContent, saveDocumentComponents, saveDocumentComponentsAs, saveDocumentContent, sendDocumentContent

Methods inherited from class com.snowbound.snapserv.servlet.ContentHandlerResult

getAnnotationContent, getAnnotationNames, getAnnotationProperties, getAvailableDisplayNames, getAvailableDocumentIds, getBookmarkContent, getClientPreferencesXML, getDocumentContent, getDocumentContentElements, getDocumentFile, getDocumentSparseElements, getDocumentStream, getNotesContent, getNotesPermissionLevel, getNotesTemplates, getWatermarkContent, hasDocumentContent, isError

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

LOGGER

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

Constructor Detail

VirtualViewerHTML5ContentHandler

public VirtualViewerHTML5ContentHandler()

Method Detail

saveAnnotationContent

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

saveDocumentComponents

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getAnnotationContent

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getAnnotationNames

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getAnnotationProperties

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getClientPreferencesXML

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

Deprecated.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getDocumentContent

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

Snowbound uses this method get the file content that needs to be displayed

Parameters:

input - The file input

Returns:

An instance of ContentHandlerResult with file content

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

init

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getHdocFromContentHandlerInput

protected String getHdocFromContentHandlerInput(com.snowbound.snapserv.servlet.ContentHandlerInput input)

Specified by:

getHdocFromContentHandlerInput in class AbstractContentHandler