Uses of Class
com.snowbound.contenthandler.VirtualViewerAPIException

Packages that use VirtualViewerAPIException

Package	Description
com.snowbound.common.utils	Utility classes that may be used in the content handler.
com.snowbound.contenthandler.example	Demonstration content handlers, including the default FileContentHandler.
com.snowbound.contenthandler.interfaces	Interfaces that can be used to add features to a content handler.
com.snowbound.contenthandler.rest

Uses of VirtualViewerAPIException in com.snowbound.common.utils

Methods in com.snowbound.common.utils that throw VirtualViewerAPIException

Modifier and Type	Method	Description
int[]	RasterMaster.getPagesWithPattern(java.io.DataInputStream pdfInputStream, java.lang.String searchPattern)
int[]	RasterMaster.getPagesWithText(java.io.DataInputStream pdfInputStream, java.lang.String searchString)
byte[]	RasterMaster.IMGLOW_ocr_bitmap(byte[] inBuffer)	Convert raster buffer to vector pdf buffer.

Uses of VirtualViewerAPIException in com.snowbound.contenthandler.example

Methods in com.snowbound.contenthandler.example that throw VirtualViewerAPIException

Modifier and Type	Method	Description
ContentHandlerResult	FileContentHandler.checkAvailable(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.createDocument(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.deleteAnnotation(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.deleteBookmarkContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.deleteNotesContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.deleteWatermarkContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.eventNotification(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAllAnnotationsForDocument(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAnnotationContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAnnotationContentFromFile(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAnnotationNames(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAnnotationProperties(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getAvailableDocumentIds(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getBookmarkContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getDocumentContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getDocumentContentByFile(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getNotesContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getOCRDataForDocument(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getOCRDataOnPerformOCR(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.getWatermarkContent(ContentHandlerInput input)
void	FileContentHandler.init(javax.servlet.ServletConfig config)
ContentHandlerResult	FileContentHandler.saveAnnotationContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.saveAnnotationContent(javax.servlet.http.HttpServletRequest request, java.lang.String clientInstanceId, java.lang.String documentKey, java.lang.String annotationKey, int pageSpecificIndex, byte[] data, java.util.Map annProperties)
ContentHandlerResult	FileContentHandler.saveDocumentComponents(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.saveDocumentComponentsAs(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.saveDocumentContent(ContentHandlerInput input)
ContentHandlerResult	FileContentHandler.sendDocumentContent(ContentHandlerInput input)

Uses of VirtualViewerAPIException in com.snowbound.contenthandler.interfaces

Methods in com.snowbound.contenthandler.interfaces that throw VirtualViewerAPIException

Modifier and Type	Method	Description
ContentHandlerResult	HealthCheckInterface.checkAvailable(ContentHandlerInput input)	Returns null, or an empty ContentHandlerResult for a successful "healthy" result, or throws a VirtualViewerAPIException for an "unhealthy" result.
ContentHandlerResult	CreateDocumentInterface.createDocument(ContentHandlerInput input)
ContentHandlerResult	AnnotationsInterface.deleteAnnotation(ContentHandlerInput input)	Called when the client has requested to delete the specified annotation layer.
ContentHandlerResult	BookmarksInterface.deleteBookmarkContent(ContentHandlerInput input)	Delete the bookmark XML content for the specified document key, if it exists.
ContentHandlerResult	DocumentNotesInterface.deleteNotesContent(ContentHandlerInput input)	Called when the client has requested to delete all notes for the specified document.
ContentHandlerResult	WatermarksInterface.deleteWatermarkContent(ContentHandlerInput input)	Delete the watermark content for the specified document key, if it exists.
ContentHandlerResult	EventSubscriberInterface.eventNotification(ContentHandlerInput input)	This method is called when some events occur in the VirtualViewer client, such as opening a document or viewing a new page on the document.
ContentHandlerResult	AllAnnotationsInterface.getAllAnnotationsForDocument(ContentHandlerInput input)	Returns a map of all of the annotations for a specified document key.
ContentHandlerResult	AnnotationsInterface.getAnnotationContent(ContentHandlerInput input)	Returns the content for the specified annotation layer and document key in the form of a byte array.
ContentHandlerResult	AnnotationsInterface.getAnnotationNames(ContentHandlerInput input)	Returns an array of annotation layer names for the specified document key and client instance key.
ContentHandlerResult	AnnotationsInterface.getAnnotationProperties(ContentHandlerInput input)	Returns the properties for a specified annotation layer key in the form of a hashtable.
ContentHandlerResult	AvailableDocumentsInterface.getAvailableDocumentIds(ContentHandlerInput input)	Returns an array containing the set of document keys available for viewing.
ContentHandlerResult	BookmarksInterface.getBookmarkContent(ContentHandlerInput input)	Returns the bookmark XML content for the specified document key in the form of a byte array.
ContentHandlerResult	VirtualViewerContentHandlerInterface.getDocumentContent(ContentHandlerInput input)	Returns the content for the specified document key.
ContentHandlerResult	DocumentNotesInterface.getNotesContent(ContentHandlerInput input)	Returns the contents of the document notes XML file for the specified document key in the form of a byte array.
ContentHandlerResult	OCRDataProviderInterface.getOCRDataForDocument(ContentHandlerInput input)	Returns a JSON file, passed as a byte array, of OCRed text data for a document.
ContentHandlerResult	OCRDataProviderInterface.getOCRDataOnPerformOCR(ContentHandlerInput input)	Returns a JSON file, passed as a byte array, of OCRed text data for a document.
ContentHandlerResult	WatermarksInterface.getWatermarkContent(ContentHandlerInput input)	Returns the watermark file for the specified document key in the form of a byte array.
void	VirtualViewerContentHandlerInterface.init(javax.servlet.ServletConfig config)	Used to set up each content handler instance before any methods are called.
ContentHandlerResult	AnnotationsInterface.saveAnnotationContent(ContentHandlerInput input)	This method gets called when annotation data for the specified annotation file is ready to be saved.
ContentHandlerResult	VirtualViewerContentHandlerInterface.saveDocumentComponents(ContentHandlerInput input)	This method is used to save or update an existing document and sub-components of the document, such as annotations, bookmarks, document notes and watermarks.
ContentHandlerResult	VirtualViewerContentHandlerInterface.saveDocumentComponentsAs(ContentHandlerInput input)	This method is used to save a copy of a document under a new key, along with sub-components of the document, such as annotations, bookmarks, document notes and watermarks.
ContentHandlerResult	VirtualViewerContentHandlerInterface.saveDocumentContent(ContentHandlerInput input)	This method is used to update document data only.
ContentHandlerResult	SendDocumentInterface.sendDocumentContent(ContentHandlerInput input)	This method gets called to send a document via a mechanism defined by the content handler.

Uses of VirtualViewerAPIException in com.snowbound.contenthandler.rest

Methods in com.snowbound.contenthandler.rest that throw VirtualViewerAPIException

Modifier and Type	Method	Description
org.apache.hc.core5.http.ClassicHttpRequest	RestfulContentHandlerRequestBuilder.build()
ContentHandlerResult	RestfulHttpContentHandler.checkAvailable(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.createDocument(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.deleteAnnotation(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.deleteBookmarkContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.deleteNotesContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.deleteWatermarkContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.eventNotification(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getAllAnnotationsForDocument(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getAnnotationContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getAnnotationNames(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getAnnotationProperties(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getAvailableDocumentIds(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getBookmarkContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getDocumentContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getNotesContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getOCRDataForDocument(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getOCRDataOnPerformOCR(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.getWatermarkContent(ContentHandlerInput input)
void	RestfulHttpContentHandler.init(javax.servlet.ServletConfig config)
static void	HttpUtils.logOrThrowStatusCode(org.apache.hc.core5.http.HttpRequest request, int statusCode, java.lang.String reasonPhrase)
RestfulContentHandlerRequestBuilder	RestfulContentHandlerRequestBuilder.routeSegments(java.lang.String[] routes)
ContentHandlerResult	RestfulHttpContentHandler.saveAnnotationContent(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.saveDocumentComponents(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.saveDocumentComponentsAs(ContentHandlerInput input)
ContentHandlerResult	RestfulHttpContentHandler.saveDocumentContent(ContentHandlerInput input)

Constructors in com.snowbound.contenthandler.rest that throw VirtualViewerAPIException

Constructor	Description
RestfulContentHandlerRequestBuilder(org.apache.hc.core5.http.HttpHost host)