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.AnnotationHandler

public class AnnotationHandler
extends GroupDocsAnnotation

Annotation handler

Author:
Alex Bobkov

Field Summary
static String ANONIMOUS_USERNAME
           
protected  com.groupdocs.viewer.config.ServiceConfiguration config
           
protected  com.groupdocs.viewer.handlers.ViewerHandler viewerHandler
           
 
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_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, com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler)
          Constructor with basic configuration and custom input data handler
 
Method Summary
 Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add reply to annotation [POST request]
 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
 Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Create annotation [POST request]
 Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation [POST request]
 Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation reply [POST request]
 Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Edit annotation reply [POST request]
 Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Export annotations to PDF [POST request]
 String getAnnotationScript(String annotationId, String filePath, String userName, String userGuid)
          Get inline JavaScript's JavaScripts
 Object getAvatarHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String userId)
          Get user avatar image [GET request]
 com.groupdocs.viewer.config.ServiceConfiguration getConfiguration()
          Get service configuration
 Object getCssHandler(String script, javax.servlet.http.HttpServletResponse response)
           
 Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Return list of collaborators [POST request]
 Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getDocumentPageImageHandler(String guid, Integer width, Integer quality, Boolean usePdf, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
           
 Object getFileHandler(String path, boolean getPdf, javax.servlet.http.HttpServletResponse response)
           
 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)
           
 String getHeader()
          Get HTML header including all JavaScipts, style sheets and images
 String getHeader(javax.servlet.http.HttpServletRequest request)
          Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images
 String getHeader(String appPath)
          Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images
 Object getHtmlRecoucesHandler(String filePath, javax.servlet.http.HttpServletResponse response)
           
 Object getImageHandler(String name, javax.servlet.http.HttpServletResponse response)
           
 Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getImageUrlsHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getJsHandler(String script, javax.servlet.http.HttpServletResponse response)
           
 Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getPdf2JavaScriptHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
           
 Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get document as PDF file [POST request]
 Object getPdfWithPrintDialog(String path, javax.servlet.http.HttpServletResponse response)
           
 Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getPrintableHtmlHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get view for print document [POST request]
 String getScripts(javax.servlet.http.HttpServletRequest request, HashMap<String,Object> params)
          Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts
 String getScripts(String appPath, HashMap<String,Object> params)
          Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts
 Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Import document with annotations [POST request]
 Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Get list of annotations [POST request]
 Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object loadFileBrowserTreeDataHandler(String callback, String data, javax.servlet.http.HttpServletResponse response)
           
 Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Move marker of annotation [POST request]
 void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
          On message handler [POST request]
 void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
          On ready handler [POST request]
 Object reorderPageHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Change annotation size [POST request]
 Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save changes in text of annotation [POST request]
 boolean sendMessage(Object message)
          Send message to all clients
 Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set color to text annotation [POST request]
 Object uploadFileHandler(String userId, String fld, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Upload file for import [POST request]
 Object uploadFileHandler(String userGuid, String uploadFileName, InputStream uploadInputStream, boolean callImport)
          Upload file for import
 Object uploadFileHandler(String userGuid, String fld, String uploadFileName, InputStream uploadInputStream, int timeToLive, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Deprecated. 
 Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 Object viewDocumentHandler(String callback, String data, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANONIMOUS_USERNAME

public static final String ANONIMOUS_USERNAME
See Also:
Constant Field Values

viewerHandler

protected com.groupdocs.viewer.handlers.ViewerHandler viewerHandler

config

protected com.groupdocs.viewer.config.ServiceConfiguration config
Constructor Detail

AnnotationHandler

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

Parameters:
config - sets of basic configurations to initialize viewer
Throws:
Exception

AnnotationHandler

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

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

getHeader

public String getHeader(javax.servlet.http.HttpServletRequest request)
                 throws IOException
Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images

Parameters:
request - http servlet request
Returns:
HTML formatted header
Throws:
IOException

getHeader

public String getHeader(String appPath)
                 throws IOException
Deprecated. since 1.5.0, use getHeader() instead Get HTML header including all JavaScipts, style sheets and images

Parameters:
appPath - base application url (example http://annotation.local:8080/context-path/ )
Returns:
HTML formatted header
Throws:
IOException

getHeader

public String getHeader()
                 throws IOException
Get HTML header including all JavaScipts, style sheets and images

Returns:
HTML formatted header
Throws:
IOException

getScripts

public String getScripts(javax.servlet.http.HttpServletRequest request,
                         HashMap<String,Object> params)
                  throws IOException
Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts

Parameters:
request - http servlet request
params - parameters to configure annotation
Returns:
html with inline JavaScript
Throws:
IOException

getScripts

public String getScripts(String appPath,
                         HashMap<String,Object> params)
                  throws IOException
Deprecated. since 1.5.0, use getAnnotationScript instead Get inline JavaScript's JavaScripts

Parameters:
appPath - base application url (example http://annotation.local:8080/context-path/ )
params - parameters to configure annotation
Returns:
html with inline JavaScript
Throws:
IOException

getAnnotationScript

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

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

getJsHandler

public Object getJsHandler(String script,
                           javax.servlet.http.HttpServletResponse response)
Specified by:
getJsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getCssHandler

public Object getCssHandler(String script,
                            javax.servlet.http.HttpServletResponse response)
Specified by:
getCssHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getImageHandler

public Object getImageHandler(String name,
                              javax.servlet.http.HttpServletResponse response)
Specified by:
getImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getFontHandler

public Object getFontHandler(String fontName,
                             javax.servlet.http.HttpServletResponse response)
Specified by:
getFontHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getHtmlRecoucesHandler

public Object getHtmlRecoucesHandler(String filePath,
                                     javax.servlet.http.HttpServletResponse response)
Specified by:
getHtmlRecoucesHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getFileHandler

@Deprecated
public void getFileHandler(String path,
                                      javax.servlet.http.HttpServletResponse response)
                    throws Exception
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
Throws:
Exception - file not found

getFileHandler

public Object getFileHandler(String path,
                             boolean getPdf,
                             javax.servlet.http.HttpServletResponse response)
Specified by:
getFileHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getDocumentPageImageHandler

public Object getDocumentPageImageHandler(String guid,
                                          Integer width,
                                          Integer quality,
                                          Boolean usePdf,
                                          Integer pageIndex,
                                          javax.servlet.http.HttpServletResponse response)
Specified by:
getDocumentPageImageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

viewDocumentHandler

public Object viewDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
Specified by:
viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

viewDocumentHandler

public Object viewDocumentHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
Specified by:
viewDocumentHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
Specified by:
loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

loadFileBrowserTreeDataHandler

public Object loadFileBrowserTreeDataHandler(String callback,
                                             String data,
                                             javax.servlet.http.HttpServletResponse response)
Specified by:
loadFileBrowserTreeDataHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getPdf2JavaScriptHandler

public Object getPdf2JavaScriptHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
Specified by:
getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getPdf2JavaScriptHandler

public Object getPdf2JavaScriptHandler(String callback,
                                       String data,
                                       javax.servlet.http.HttpServletResponse response)
Specified by:
getPdf2JavaScriptHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getPrintableHtmlHandler

public Object getPrintableHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
Specified by:
getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getPrintableHtmlHandler

public Object getPrintableHtmlHandler(String callback,
                                      String data,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
Specified by:
getPrintableHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getDocumentPageHtmlHandler

public Object getDocumentPageHtmlHandler(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
Specified by:
getDocumentPageHtmlHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getImageUrlsHandler

public Object getImageUrlsHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
Specified by:
getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

getImageUrlsHandler

public Object getImageUrlsHandler(String callback,
                                  String data,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
Specified by:
getImageUrlsHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

listAnnotationsHandler

public Object listAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Get list of annotations [POST request]

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

exportAnnotationsHandler

public Object exportAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Export annotations to PDF [POST request]

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

getPdfVersionOfDocumentHandler

public Object getPdfVersionOfDocumentHandler(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Get document as PDF file [POST request]

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

createAnnotationHandler

public Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Create annotation [POST request]

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

getAvatarHandler

public Object getAvatarHandler(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               String userId)
Description copied from class: GroupDocsAnnotation
Get user avatar image [GET request]

Specified by:
getAvatarHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
userId - user id
Returns:
object with respective parameters

addAnnotationReplyHandler

public Object addAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Add reply to annotation [POST request]

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

editAnnotationReplyHandler

public Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Edit annotation reply [POST request]

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

deleteAnnotationReplyHandler

public Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Delete annotation reply [POST request]

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

deleteAnnotationHandler

public Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Delete annotation [POST request]

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

saveTextFieldHandler

public Object saveTextFieldHandler(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Save changes in text of annotation [POST request]

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

setTextFieldColorHandler

public Object setTextFieldColorHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Set color to text annotation [POST request]

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

moveAnnotationMarkerHandler

public Object moveAnnotationMarkerHandler(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Move marker of annotation [POST request]

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

resizeAnnotationHandler

public Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Change annotation size [POST request]

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

getDocumentCollaboratorsHandler

public Object getDocumentCollaboratorsHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Return list of collaborators [POST request]

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

getConfiguration

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

Returns:
service configuration

addCollaborator

public String addCollaborator(String userName,
                              String fileGuid,
                              AccessRights accessRights,
                              int color)
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

addCollaborator

public String addCollaborator(String userName,
                              String fileGuid,
                              Integer accessRights,
                              int color)
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

uploadFileHandler

public Object uploadFileHandler(String userId,
                                String fld,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws Exception
Description copied from class: GroupDocsAnnotation
Upload file for import [POST request]

Specified by:
uploadFileHandler in class GroupDocsAnnotation
Parameters:
userId - user id
fld - action
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with response parameters
Throws:
Exception

uploadFileHandler

@Deprecated
public Object uploadFileHandler(String userGuid,
                                           String fld,
                                           String uploadFileName,
                                           InputStream uploadInputStream,
                                           int timeToLive,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
Deprecated. 


uploadFileHandler

public 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 Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Import document with annotations [POST request]

Specified by:
importAnnotationsHandler in class GroupDocsAnnotation
Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
object with response parameters

getPrintViewHandler

public Object getPrintViewHandler(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
Description copied from class: GroupDocsAnnotation
Get view for print document [POST request]

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

getPdfWithPrintDialog

public Object getPdfWithPrintDialog(String path,
                                    javax.servlet.http.HttpServletResponse response)
Specified by:
getPdfWithPrintDialog in class com.groupdocs.viewer.resources.GroupDocsViewer

reorderPageHandler

public Object reorderPageHandler(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
Specified by:
reorderPageHandler in class com.groupdocs.viewer.resources.GroupDocsViewer

onAtmosphereReady

public void onAtmosphereReady(org.atmosphere.cpr.AtmosphereResource resource)
Description copied from class: GroupDocsAnnotation
On ready handler [POST request]

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

onAtmosphereMessage

public void onAtmosphereMessage(org.atmosphere.cpr.AtmosphereResource resource)
Description copied from class: GroupDocsAnnotation
On message handler [POST request]

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

sendMessage

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

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


Copyright © 2014. All rights reserved.