com.groupdocs.viewer.handlers
Class ViewerHandler

java.lang.Object
  extended by com.groupdocs.viewer.resources.GroupDocsViewer
      extended by com.groupdocs.viewer.handlers.etc.ViewerHandlerBase
          extended by com.groupdocs.viewer.handlers.ViewerHandlerBasic
              extended by com.groupdocs.viewer.handlers.ViewerHandler
All Implemented Interfaces:
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase, IGroupDocsViewer, IGroupDocsViewerIE

public class ViewerHandler
extends ViewerHandlerBasic
implements IGroupDocsViewer, IGroupDocsViewerIE

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
cacheHandler, config, DEFAULT_CHARSET, DOCUMENT_PAGE_IMAGE_HANDLER_URL, FILE_HANDLER_URL, inputDataHandler, pattern, PDF_WITH_PRINT_DIALOG_URL, 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_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, ROTATE_PAGE_HANDLER, START_GENERATE_IMAGES, UPLOAD_FILE, VIEW, VIEW_DOCUMENT_HANDLER
 
Constructor Summary
ViewerHandler(ServiceConfiguration config)
           
ViewerHandler(ServiceConfiguration config, CacheDataHandler cacheHandler)
           
ViewerHandler(ServiceConfiguration config, InputDataHandler inputDataHandler)
           
ViewerHandler(ServiceConfiguration config, InputDataHandler inputDataHandler, CacheDataHandler cacheHandler)
           
 
Method Summary
 InputStream getCssHandler(String cssName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI
 InputStream getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get HTML page [POST request]
 InputStream getDocumentPageImageHandler(String path, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, Boolean isPrint, javax.servlet.http.HttpServletResponse response)
          Get image file [GET request]
 InputStream getFileHandler(String guid, boolean getPdf, javax.servlet.http.HttpServletResponse response)
          Download file [GET request]
 InputStream getFontHandler(String fontName, javax.servlet.http.HttpServletRequest request, 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
 InputStream getHtmlResourcesHandler(String filePath, String guid, Integer page, String resourceName, javax.servlet.http.HttpServletResponse response)
          Get HTML resources [GET request]
 InputStream getImageHandler(String imageName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get images
This method is used to get images that are required to construct Viewer's UI
 String getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get thumbs and other images files [POST request]
 String getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get thumbs and other images files [GET request]
 InputStream getJsHandler(String scriptName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI
 void getPdfWithPrintDialog(String guid, javax.servlet.http.HttpServletResponse response)
          Get PDF print dialog [GET request]
 List<String> getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [POST request]
 List<String> getPrintableHtmlHandler(PrintableHtmlRequest doc, String mediaType, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get printable html from specific file type
 List<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
 String loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Load tree of files from base directory [POST request]
 String loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
          Load tree of files from base directory [GET request]
 String reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Reorder Page [POST request]
 String rotatePageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Rotate Page [POST request]
 String viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Generate list of images/pages [POST request]
 String 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.ViewerHandlerBasic
getCacheHandler, getConfiguration, getDocumentPageImageHandler, getImageUrls, getInputDataHandler, getLocale, getPrintableHtml, loadFileBrowserTreeData, renewTokenId, uploadFile, uploadFile, uploadFile, viewDocument
 
Methods inherited from class com.groupdocs.viewer.handlers.etc.ViewerHandlerBase
formatWidth, generateImage, getBody, getImageUrlList, getObjectData, getPdf2JavaScriptHandler, getPdfStream, initDirectoryCheck, objectToJson, objectToJson, preLoadFiles, setBrowserCache, wholeDirImageRotation
 
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)

ViewerHandler

public ViewerHandler(ServiceConfiguration config,
                     CacheDataHandler cacheHandler)

ViewerHandler

public ViewerHandler(ServiceConfiguration config,
                     InputDataHandler inputDataHandler)

ViewerHandler

public ViewerHandler(ServiceConfiguration config,
                     InputDataHandler inputDataHandler,
                     CacheDataHandler cacheHandler)
Method Detail

getHeader

public String getHeader()
                 throws Exception
Get HTML header

Returns:
Formatted HTML
Throws:
Exception

getViewerScript

public String getViewerScript(String viewerId,
                              String filePath,
                              String locale)
                       throws Exception
Get Viewer Script

Parameters:
viewerId - viewer id used in html
filePath - path to default file
locale - locale
Returns:
viewer script
Throws:
IOException
Exception

getJsHandler

public InputStream getJsHandler(String scriptName,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws Exception
Description copied from interface: IGroupDocsViewer
Get JavaScript scripts
This method is used to get JavaScripts that are required to construct Viewer's UI

Specified by:
getJsHandler in interface IGroupDocsViewer
Parameters:
scriptName - Script name or/and path (ex: libs/jquery.js)
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getCssHandler

public InputStream getCssHandler(String cssName,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws Exception
Description copied from interface: IGroupDocsViewer
Get CSS scripts
This method is used to get CSS scripts that are required to construct Viewer's UI

Specified by:
getCssHandler in interface IGroupDocsViewer
Parameters:
cssName - Script name or/and path (ex: libs/custom.css)
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getImageHandler

public InputStream getImageHandler(String imageName,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws Exception
Description copied from interface: IGroupDocsViewer
Get images
This method is used to get images that are required to construct Viewer's UI

Specified by:
getImageHandler in interface IGroupDocsViewer
Parameters:
imageName - Image name
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getFontHandler

public InputStream getFontHandler(String fontName,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewer
Get fonts
This method is used to get font that are required to generate documents

Specified by:
getFontHandler in interface IGroupDocsViewer
Parameters:
fontName - font name
request - HTTP servlet request
response - HTTP servlet response
Returns:
inputStream as object
Throws:
Exception

getHtmlResourcesHandler

public InputStream getHtmlResourcesHandler(String filePath,
                                           String guid,
                                           Integer page,
                                           String resourceName,
                                           javax.servlet.http.HttpServletResponse response)
                                    throws Exception
Description copied from interface: IGroupDocsViewer
Get HTML resources [GET request]

Specified by:
getHtmlResourcesHandler in interface IGroupDocsViewer
Parameters:
filePath - path to resource file
guid - document guid/id
page - page number
resourceName - resource name
response - HTTP servlet response
Returns:
HTML resources input stream as object
resources: images, fonts, etc
Throws:
Exception

getFileHandler

public InputStream getFileHandler(String guid,
                                  boolean getPdf,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewer
Download file [GET request]

Specified by:
getFileHandler in interface IGroupDocsViewer
Parameters:
guid - 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
Throws:
Exception

getDocumentPageImageHandler

public InputStream getDocumentPageImageHandler(String path,
                                               Integer width,
                                               Integer quality,
                                               Boolean usePdf,
                                               Integer pageIndex,
                                               Boolean isPrint,
                                               javax.servlet.http.HttpServletResponse response)
                                        throws Exception
Description copied from interface: IGroupDocsViewer
Get image file [GET request]

Specified by:
getDocumentPageImageHandler in interface IGroupDocsViewer
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
Throws:
Exception

viewDocumentHandler

public String viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewer
Generate list of images/pages [POST request]

Specified by:
viewDocumentHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
Document as json object
Throws:
Exception

viewDocumentHandler

public String viewDocumentHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewerIE
Generate list of images/pages [GET request]

Specified by:
viewDocumentHandler in interface IGroupDocsViewerIE
Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
Document as json object
Throws:
Exception

loadFileBrowserTreeDataHandler

public String loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws Exception
Description copied from interface: IGroupDocsViewer
Load tree of files from base directory [POST request]

Specified by:
loadFileBrowserTreeDataHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
File list as json object
Throws:
Exception

loadFileBrowserTreeDataHandler

public String loadFileBrowserTreeDataHandler(String callback,
                                             String data,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws Exception
Description copied from interface: IGroupDocsViewerIE
Load tree of files from base directory [GET request]

Specified by:
loadFileBrowserTreeDataHandler in interface IGroupDocsViewerIE
Parameters:
callback - Callback value
data - Data as json object
response - HTTP servlet response
Returns:
File list as json object
Throws:
Exception

getImageUrlsHandler

public String getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewer
Get thumbs and other images files [POST request]

Specified by:
getImageUrlsHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
Image thumbnail data as json object
Throws:
Exception

getImageUrlsHandler

public String getImageUrlsHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewerIE
Get thumbs and other images files [GET request]

Specified by:
getImageUrlsHandler in interface IGroupDocsViewerIE
Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
Image thumbnail data as json object
Throws:
Exception

getPrintableHtmlHandler

public List<String> getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws Exception
Description copied from interface: IGroupDocsViewer
Print document [POST request]

Specified by:
getPrintableHtmlHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
HTML page for printing
Throws:
Exception

getPrintableHtmlHandler

public List<String> getPrintableHtmlHandler(String callback,
                                            String data,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws Exception
Description copied from interface: IGroupDocsViewerIE
Print document [GET request]

Specified by:
getPrintableHtmlHandler in interface IGroupDocsViewerIE
Parameters:
callback - Callback value
data - Data as json object
request - HTTP servlet request
response - HTTP servlet response
Returns:
HTML page for printing
Throws:
Exception

getPrintableHtmlHandler

public List<String> getPrintableHtmlHandler(PrintableHtmlRequest doc,
                                            String mediaType,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws Exception
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
Throws:
Exception

getDocumentPageHtmlHandler

public InputStream getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
                                       throws Exception
Description copied from interface: IGroupDocsViewer
Get HTML page [POST request]

Specified by:
getDocumentPageHtmlHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
input stream html page as object
Throws:
Exception

getPdfWithPrintDialog

public void getPdfWithPrintDialog(String guid,
                                  javax.servlet.http.HttpServletResponse response)
                           throws Exception
Description copied from interface: IGroupDocsViewer
Get PDF print dialog [GET request]

Specified by:
getPdfWithPrintDialog in interface IGroupDocsViewer
Parameters:
guid - path to file
response - HTTP servlet response
Throws:
Exception

reorderPageHandler

public String reorderPageHandler(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws Exception
Description copied from interface: IGroupDocsViewer
Reorder Page [POST request]

Specified by:
reorderPageHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
json object with success flag as true or false
Throws:
Exception

rotatePageHandler

public String rotatePageHandler(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws Exception
Description copied from interface: IGroupDocsViewer
Rotate Page [POST request]

Specified by:
rotatePageHandler in interface IGroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
json object with success flag and rotation angle
Throws:
Exception


Copyright © 2015. All rights reserved.