com.saperion.ngc.viewer.virtualviewer

Class AbstractContentHandler

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

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

Direct Known Subclasses:

VirtualViewerHTML5ContentHandler

public abstract class AbstractContentHandler
extends DummyContentHandler
implements com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface, FilenameFilter, com.snowbound.snapserv.servlet.CacheValidator

This class contains common methods for VirtualViewer content handler implementations.

Author:

cmerkel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractContentHandler.BeanNotFoundException
protected static class	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 String	DEFAULT_ANNOTATION_KEY
protected javax.servlet.ServletContext	servletContext
protected boolean	useRenderEngine
protected boolean	useViewerSessionMap
protected boolean	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
AbstractContentHandler()

Method Summary

Modifier and Type	Method and Description
boolean	accept(File dir, String name)
protected com.snowbound.snapserv.servlet.ContentHandlerInput	convertToContentHandlerInput(com.snowbound.clientcontentserver.BasicContentHandlerInput input) Creates ContentHandlerInput from BasicContentHandlerInput
protected byte[]	convertTxtToPdfIfRequired(byte[] original, String filename)
com.snowbound.snapserv.servlet.ContentHandlerResult	deleteAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
protected boolean	documentCanBeRendered(byte[] documentBytes, OpenDocumentBean bean)
com.snowbound.snapserv.servlet.ContentHandlerResult	eventNotification(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationContentInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input, OpenDocumentBean openDocumentBean)
protected com.snowbound.snapserv.servlet.ContentHandlerResult	getAnnotationNamesInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected Map<String,Object>	getAnnotationPropertiesInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getAvailableDocumentIds(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	getBookmarkContent(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected com.snowbound.snapserv.servlet.ContentHandlerResult	getClientPreferencesXmlInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected byte[]	getDocumentBytes(OpenDocumentBean openDocumentBean, javax.servlet.http.HttpSession session, String currentFilename)
protected abstract String	getHdocFromContentHandlerInput(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected String	getIniAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected String	getIXOSAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected OpenDocumentBean	getOpenDocumentBean(com.snowbound.snapserv.servlet.ContentHandlerInput input)
protected int	getPageFileNumber(String fileName)
protected javax.servlet.http.HttpSession	getSession(com.snowbound.snapserv.servlet.ContentHandlerInput input, boolean allowFallback)
protected byte[]	getTemporaryDocumentBytes(TemporaryDocumentId id)
protected boolean	handleIXOSFiles(com.snowbound.snapserv.servlet.ContentHandlerInput input, OpenDocumentBean openDocumentBean, javax.servlet.http.HttpSession session, DocumentService docService)
boolean	hasAnnotations(com.snowbound.clientcontentserver.BasicContentHandlerInput basicContentHandlerInput)
protected boolean	isPageFile(String fileName)
protected void	readPrecheckFormats(javax.servlet.ServletConfig config)
protected void	readPrerenderFormats(javax.servlet.ServletConfig config)
protected void	saveAnnotationContentInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveClientPreferencesXML(com.snowbound.snapserv.servlet.ContentHandlerInput input) Deprecated.
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentComponentsAs(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
protected com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentComponentsInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input, OpenDocumentBean openDocumentBean)
com.snowbound.snapserv.servlet.ContentHandlerResult	saveDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
protected boolean	securityCheck(com.snowbound.snapserv.servlet.ContentHandlerInput contentHandlerInput)
com.snowbound.snapserv.servlet.ContentHandlerResult	sendDocumentContent(com.snowbound.snapserv.servlet.ContentHandlerInput arg0)
protected void	setErrorFlagInBean(OpenDocumentBean bean)
com.snowbound.snapserv.servlet.ContentHandlerResult	validateCache(com.snowbound.snapserv.servlet.ContentHandlerInput contentHandlerInput)

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 com.snowbound.snapserv.servlet.FlexSnapSIContentHandlerInterface

getAnnotationContent, getAnnotationNames, getAnnotationProperties, getDocumentContent, init

Methods inherited from interface com.snowbound.snapserv.servlet.FlexSnapSISaverInterface

saveAnnotationContent, saveDocumentComponents

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

DEFAULT_ANNOTATION_KEY

protected static final String DEFAULT_ANNOTATION_KEY

See Also:

Constant Field Values

servletContext

protected javax.servlet.ServletContext servletContext

useRenderEngine

protected boolean useRenderEngine

useViewerSessionMap

protected boolean useViewerSessionMap

vectorPDF

protected boolean vectorPDF

Constructor Detail

AbstractContentHandler

public AbstractContentHandler()

Method Detail

accept

public boolean accept(File dir,
                      String name)

Specified by:

accept in interface FilenameFilter

saveDocumentComponentsAs

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

saveDocumentContent

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

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

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

eventNotification

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

Specified by:

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

Throws:

com.snowbound.snapserv.servlet.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

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

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

validateCache

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

Specified by:

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

hasAnnotations

public boolean hasAnnotations(com.snowbound.clientcontentserver.BasicContentHandlerInput basicContentHandlerInput)
                       throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Specified by:

hasAnnotations in interface com.snowbound.clientcontentserver.BasicContentHandlerInterface

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

saveClientPreferencesXML

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

Deprecated.

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

saveAnnotationContentInternal

protected void saveAnnotationContentInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                      throws AbstractContentHandler.SessionNotFoundException,
                                             AbstractContentHandler.BeanNotFoundException,
                                             com.snowbound.snapserv.servlet.FlexSnapSIAPIException,
                                             JAXBException,
                                             SAXException,
                                             AuthenticationException,
                                             SystemException,
                                             ConvertAnnotationException,
                                             DocumentAccessException

Throws:

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

JAXBException

SAXException

AuthenticationException

SystemException

ConvertAnnotationException

DocumentAccessException

handleIXOSFiles

protected boolean handleIXOSFiles(com.snowbound.snapserv.servlet.ContentHandlerInput input,
                                  OpenDocumentBean openDocumentBean,
                                  javax.servlet.http.HttpSession session,
                                  DocumentService docService)
                           throws AuthenticationException,
                                  SystemException,
                                  AbstractContentHandler.SessionNotFoundException,
                                  AbstractContentHandler.BeanNotFoundException,
                                  ConvertAnnotationException,
                                  JAXBException,
                                  SAXException

Throws:

AuthenticationException

SystemException

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

ConvertAnnotationException

JAXBException

SAXException

isPageFile

protected boolean isPageFile(String fileName)

getPageFileNumber

protected int getPageFileNumber(String fileName)

getIniAnnotation

protected String getIniAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                           throws AuthenticationException,
                                  SystemException,
                                  AbstractContentHandler.SessionNotFoundException,
                                  AbstractContentHandler.BeanNotFoundException

Throws:

AuthenticationException

SystemException

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

getIXOSAnnotation

protected String getIXOSAnnotation(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                            throws AuthenticationException,
                                   SystemException,
                                   AbstractContentHandler.SessionNotFoundException,
                                   AbstractContentHandler.BeanNotFoundException

Throws:

AuthenticationException

SystemException

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

getAnnotationContentInternal

protected com.snowbound.snapserv.servlet.ContentHandlerResult getAnnotationContentInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input,
                                                                                           OpenDocumentBean openDocumentBean)
                                                                                    throws AbstractContentHandler.SessionNotFoundException,
                                                                                           AuthenticationException,
                                                                                           SystemException,
                                                                                           AbstractContentHandler.BeanNotFoundException,
                                                                                           ConvertAnnotationException

Throws:

AbstractContentHandler.SessionNotFoundException

AuthenticationException

SystemException

AbstractContentHandler.BeanNotFoundException

ConvertAnnotationException

getAnnotationNamesInternal

protected com.snowbound.snapserv.servlet.ContentHandlerResult getAnnotationNamesInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                                                  throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

saveDocumentComponentsInternal

protected com.snowbound.snapserv.servlet.ContentHandlerResult saveDocumentComponentsInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input,
                                                                                             OpenDocumentBean openDocumentBean)
                                                                                      throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

getClientPreferencesXmlInternal

protected com.snowbound.snapserv.servlet.ContentHandlerResult getClientPreferencesXmlInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)

getAnnotationPropertiesInternal

protected Map<String,Object> getAnnotationPropertiesInternal(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                                      throws com.snowbound.snapserv.servlet.FlexSnapSIAPIException,
                                                             AbstractContentHandler.BeanNotFoundException,
                                                             AbstractContentHandler.SessionNotFoundException,
                                                             AuthenticationException,
                                                             SystemException

Throws:

com.snowbound.snapserv.servlet.FlexSnapSIAPIException

AbstractContentHandler.BeanNotFoundException

AbstractContentHandler.SessionNotFoundException

AuthenticationException

SystemException

getDocumentBytes

protected byte[] getDocumentBytes(OpenDocumentBean openDocumentBean,
                                  javax.servlet.http.HttpSession session,
                                  String currentFilename)
                           throws Exception

Throws:

Exception

getTemporaryDocumentBytes

protected byte[] getTemporaryDocumentBytes(TemporaryDocumentId id)
                                    throws Exception

Throws:

Exception

convertTxtToPdfIfRequired

protected byte[] convertTxtToPdfIfRequired(byte[] original,
                                           String filename)

documentCanBeRendered

protected boolean documentCanBeRendered(byte[] documentBytes,
                                        OpenDocumentBean bean)

readPrecheckFormats

protected void readPrecheckFormats(javax.servlet.ServletConfig config)

readPrerenderFormats

protected void readPrerenderFormats(javax.servlet.ServletConfig config)

getSession

protected javax.servlet.http.HttpSession getSession(com.snowbound.snapserv.servlet.ContentHandlerInput input,
                                                    boolean allowFallback)
                                             throws AbstractContentHandler.SessionNotFoundException

Throws:

AbstractContentHandler.SessionNotFoundException

getOpenDocumentBean

protected OpenDocumentBean getOpenDocumentBean(com.snowbound.snapserv.servlet.ContentHandlerInput input)
                                        throws AbstractContentHandler.SessionNotFoundException,
                                               AbstractContentHandler.BeanNotFoundException

Throws:

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

securityCheck

protected boolean securityCheck(com.snowbound.snapserv.servlet.ContentHandlerInput contentHandlerInput)

getHdocFromContentHandlerInput

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

setErrorFlagInBean

protected void setErrorFlagInBean(OpenDocumentBean bean)

convertToContentHandlerInput

protected com.snowbound.snapserv.servlet.ContentHandlerInput convertToContentHandlerInput(com.snowbound.clientcontentserver.BasicContentHandlerInput input)

Creates ContentHandlerInput from BasicContentHandlerInput

Parameters:

input - instance of type BasicContentHandlerInput

Returns:

instance of ContentHandlerInput