com.groupdocs.annotation.handler
Class AnnotationHandler

java.lang.Object
  extended by com.groupdocs.viewer.resources.GroupDocsViewer
      extended by com.groupdocs.annotation.handler.GroupDocsAnnotation
          extended by com.groupdocs.annotation.handler.AnnotationHandlerBase
              extended by com.groupdocs.annotation.handler.AnnotationHandler

public class AnnotationHandler
extends com.groupdocs.annotation.handler.AnnotationHandlerBase

Annotation handler

Author:
Alex Bobkov

Field Summary
protected  com.groupdocs.viewer.handlers.ViewerHandler viewerHandler
           
 
Fields inherited from class com.groupdocs.annotation.handler.AnnotationHandlerBase
ANONYMOUS_USERNAME, BASE_URL_KEY, CLICKABLE_ANNOTATIONS_KEY, CONNECTOR_POSITION_KEY, CREATE_MARKUP_KEY, DISCONNECT_UNCOMMENTED_KEY, ENABLE_RIGHT_CLICK_MENU, ENABLE_SIDE_PANEL_KEY, ENABLE_STANDARD_ERROR_HANDLING_KEY, ENABLED_TOOLS_KEY, FILE_PATH_KEY, GRAPHICS_CONTAINER_SELECTOR_KEY, HEIGHT_KEY, INITIAL_ZOOM_KEY, MODE_KEY, OPEN_THUMBNAILS_KEY, PRELOAD_PAGES_COUNT_KEY, PRINT_DOCUMENT_PAGE_IMAGE_HANDLER_HTML_URL, PRINTABLE_HTML_TEMPLATE, PRINTABLE_PAGE_TEMPLATE, QUALITY_KEY, RIGHT_PANEL_ENABLED_KEY, SAVE_REPLY_ON_FOCUS_LOSS_KEY, SCROLL_ON_FOCUS_KEY, SELECTION_CONTAINER_SELECTOR_KEY, SHOW_FILE_EXPLORER, SHOW_HEADER_KEY, SHOW_PAGING_KEY, SHOW_PRINT_KEY, SHOW_THUMBNAILS_KEY, SHOW_TOOLBAR_KEY, SHOW_ZOOM_KEY, SIDEBAR_CONTAINER_SELECTOR_KEY, STRIKE_OUT_COLOR, STRIKEOUT_MODE_KEY, TEXT_SELECTION_SYNCHRONOUS_CALCULATION_KEY, UNDO_ENABLED_KEY, USE_PAGE_NUMBER_IN_URL_HASH_KEY, USE_PDF_KEY, USER_GUID_KEY, USER_NAME_KEY, VARIABLE_HEIGHT_PAGE_SUPPORT_KEY, WIDGET_ID_KEY, WIDTH_KEY, ZOOM_TO_FIT_HEIGHT_KEY, ZOOM_TO_FIT_WIDTH_KEY
 
Fields inherited from class com.groupdocs.annotation.handler.GroupDocsAnnotation
ADD_ANNOTATION_REPLY_HANDLER, ATMOSPHERE_ANNOTATION, CREATE_ANNOTATION_HANDLER, DELETE_ANNOTATION_HANDLER, DELETE_ANNOTATION_REPLY_HANDLER, DOCUMENT_ANNOTATION, EDIT_ANNOTATION_REPLY_HANDLER, EXPORT_ANNOTATIONS_HANDLER, GET_AVATAR_HANDLER, GET_DOCUMENT_COLLABORATORS_HANDLER, GET_PDF_VERSION_OF_DOCUMENT_HANDLER, GET_PRINT_DOCUMENT_PAGE_IMAGE_HANDLER, GET_PRINT_VIEW_HANDLER, IMPORT_ANNOTATIONS_HANDLER, LIST_ANNOTATIONS_HANDLER, MOVE_ANNOTATION_MARKER_HANDLER, RESIZE_ANNOTATION_HANDLER, SAVE_TEXT_FIELD_HANDLER, SET_TEXT_FIELD_COLOR_HANDLER, UPLOAD_FILE_HANDLER
 
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
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config)
          Constructor with basic configuration
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config, IDatabaseConnector databaseConnector)
          Constructor with basic configuration and custom database connector
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config, com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler)
          Constructor with basic configuration and custom input data handler
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config, com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler, IDatabaseConnector databaseConnector)
          Constructor with basic configuration, custom input data handler and custom database connector
 
Method Summary
 Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add annotation reply handler
 String addCollaborator(String userName, String fileGuid, AccessRights accessRights, int color)
          Add collaborator if one doesn't exist and return guid
 String addCollaborator(String userName, String fileGuid, Integer accessRights, int color)
          Add collaborator if one doesn't exist and return guid
 String addCollaboratorByGuid(String userGuid, String fileGuid, AccessRights accessRights, int color)
          Add collaborator if one doesn't exist and return guid
 String addCollaboratorByGuid(String userGuid, String fileGuid, Integer accessRights, int color)
          Add collaborator if one doesn't exist and return guid
 Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Create annotation handler
 Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation handler
 Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation reply handler
 Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Edit annotation reply handler
 Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Export annotations handler
 String getAnnotationScript(String filePath, String userName, String userGuid)
          Get inline JavaScript's JavaScripts
 String getAnnotationScript(String wid, String filePath, String userName, String userGuid)
          Deprecated. first param is not used
 Object getAvatarHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userGuid)
          Get avatar handler will write avatar data to response stream
 com.groupdocs.viewer.config.ServiceConfiguration getConfiguration()
          Get service configuration
 Object getCssHandler(String script, javax.servlet.http.HttpServletResponse response)
          Get CSS handler.
 Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Return document collaborators
 Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get HTML page [POST request]
 Object getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
          Get document page image handler.
 Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
          Get file handler Get file by path
 void getFileHandler(String path, javax.servlet.http.HttpServletResponse response)
          Deprecated. as of release 1.4.0, replaced by getFileHandler(String, boolean, HttpServletResponse)
 Object getFontHandler(String fontName, javax.servlet.http.HttpServletResponse response)
          Get font handler.
 String getHeader(String applicationPath, javax.servlet.http.HttpServletRequest request)
           
 Object getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
          Get html resources handler
 Object getImageHandler(String name, javax.servlet.http.HttpServletResponse response)
          Get image handler.
 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 page image urls
 Object getJsHandler(String script, javax.servlet.http.HttpServletResponse response)
          Get JavaScript handler.
 Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. since 1.6.0, use getPdf2JavaScriptHandler(guid) instead
 Object getPdf2JavaScriptHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
          Deprecated. since 1.6.0, use getPdf2JavaScriptHandler(guid) instead
 Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get pdf version of document
 Object getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
          Get PDF print dialog [GET request]
 Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [POST request]
 Object getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Print document [GET request]
 Object getPrintDocumentPageImageHandler(String guid, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
          Get image file for print [GET request]
 Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Return printable HTML string
 String getScripts(String appPath, Map<String,Object> params)
           
 byte[] getUserAvatar(String userGuid)
          Return avatar file
 Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Import annotations from PDF file
 Object importAnnotationsHandler(ImportAnnotationsRequest importAnnotationsRequest)
          Import annotations from PDF file
 Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          List annotations for document
 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 moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Move annotation handler
 void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
          Incoming atmosphere message
 void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
          Atmosphere is ready event
 Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Reorder page
 Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Resize annotation handler
 Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save annotation text field handler
 boolean sendMessage(Object message)
          Send message to all clients
 Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set annotation text field handler
 void setUserAvatar(String userGuid, byte[] avatarFile)
          Set new avatar for user
 Object uploadFileHandler(String userGuid, String uploadFileName, InputStream uploadInputStream, boolean callImport)
          Upload file for import
 Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          View document handler
 Object viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          View document handler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

viewerHandler

protected com.groupdocs.viewer.handlers.ViewerHandler viewerHandler
Constructor Detail

AnnotationHandler

public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config)
Constructor with basic configuration

Parameters:
config - sets of basic configurations to initialize viewer

AnnotationHandler

public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config,
                         com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler)
Constructor with basic configuration and custom input data handler

Parameters:
config - sets of basic configurations to initialize viewer
inputDataHandler - custom input data handler

AnnotationHandler

public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config,
                         IDatabaseConnector databaseConnector)
Constructor with basic configuration and custom database connector

Parameters:
config - sets of basic configurations to initialize viewer
databaseConnector - cusom database connector

AnnotationHandler

public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config,
                         com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler,
                         IDatabaseConnector databaseConnector)
Constructor with basic configuration, custom input data handler and custom database connector

Parameters:
config - sets of basic configurations to initialize viewer
inputDataHandler - custom input data handler
databaseConnector - cusom database connector
Method Detail

getHeader

public final String getHeader(String applicationPath,
                              javax.servlet.http.HttpServletRequest request)
                       throws IOException
Parameters:
applicationPath - base application url (example http://annotation.local:8080/context-path/ )
request -
Returns:
HTML formatted header
Throws:
IOException - Get HTML header including all JavaScipts, style sheets and images

getScripts

public final String getScripts(String appPath,
                               Map<String,Object> params)
                        throws IOException
Parameters:
appPath - base application url (example http://annotation.local:8080/context-path/ )
params - parameters to configure annotation
Returns:
html with inline JavaScript
Throws:
IOException - Get inline JavaScript's JavaScripts

getAnnotationScript

public final String getAnnotationScript(String wid,
                                        String filePath,
                                        String userName,
                                        String userGuid)
                                 throws IOException
Deprecated. first param is not used

Get inline JavaScript's JavaScripts

Parameters:
wid - widget id
filePath - path to file
userName - user name
userGuid - user guid
Returns:
html with inline JavaScript
Throws:
IOException

getAnnotationScript

public final String getAnnotationScript(String filePath,
                                        String userName,
                                        String userGuid)
                                 throws IOException
Get inline JavaScript's JavaScripts

Parameters:
filePath - path to file
userName - user name
userGuid - user guid
Returns:
html with inline JavaScript
Throws:
IOException

getJsHandler

public final Object getJsHandler(String script,
                                 javax.servlet.http.HttpServletResponse response)
Get JavaScript handler. Get JavaScript file by name

Specified by:
getJsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
script - JavaScript name
response - HTTP servlet response
Returns:
JavaScript file content

getCssHandler

public final Object getCssHandler(String script,
                                  javax.servlet.http.HttpServletResponse response)
Get CSS handler. Get css file by name

Specified by:
getCssHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
script - CSS name
response - HTTP servlet response
Returns:
CSS file content

getImageHandler

public final Object getImageHandler(String name,
                                    javax.servlet.http.HttpServletResponse response)
Get image handler. Return image by name

Specified by:
getImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
name - image name
response - http servlet response
Returns:
input stream

getFontHandler

public final Object getFontHandler(String fontName,
                                   javax.servlet.http.HttpServletResponse response)
Get font handler. Get font by name

Specified by:
getFontHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
fontName - font name
response - http servlet response
Returns:
font stream

getHtmlRecoucesHandler

public final Object getHtmlRecoucesHandler(String filePath,
                                           javax.servlet.http.HttpServletResponse response)
Get html resources handler

Specified by:
getHtmlRecoucesHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
filePath - file path
response - HTTP servlet response
Returns:
resource stream

getFileHandler

@Deprecated
public final void getFileHandler(String path,
                                            javax.servlet.http.HttpServletResponse response)
Deprecated. as of release 1.4.0, replaced by getFileHandler(String, boolean, HttpServletResponse)

Download file [GET request]

Parameters:
path - path to file to be downloaded
response - HTTP servlet response

getFileHandler

public final Object getFileHandler(String path,
                                   boolean getPdf,
                                   javax.servlet.http.HttpServletResponse response)
Get file handler Get file by path

Specified by:
getFileHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
path - file path
getPdf - get file as pdf
response - HTTP servlet response
Returns:
file stream

getDocumentPageImageHandler

public final Object getDocumentPageImageHandler(String guid,
                                                Integer width,
                                                Integer quality,
                                                Boolean usePdf,
                                                Integer pageIndex,
                                                javax.servlet.http.HttpServletResponse response)
Get document page image handler. Get document page as image

Specified by:
getDocumentPageImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
guid - document identifier
width - iamge width
quality - image quality
usePdf - use pdf
pageIndex - page index
response - HTTP servlet response
Returns:
image stream

getPrintDocumentPageImageHandler

public final Object getPrintDocumentPageImageHandler(String guid,
                                                     Boolean usePdf,
                                                     Integer pageIndex,
                                                     javax.servlet.http.HttpServletResponse response)
Get image file for print [GET request]

Specified by:
getPrintDocumentPageImageHandler in class GroupDocsAnnotation
Parameters:
guid - Relative path to file from base path directory (ex: folder/example.doc or example.doc)
usePdf - Use PDF flag
pageIndex - Page number
response - HTTP servlet response
Returns:

viewDocumentHandler

public final Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
View document handler

Specified by:
viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

viewDocumentHandler

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

Specified by:
viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
callback - callback method name
data - request data
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

loadFileBrowserTreeDataHandler

public final Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [POST request]

Specified by:
loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
resonse object

loadFileBrowserTreeDataHandler

public final Object loadFileBrowserTreeDataHandler(String callback,
                                                   String data,
                                                   javax.servlet.http.HttpServletResponse response)
Load tree of files from base directory [GET request]

Specified by:
loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
callback - callback method name
data - request data
response - HTTP servlet response
Returns:
response object

getPdf2JavaScriptHandler

@Deprecated
public final Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
Deprecated. since 1.6.0, use getPdf2JavaScriptHandler(guid) instead

Return PDF data as JavaScript

Specified by:
getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - http servlet request
response - http servlet response
Returns:
PDF data as JavaScript

getPdf2JavaScriptHandler

@Deprecated
public final Object getPdf2JavaScriptHandler(String callback,
                                                        String data,
                                                        javax.servlet.http.HttpServletResponse response)
Deprecated. since 1.6.0, use getPdf2JavaScriptHandler(guid) instead

Return PDF data as JavaScript

Specified by:
getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
callback - callback
data - data
response - http servlet response
Returns:
PDF data as JavaScript

getPrintableHtmlHandler

public final Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Print document [POST request]

Specified by:
getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getPrintableHtmlHandler

public final Object getPrintableHtmlHandler(String callback,
                                            String data,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Print document [GET request]

Specified by:
getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
callback - callback method name
data - request data
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getDocumentPageHtmlHandler

public final Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Get HTML page [POST request]

Specified by:
getDocumentPageHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getImageUrlsHandler

public final Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
Get thumbs and other images files [POST request]

Specified by:
getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getImageUrlsHandler

public final Object getImageUrlsHandler(String callback,
                                        String data,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
Get page image urls

Specified by:
getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
callback - callback
data - request data
request - HTTP servlet request
response - http servlet response
Returns:
response object

listAnnotationsHandler

public final Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
List annotations for document

Specified by:
listAnnotationsHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

exportAnnotationsHandler

public final Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
Export annotations handler

Specified by:
exportAnnotationsHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getPdfVersionOfDocumentHandler

public final Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
Get pdf version of document

Specified by:
getPdfVersionOfDocumentHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

createAnnotationHandler

public final Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Create annotation handler

Specified by:
createAnnotationHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getAvatarHandler

public final Object getAvatarHandler(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     String userGuid)
Get avatar handler will write avatar data to response stream

Specified by:
getAvatarHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
userGuid - user id
Returns:
null

addAnnotationReplyHandler

public final Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
Add annotation reply handler

Specified by:
addAnnotationReplyHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

editAnnotationReplyHandler

public final Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
Edit annotation reply handler

Specified by:
editAnnotationReplyHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

deleteAnnotationReplyHandler

public final Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)
Delete annotation reply handler

Specified by:
deleteAnnotationReplyHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

deleteAnnotationHandler

public final Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Delete annotation handler

Specified by:
deleteAnnotationHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

saveTextFieldHandler

public final Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
Save annotation text field handler

Specified by:
saveTextFieldHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

setTextFieldColorHandler

public final Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
Set annotation text field handler

Specified by:
setTextFieldColorHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

moveAnnotationMarkerHandler

public final Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
Move annotation handler

Specified by:
moveAnnotationMarkerHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

resizeAnnotationHandler

public final Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
Resize annotation handler

Specified by:
resizeAnnotationHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getDocumentCollaboratorsHandler

public final Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
Return document collaborators

Specified by:
getDocumentCollaboratorsHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getConfiguration

public final com.groupdocs.viewer.config.ServiceConfiguration getConfiguration()
Get service configuration

Returns:
service configuration

addCollaborator

public final String addCollaborator(String userName,
                                    String fileGuid,
                                    AccessRights accessRights,
                                    int color)
                             throws AnnotationException
Add collaborator if one doesn't exist and return guid

Parameters:
userName - collaborator user name
fileGuid - document guid
accessRights - access rights
color - color to collaborator
Returns:
collaborator guid
Throws:
AnnotationException - annotation exception

addCollaborator

public final String addCollaborator(String userName,
                                    String fileGuid,
                                    Integer accessRights,
                                    int color)
                             throws AnnotationException
Add collaborator if one doesn't exist and return guid

Parameters:
userName - collaborator user name
fileGuid - document guid
accessRights - access rights
color - color to collaborator
Returns:
collaborator guid
Throws:
AnnotationException - annotation exception

addCollaboratorByGuid

public final String addCollaboratorByGuid(String userGuid,
                                          String fileGuid,
                                          AccessRights accessRights,
                                          int color)
                                   throws AnnotationException
Add collaborator if one doesn't exist and return guid

Parameters:
userGuid - guid of user
fileGuid - document guid
accessRights - access rights
color - color to collaborator
Returns:
collaborator guid
Throws:
AnnotationException - annotation exception

addCollaboratorByGuid

public final String addCollaboratorByGuid(String userGuid,
                                          String fileGuid,
                                          Integer accessRights,
                                          int color)
                                   throws AnnotationException
Add collaborator if one doesn't exist and return guid

Parameters:
userGuid - guid of user
fileGuid - document guid
accessRights - access rights
color - color to collaborator
Returns:
collaborator guid
Throws:
AnnotationException - annotation exception

uploadFileHandler

public final Object uploadFileHandler(String userGuid,
                                      String uploadFileName,
                                      InputStream uploadInputStream,
                                      boolean callImport)
Upload file for import

Parameters:
userGuid - user id
uploadFileName - name of uploaded file
uploadInputStream - stream of uploaded file
callImport - use import annotation flag
Returns:
object with response parameters

importAnnotationsHandler

public final Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
Import annotations from PDF file

Specified by:
importAnnotationsHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
JSON result object

importAnnotationsHandler

public Object importAnnotationsHandler(ImportAnnotationsRequest importAnnotationsRequest)
Import annotations from PDF file

Parameters:
importAnnotationsRequest - import request object
Returns:
import annotations response

getPrintViewHandler

public final Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
Return printable HTML string

Specified by:
getPrintViewHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
printable HTML string

getPdfWithPrintDialog

public final Object getPdfWithPrintDialog(String path,
                                          javax.servlet.http.HttpServletResponse response)
Get PDF print dialog [GET request]

Specified by:
getPdfWithPrintDialog in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
path - file path
response - http servlet response
Returns:
null

reorderPageHandler

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

Specified by:
reorderPageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer
Parameters:
request - http servlet request
response - http servlet response
Returns:
reorder json string

onAtmosphereReady

public final void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
Atmosphere is ready event

Specified by:
onAtmosphereReady in class GroupDocsAnnotation
Parameters:
resource - resource data received from socket

onAtmosphereMessage

public final void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
Incoming atmosphere message

Specified by:
onAtmosphereMessage in class GroupDocsAnnotation
Parameters:
resource - resource data received from socket

sendMessage

public final boolean sendMessage(Object message)
Send message to all clients

Parameters:
message - string or class (will be serialized to json)
Returns:
success

getUserAvatar

public byte[] getUserAvatar(String userGuid)
                     throws AnnotationException
Return avatar file

Parameters:
userGuid - user guid to find avatar
Returns:
avatar file
Throws:
AnnotationException - user not found

setUserAvatar

public void setUserAvatar(String userGuid,
                          byte[] avatarFile)
                   throws AnnotationException
Set new avatar for user

Parameters:
userGuid - user guid to set avatar
avatarFile - avatar file
Throws:
AnnotationException - user not found


Copyright © 2014. All rights reserved.