com.groupdocs.viewer.handlers
Class ViewerHandler

java.lang.Object
  com.groupdocs.viewer.resources.GroupDocsViewer
      com.groupdocs.viewer.handlers.etc.ViewerHandlerBase
          com.groupdocs.viewer.handlers.ViewerHandler

All Implemented Interfaces:

com.groupdocs.viewer.handlers.etc.IViewerHandlerBase, com.groupdocs.viewer.resources.IGroupDocsViewer, com.groupdocs.viewer.resources.IGroupDocsViewerBasic

public class ViewerHandler
extends com.groupdocs.viewer.handlers.etc.ViewerHandlerBase

Provides all data actions with Viewer object

Author:

Alex Bobkov

See Also:

GroupDocsViewer

Field Summary

Fields inherited from class com.groupdocs.viewer.handlers.etc.ViewerHandlerBase

config, DEFAULT_CHARSET, DOCUMENT_PAGE_IMAGE_HANDLER_HTML_URL, DOCUMENT_PAGE_IMAGE_HANDLER_IMG_URL, ERROR_MESSAGE_TEMPLATE, FILE_HANDLER_URL, generateProgress, pattern, PDF_WITH_PRINT_DIALOG_URL, PRINTABLE_HTML_TEMPLATE, PRINTABLE_PAGE_TEMPLATE, STRING_EMPTY, STRING_FILE, STRING_FOLDER, viewAccessManager

Fields inherited from class com.groupdocs.viewer.resources.GroupDocsViewer

DOCUMENT_VIEWER, GET_CSS_HANDLER, GET_DOCUMENT_PAGE_HTML_HANDLER, GET_DOCUMENT_PAGE_IMAGE_HANDLER, GET_FILE_HANDLER, GET_FILENET, GET_FONT_HANDLER, GET_GENERATE_PROGRESS, GET_HTML_RESOURCES_HANDLER, GET_IMAGE_HANDLER, GET_IMAGE_URL_HANDLER, GET_JS_HANDLER, GET_PDF_2_JAVA_SCRIPT_HANDLER, GET_PDF_WITH_PRINT_DIALOG, GET_PRINTABLE_HTML_HANDLER, LOAD_FILE_BROWSER_TREE_DATA_HANLER, REORDER_PAGE_HANDLER, START_GENERATE_IMAGES, UPLOAD_FILE, VIEW, VIEW_DOCUMENT_HANDLER

Constructor Summary

ViewerHandler(ServiceConfiguration config)
Viewer constructor

ViewerHandler(ServiceConfiguration config, InputDataHandler inputDataHandler)
Viewer constructor

Method Summary

void	generateCache(String guid, String width, Integer quality, Boolean usePdf, javax.servlet.http.HttpServletResponse response) Generate cache in the background
String	getCacheGenerationProgress(String guid, javax.servlet.http.HttpServletRequest request) Get cache generation progress
ServiceConfiguration	getConfiguration() Get service configuration
Object	getCssHandler(String cssName, javax.servlet.http.HttpServletResponse response) Get CSS scripts This method is used to get CSS scripts that are required to construct Viewer's UI
Object	getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get HTML page [POST request]
Object	getDocumentPageImageHandler(String path, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response) Get image file [GET request]
Object	getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response) Download file [GET request]
Object	getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response) Get fonts This method is used to get font that are required to generate documents
String	getHeader() Get HTML header
Object	getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response) Get HTML resources [GET request]
Object	getImageHandler(String imageName, javax.servlet.http.HttpServletResponse response) Get images This method is used to get images that are required to construct Viewer's UI
Object	getImageUrls(Image image) Get thumbs and other images files
Object	getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get thumbs and other images files [POST request]
Object	getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get thumbs and other images files [GET request]
Object	getJsHandler(String scriptName, javax.servlet.http.HttpServletResponse response) Get JavaScript scripts This method is used to get JavaScripts that are required to construct Viewer's UI
String	getLocale() Get locale
String	getPdf2JavaScriptHandler(String guid, int pageCount) Get text from file as json
Object	getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response) Get PDF print dialog [GET request]
String	getPrintableHtml(PrintDocument doc) Get HTML print document
String	getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Print document [POST request]
String	getPrintableHtmlHandler(PrintDocument doc, String mediaType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get printable html from specific file type
String	getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Print document [GET request]
String	getViewerScript(String viewerId, String filePath, String locale) Get Viewer Script
Object	loadFileBrowserTreeData(FileBrowserTreeData treeData) Load tree of files from base directory
Object	loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Load tree of files from base directory [POST request]
Object	loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response) Load tree of files from base directory [GET request]
Object	renewTokenId(String tokenId) Renew expired token
Object	reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Reorder Page [POST request]
Object	uploadFile(File file, Integer timeToLive) Upload file
Object	uploadFile(InputStream inputStream, String fileName, Integer timeToLive) Upload file
Object	uploadFile(String filePath, Integer timeToLive) Upload file
Object	viewDocument(ViewDocument viewDocument) Generate list of images/pages
Object	viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generate list of images/pages [POST request]
Object	viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generate list of images/pages [GET request]

Methods inherited from class com.groupdocs.viewer.handlers.etc.ViewerHandlerBase

closeStream, formatWidth, generateImage, generateImages, getBody, getDownloadStream, getErrorMessage, getImageUrl, getLicenseStream, getObjectData, initDirectoryCheck, objectToJson, preLoadFiles, setBrowserCache, setLicense, setResponseContentType, useCache

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewerHandler

public ViewerHandler(ServiceConfiguration config)
              throws Exception

Viewer constructor

Parameters:

config - Configuration files with required data to create viewer instance

Throws:

Exception - Invalid license

ViewerHandler

public ViewerHandler(ServiceConfiguration config,
                     InputDataHandler inputDataHandler)
              throws Exception

Viewer constructor

Parameters:

config - Configuration files with required data to create viewer instance

inputDataHandler - Data handler to read from different location or data source (default local disk)

Throws:

Exception - Invalid license

Method Detail

getConfiguration

public ServiceConfiguration getConfiguration()

Get service configuration

Returns:

service configuration

getHeader

public String getHeader()
                 throws IOException

Get HTML header

Returns:

Formatted HTML

Throws:

IOException

getViewerScript

public String getViewerScript(String viewerId,
                              String filePath,
                              String locale)
                       throws IOException

Get Viewer Script

Parameters:

viewerId - viewer id used in html

filePath - path to default file

locale - locale

Returns:

viewer script

Throws:

IOException

getLocale

public String getLocale()

Get locale

Returns:

Locale json object as String if current locale is supported otherwise return default locale (English)

uploadFile

public Object uploadFile(String filePath,
                         Integer timeToLive)

Upload file

Parameters:

filePath - path to file

timeToLive - expiration date for file upload in minutes
set 0 for permanent

Returns:

token id as json

uploadFile

public Object uploadFile(File file,
                         Integer timeToLive)

Upload file

Parameters:

file - file

timeToLive - expiration date for file upload in minutes
set 0 for permanent

Returns:

token id as json

uploadFile

public Object uploadFile(InputStream inputStream,
                         String fileName,
                         Integer timeToLive)

Upload file

Parameters:

inputStream - input stream

fileName - file name

timeToLive - expiration date for file upload in minutes
set 0 for permanent

Returns:

token id as json

renewTokenId

public Object renewTokenId(String tokenId)

Renew expired token

Parameters:

tokenId - expired token id

Returns:

renewed token id

getPdf2JavaScriptHandler

public String getPdf2JavaScriptHandler(String guid,
                                       int pageCount)
                                throws Exception

Get text from file as json

Parameters:

guid - file guid

pageCount -

Returns:

json

Throws:

Exception

generateCache

public void generateCache(String guid,
                          String width,
                          Integer quality,
                          Boolean usePdf,
                          javax.servlet.http.HttpServletResponse response)
                   throws Exception

Generate cache in the background

Parameters:

guid - file guid

width - output file width

quality - output file quality

usePdf - use pdf flag

response - HTTP servlet respose

Throws:

Exception

getCacheGenerationProgress

public String getCacheGenerationProgress(String guid,
                                         javax.servlet.http.HttpServletRequest request)
                                  throws Exception

Get cache generation progress

Parameters:

guid - file guid

request - HTTP servlet request

Returns:

current progress status

Throws:

Exception

getJsHandler

public Object getJsHandler(String scriptName,
                           javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI

Parameters:

scriptName - Script name or/and path (ex: libs/jquery.js)

response - HTTP servlet response

Returns:

inputStream as object

getCssHandler

public Object getCssHandler(String cssName,
                            javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI

Parameters:

cssName - Script name or/and path (ex: libs/custom.css)

response - HTTP servlet response

Returns:

inputStream as object

getImageHandler

public Object getImageHandler(String imageName,
                              javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get images
This method is used to get images that are required to construct Viewer's UI

Parameters:

imageName - Image name

response - HTTP servlet response

Returns:

inputStream as object

getFontHandler

public Object getFontHandler(String fontName,
                             javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get fonts
This method is used to get font that are required to generate documents

Parameters:

fontName - font name

response - HTTP servlet response

Returns:

inputStream as object

getHtmlRecoucesHandler

public Object getHtmlRecoucesHandler(String filePath,
                                     javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get HTML resources [GET request]

Parameters:

filePath - path to resource file

response - HTTP servlet response

Returns:

HTML resources input stream as object
resources: images, fonts, etc

getFileHandler

public Object getFileHandler(String path,
                             boolean getPdf,
                             javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Download file [GET request]

Parameters:

path - Path to file to be downloaded

getPdf - flag to set if file will be downloaded as PDF or original

response - HTTP servlet response

Returns:

inputStream as object

getDocumentPageImageHandler

public Object getDocumentPageImageHandler(String path,
                                          Integer width,
                                          Integer quality,
                                          Boolean usePdf,
                                          Integer pageIndex,
                                          javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get image file [GET request]

Parameters:

path - Relative path to file from base path directory (ex: folder/example.doc or example.doc)

width - Generated images with

quality - Generated images quality

usePdf - Use PDF flag

pageIndex - Page number

response - HTTP servlet response

Returns:

input stream as object

viewDocumentHandler

public Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Generate list of images/pages [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

Document as json object

viewDocumentHandler

public Object viewDocumentHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewer

Generate list of images/pages [GET request]

Parameters:

callback - Callback value

data - Data as json object

request - HTTP servlet request

response - HTTP servlet response

Returns:

Document as json object

viewDocument

public Object viewDocument(ViewDocument viewDocument)
                    throws Exception

Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase

Generate list of images/pages

Parameters:

viewDocument - request object

Returns:

json

Throws:

Exception

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Load tree of files from base directory [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

File list as json object

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(String callback,
                                             String data,
                                             javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewer

Load tree of files from base directory [GET request]

Parameters:

callback - Callback value

data - Data as json object

response - HTTP servlet response

Returns:

File list as json object

loadFileBrowserTreeData

public Object loadFileBrowserTreeData(FileBrowserTreeData treeData)
                               throws Exception

Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase

Load tree of files from base directory

Returns:

Throws:

Exception

getImageUrlsHandler

public Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get thumbs and other images files [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

Image thumbnail data as json object

getImageUrlsHandler

public Object getImageUrlsHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewer

Get thumbs and other images files [GET request]

Parameters:

callback - Callback value

data - Data as json object

request - HTTP servlet request

response - HTTP servlet response

Returns:

Image thumbnail data as json object

getImageUrls

public Object getImageUrls(Image image)
                    throws IOException

Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase

Get thumbs and other images files

Returns:

Throws:

IOException

getPrintableHtmlHandler

public String getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Print document [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

HTML page for printing

getPrintableHtmlHandler

public String getPrintableHtmlHandler(String callback,
                                      String data,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewer

Print document [GET request]

Parameters:

callback - Callback value

data - Data as json object

request - HTTP servlet request

response - HTTP servlet response

Returns:

HTML page for printing

getPrintableHtmlHandler

public String getPrintableHtmlHandler(PrintDocument doc,
                                      String mediaType,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Get printable html from specific file type

Parameters:

doc - document object

mediaType - media type

request - HTTP servlet request

response - HTTP servlet response

Returns:

printable html

getPrintableHtml

public String getPrintableHtml(PrintDocument doc)
                        throws Exception

Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase

Get HTML print document

Returns:

Throws:

Exception

getDocumentPageHtmlHandler

public Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get HTML page [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

input stream html page as object

getPdfWithPrintDialog

public Object getPdfWithPrintDialog(String path,
                                    javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Get PDF print dialog [GET request]

Parameters:

path - path to file

response - HTTP servlet response

Returns:

input stream pdf as object

reorderPageHandler

public Object reorderPageHandler(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)

Description copied from interface: com.groupdocs.viewer.resources.IGroupDocsViewerBasic

Reorder Page [POST request]

Parameters:

request - HTTP servlet request

response - HTTP servlet response

Returns:

json object with success flag as true or false