com.groupdocs.viewer.handlers
Class ViewerHandlerBasic

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
All Implemented Interfaces:
com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Direct Known Subclasses:
ViewerHandler

public class ViewerHandlerBasic
extends com.groupdocs.viewer.handlers.etc.ViewerHandlerBase
implements com.groupdocs.viewer.handlers.etc.IViewerHandlerBase

Author:
Alex Bobkov

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
ViewerHandlerBasic(ServiceConfiguration config)
          Viewer constructor
ViewerHandlerBasic(ServiceConfiguration config, CacheDataHandler cacheHandler)
          Viewer constructor
ViewerHandlerBasic(ServiceConfiguration config, InputDataHandler inputDataHandler)
          Viewer constructor
ViewerHandlerBasic(ServiceConfiguration config, InputDataHandler inputDataHandler, CacheDataHandler cacheHandler)
          Viewer constructor
 
Method Summary
 CacheDataHandler getCacheHandler()
          Get cache handler
 ServiceConfiguration getConfiguration()
          Get service configuration
 InputStream getDocumentPageImageHandler(String imageUrl)
          Get image stream
 ImageUrlsResponse getImageUrls(ImageUrlsRequest image)
          Get thumbs and other images files
 InputDataHandler getInputDataHandler()
          Get input data handler
 String getLocale()
          Get locale
 List<String> getPrintableHtml(PrintableHtmlRequest doc)
          Get HTML print document
 FileBrowserTreeDataResponse loadFileBrowserTreeData(FileBrowserTreeDataRequest treeData)
          Load tree of files from base directory
 UploadTokenResponse renewTokenId(String tokenId)
          Renew expired token
 String uploadFile(File file, Integer timeToLive)
          Upload file
 String uploadFile(InputStream inputStream, String fileName, Integer timeToLive)
          Upload file
 String uploadFile(String filePath, Integer timeToLive)
          Upload file
 ViewDocumentResponse viewDocument(ViewDocumentRequest documentRequest)
          Generate list of images/pages
 
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

ViewerHandlerBasic

public ViewerHandlerBasic(ServiceConfiguration config)
Viewer constructor

Parameters:
config - Configuration files with required data to create viewer instance

ViewerHandlerBasic

public ViewerHandlerBasic(ServiceConfiguration config,
                          CacheDataHandler cacheHandler)
Viewer constructor

Parameters:
config - Configuration files with required data to create viewer
cacheHandler - Cache handler to write cache files in custom location

ViewerHandlerBasic

public ViewerHandlerBasic(ServiceConfiguration config,
                          InputDataHandler inputDataHandler)
Viewer constructor

Parameters:
config - Configuration files with required data to create viewer
inputDataHandler - Data handler to read from different location or data source (default - local disk)

ViewerHandlerBasic

public ViewerHandlerBasic(ServiceConfiguration config,
                          InputDataHandler inputDataHandler,
                          CacheDataHandler cacheHandler)
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)
cacheHandler - Cache handler to write cache files in custom location
Method Detail

getConfiguration

public ServiceConfiguration getConfiguration()
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get service configuration

Specified by:
getConfiguration in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
service configuration

getInputDataHandler

public InputDataHandler getInputDataHandler()
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get input data handler

Specified by:
getInputDataHandler in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
input data handler

getCacheHandler

public CacheDataHandler getCacheHandler()
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get cache handler

Specified by:
getCacheHandler in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
cache handler

getLocale

public String getLocale()
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get locale

Specified by:
getLocale in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
Locale json object as String if current locale is supported otherwise return default locale (English)

uploadFile

public String uploadFile(String filePath,
                         Integer timeToLive)
                  throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Upload file

Specified by:
uploadFile in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
filePath - path to file
timeToLive - expiration date for file upload in minutes
set 0 for permanent
Returns:
token id as json
Throws:
Exception

uploadFile

public String uploadFile(File file,
                         Integer timeToLive)
                  throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Upload file

Specified by:
uploadFile in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
file - file
timeToLive - expiration date for file upload in minutes
set 0 for permanent
Returns:
token id as json
Throws:
Exception

uploadFile

public String uploadFile(InputStream inputStream,
                         String fileName,
                         Integer timeToLive)
                  throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Upload file

Specified by:
uploadFile in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
inputStream - input stream
fileName - file name
timeToLive - expiration date for file upload in minutes
set 0 for permanent
Returns:
token id as json
Throws:
Exception

renewTokenId

public UploadTokenResponse renewTokenId(String tokenId)
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Renew expired token

Specified by:
renewTokenId in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
tokenId - expired token id
Returns:
renewed token id

getDocumentPageImageHandler

public InputStream getDocumentPageImageHandler(String imageUrl)
                                        throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get image stream

Specified by:
getDocumentPageImageHandler in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
imageUrl - image url from viewDocuemnt response image urls list
Returns:
image stream
Throws:
Exception

viewDocument

public ViewDocumentResponse viewDocument(ViewDocumentRequest documentRequest)
                                  throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Generate list of images/pages

Specified by:
viewDocument in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Parameters:
documentRequest - request object
Returns:
json
Throws:
Exception

loadFileBrowserTreeData

public FileBrowserTreeDataResponse loadFileBrowserTreeData(FileBrowserTreeDataRequest treeData)
                                                    throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Load tree of files from base directory

Specified by:
loadFileBrowserTreeData in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
Throws:
Exception

getImageUrls

public ImageUrlsResponse getImageUrls(ImageUrlsRequest image)
                               throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get thumbs and other images files

Specified by:
getImageUrls in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
Throws:
Exception

getPrintableHtml

public List<String> getPrintableHtml(PrintableHtmlRequest doc)
                              throws Exception
Description copied from interface: com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Get HTML print document

Specified by:
getPrintableHtml in interface com.groupdocs.viewer.handlers.etc.IViewerHandlerBase
Returns:
Throws:
Exception


Copyright © 2015. All rights reserved.