com.saperion.ngc.viewer.virtualviewer

Class AbstractContentHandler

java.lang.Object

com.saperion.ngc.viewer.virtualviewer.AbstractContentHandler

All Implemented Interfaces:

com.snowbound.contenthandler.interfaces.AnnotationsInterface, com.snowbound.contenthandler.interfaces.AvailableDocumentsInterface, com.snowbound.contenthandler.interfaces.CacheValidator, com.snowbound.contenthandler.interfaces.EventSubscriberInterface, com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface, FilenameFilter

Direct Known Subclasses:

VirtualViewerHTML5ContentHandler

public abstract class AbstractContentHandler
extends Object
implements com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface, com.snowbound.contenthandler.interfaces.AvailableDocumentsInterface, com.snowbound.contenthandler.interfaces.AnnotationsInterface, com.snowbound.contenthandler.interfaces.EventSubscriberInterface, com.snowbound.contenthandler.interfaces.CacheValidator, FilenameFilter

This class contains common methods for VirtualViewer content handler implementations.

Author:

cmerkel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractContentHandler.BeanNotFoundException
protected static class	AbstractContentHandler.SessionNotFoundException

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 interface com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface

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 byte[]	convertTxtToPdfIfRequired(byte[] original, String filename)
com.snowbound.contenthandler.ContentHandlerResult	deleteAnnotation(com.snowbound.contenthandler.ContentHandlerInput arg0)
protected boolean	documentCanBeRendered(byte[] documentBytes, OpenDocumentBean bean)
com.snowbound.contenthandler.ContentHandlerResult	eventNotification(com.snowbound.contenthandler.ContentHandlerInput input)
protected com.snowbound.contenthandler.ContentHandlerResult	getAnnotationContentInternal(com.snowbound.contenthandler.ContentHandlerInput input, OpenDocumentBean openDocumentBean)
protected com.snowbound.contenthandler.ContentHandlerResult	getAnnotationNamesInternal(com.snowbound.contenthandler.ContentHandlerInput input)
protected Hashtable	getAnnotationPropertiesInternal(com.snowbound.contenthandler.ContentHandlerInput input)
com.snowbound.contenthandler.ContentHandlerResult	getAvailableDocumentIds(com.snowbound.contenthandler.ContentHandlerInput input)
protected com.snowbound.contenthandler.ContentHandlerResult	getClientPreferencesXmlInternal(com.snowbound.contenthandler.ContentHandlerInput input)
protected byte[]	getDocumentBytes(OpenDocumentBean openDocumentBean, javax.servlet.http.HttpSession session, String currentFilename)
protected abstract String	getHdocFromContentHandlerInput(com.snowbound.contenthandler.ContentHandlerInput input)
protected String	getIniAnnotation(com.snowbound.contenthandler.ContentHandlerInput input)
protected String	getIXOSAnnotation(com.snowbound.contenthandler.ContentHandlerInput input)
protected OpenDocumentBean	getOpenDocumentBean(com.snowbound.contenthandler.ContentHandlerInput input)
protected int	getPageFileNumber(String fileName)
protected javax.servlet.http.HttpSession	getSession(com.snowbound.contenthandler.ContentHandlerInput input, boolean allowFallback)
protected byte[]	getTemporaryDocumentBytes(TemporaryDocumentId id)
protected boolean	handleIXOSFiles(com.snowbound.contenthandler.ContentHandlerInput input, OpenDocumentBean openDocumentBean, javax.servlet.http.HttpSession session, DocumentService docService)
boolean	hasAnnotations(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)
protected boolean	isPageFile(String fileName)
protected void	readPrecheckFormats(javax.servlet.ServletConfig config)
protected void	readPrerenderFormats(javax.servlet.ServletConfig config)
protected void	saveAnnotationContentInternal(com.snowbound.contenthandler.ContentHandlerInput input)
com.snowbound.contenthandler.ContentHandlerResult	saveClientPreferencesXML(com.snowbound.contenthandler.ContentHandlerInput input) Deprecated.
com.snowbound.contenthandler.ContentHandlerResult	saveDocumentComponentsAs(com.snowbound.contenthandler.ContentHandlerInput arg0)
protected com.snowbound.contenthandler.ContentHandlerResult	saveDocumentComponentsInternal(com.snowbound.contenthandler.ContentHandlerInput input, OpenDocumentBean openDocumentBean)
com.snowbound.contenthandler.ContentHandlerResult	saveDocumentContent(com.snowbound.contenthandler.ContentHandlerInput arg0)
protected boolean	securityCheck(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)
protected void	setErrorFlagInBean(OpenDocumentBean bean)
com.snowbound.contenthandler.ContentHandlerResult	validateCache(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface

getDocumentContent, init, saveDocumentComponents

Methods inherited from interface com.snowbound.contenthandler.interfaces.AnnotationsInterface

getAnnotationContent, getAnnotationNames, getAnnotationProperties, saveAnnotationContent

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.contenthandler.ContentHandlerResult saveDocumentComponentsAs(com.snowbound.contenthandler.ContentHandlerInput arg0)
                                                                           throws com.snowbound.contenthandler.VirtualViewerAPIException

Specified by:

saveDocumentComponentsAs in interface com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

saveDocumentContent

public com.snowbound.contenthandler.ContentHandlerResult saveDocumentContent(com.snowbound.contenthandler.ContentHandlerInput arg0)
                                                                      throws com.snowbound.contenthandler.VirtualViewerAPIException

Specified by:

saveDocumentContent in interface com.snowbound.contenthandler.interfaces.VirtualViewerContentHandlerInterface

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

deleteAnnotation

public com.snowbound.contenthandler.ContentHandlerResult deleteAnnotation(com.snowbound.contenthandler.ContentHandlerInput arg0)
                                                                   throws com.snowbound.contenthandler.VirtualViewerAPIException

Specified by:

deleteAnnotation in interface com.snowbound.contenthandler.interfaces.AnnotationsInterface

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

eventNotification

public com.snowbound.contenthandler.ContentHandlerResult eventNotification(com.snowbound.contenthandler.ContentHandlerInput input)
                                                                    throws com.snowbound.contenthandler.VirtualViewerAPIException

Specified by:

eventNotification in interface com.snowbound.contenthandler.interfaces.EventSubscriberInterface

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

getAvailableDocumentIds

public com.snowbound.contenthandler.ContentHandlerResult getAvailableDocumentIds(com.snowbound.contenthandler.ContentHandlerInput input)
                                                                          throws com.snowbound.contenthandler.VirtualViewerAPIException

Specified by:

getAvailableDocumentIds in interface com.snowbound.contenthandler.interfaces.AvailableDocumentsInterface

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

validateCache

public com.snowbound.contenthandler.ContentHandlerResult validateCache(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)

Specified by:

validateCache in interface com.snowbound.contenthandler.interfaces.CacheValidator

hasAnnotations

public boolean hasAnnotations(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)
                       throws com.snowbound.contenthandler.VirtualViewerAPIException

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

saveClientPreferencesXML

@Deprecated
public com.snowbound.contenthandler.ContentHandlerResult saveClientPreferencesXML(com.snowbound.contenthandler.ContentHandlerInput input)
                                                                                        throws com.snowbound.contenthandler.VirtualViewerAPIException

Deprecated.

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

saveAnnotationContentInternal

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

Throws:

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

com.snowbound.contenthandler.VirtualViewerAPIException

JAXBException

SAXException

AuthenticationException

SystemException

ConvertAnnotationException

DocumentAccessException

handleIXOSFiles

protected boolean handleIXOSFiles(com.snowbound.contenthandler.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.contenthandler.ContentHandlerInput input)
                           throws AuthenticationException,
                                  SystemException,
                                  AbstractContentHandler.SessionNotFoundException,
                                  AbstractContentHandler.BeanNotFoundException

Throws:

AuthenticationException

SystemException

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

getIXOSAnnotation

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

Throws:

AuthenticationException

SystemException

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

getAnnotationContentInternal

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

Throws:

AbstractContentHandler.SessionNotFoundException

AuthenticationException

SystemException

AbstractContentHandler.BeanNotFoundException

ConvertAnnotationException

getAnnotationNamesInternal

protected com.snowbound.contenthandler.ContentHandlerResult getAnnotationNamesInternal(com.snowbound.contenthandler.ContentHandlerInput input)
                                                                                throws com.snowbound.contenthandler.VirtualViewerAPIException

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

saveDocumentComponentsInternal

protected com.snowbound.contenthandler.ContentHandlerResult saveDocumentComponentsInternal(com.snowbound.contenthandler.ContentHandlerInput input,
                                                                                           OpenDocumentBean openDocumentBean)
                                                                                    throws com.snowbound.contenthandler.VirtualViewerAPIException

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

getClientPreferencesXmlInternal

protected com.snowbound.contenthandler.ContentHandlerResult getClientPreferencesXmlInternal(com.snowbound.contenthandler.ContentHandlerInput input)

getAnnotationPropertiesInternal

protected Hashtable getAnnotationPropertiesInternal(com.snowbound.contenthandler.ContentHandlerInput input)
                                             throws com.snowbound.contenthandler.VirtualViewerAPIException,
                                                    AbstractContentHandler.BeanNotFoundException,
                                                    AbstractContentHandler.SessionNotFoundException,
                                                    AuthenticationException,
                                                    SystemException

Throws:

com.snowbound.contenthandler.VirtualViewerAPIException

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.contenthandler.ContentHandlerInput input,
                                                    boolean allowFallback)
                                             throws AbstractContentHandler.SessionNotFoundException

Throws:

AbstractContentHandler.SessionNotFoundException

getOpenDocumentBean

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

Throws:

AbstractContentHandler.SessionNotFoundException

AbstractContentHandler.BeanNotFoundException

securityCheck

protected boolean securityCheck(com.snowbound.contenthandler.ContentHandlerInput contentHandlerInput)

getHdocFromContentHandlerInput

protected abstract String getHdocFromContentHandlerInput(com.snowbound.contenthandler.ContentHandlerInput input)

setErrorFlagInBean

protected void setErrorFlagInBean(OpenDocumentBean bean)