Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.groupdocs.annotation.handler
Class AnnotationHandler

java.lang.Object
  extended by AnnotationHandlerBase
      extended by com.groupdocs.annotation.handler.AnnotationHandler

public class AnnotationHandler
extends AnnotationHandlerBase

Annotation handler

Author:
Alex Bobkov

Field Summary
protected  com.groupdocs.viewer.handlers.ViewerHandler viewerHandler
           
 
Constructor Summary
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config)
          Constructor with basic configuration
AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config, IConnector connector)
          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, IConnector connector)
          Constructor with basic configuration, custom input data handler and custom database connector
 
Method Summary
 AddAnnotationReplyResult addAnnotationReply(String annotationGuid, String userGuid, String fieldText, String parentReplyGuid, String connectionId)
          Add annotation reply
 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
 CreateAnnotationResult createAnnotation(String fileGuid, Position position, Rectangle rectangle, AnnotationType annotationType, String userGuid, int pageNumber, String svgPath, String textField, String connectionId)
          Create annotation
 Object createAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Create annotation handler
 DeleteAnnotationResult deleteAnnotation(String userGuid, String annotationGuid, String connectionId)
          Delete annotation
 Object deleteAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation handler
 DeleteAnnotationReplyResult deleteAnnotationReply(String replyGuid, String annotationGuid, String connectionId)
          Delete annotation reply handler
 Object deleteAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Delete annotation reply handler
 EditAnnotationReplyResult editAnnotationReply(String replyGuid, String replyText, String connectionId, String annotationGuid)
          Edit annotation reply handler
 Object editAnnotationReplyHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Edit annotation reply handler
 ExportAnnotationsResult exportAnnotations(String fileGuid, ExportType exportType, Integer mode, String applicationPath, boolean isWithComments)
          Export annotations to file
 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
 void getAvatar(String userGuid, OutputStream outputStream)
          Get avatar handler
 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.
 GetDocumentCollaboratorsResult getDocumentCollaborators(String fileGuid, String userGuid)
          Get document collaborators
 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 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]
 void getPrintDocumentPageImage(String documentGuid, Integer pageIndex, OutputStream outputStream)
          Get image file for print [GET request]
 Object getPrintDocumentPageImageHandler(String guid, Integer pageIndex, javax.servlet.http.HttpServletResponse response)
          Get image file for print [GET request]
 GetPrintViewResult getPrintView(String documentGuid, String applicationPath)
          Return printable HTML string
 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
 ImportAnnotationsResult importAnnotations(String fileGuid, String userGuid)
          Import annotations from PDF file
 Object importAnnotationsHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Import annotations from PDF file
 ListAnnotationsResult listAnnotations(String fileGuid)
          List annotations for document
 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]
 MoveAnnotationMarkerResult moveAnnotationMarker(String annotationGuid, Double annotationLeft, Double annotationTop, String connectionId)
          Move annotation handler
 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
 ResizeAnnotationResult resizeAnnotation(String annotationGuid, Double width, Double height, String connectionId)
          Resize annotation handler
 Object resizeAnnotationHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Resize annotation handler
 RestoreAnnotationRepliesResult restoreAnnotationReplies(RestoreAnnotationRepliesData restoreAnnotationRepliesData)
          Restore annotation replies [POST request]
 Object restoreAnnotationRepliesHandler(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Restore annotation replies [POST request]
 SaveTextFieldResult saveTextField(String annotationGuid, String text, String fontFamily, Float fontSize, String connectionId)
          Save annotation text field 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
 SetTextFieldColorResult setTextFieldColor(String annotationGuid, String connectionId, Integer fontColor)
          Set annotation text field handler
 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
 UploadFileResult uploadFile(String uploadFileName, InputStream uploadInputStream)
          Upload file
 Object uploadFileHandler(String uploadFileName, InputStream uploadInputStream)
          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,
                         IConnector connector)
Constructor with basic configuration and custom database connector

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

AnnotationHandler

public AnnotationHandler(com.groupdocs.viewer.config.ServiceConfiguration config,
                         com.groupdocs.viewer.handlers.input.InputDataHandler inputDataHandler,
                         IConnector connector)
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
connector - custom 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 - HTTP servlet 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 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

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

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

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

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

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

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

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,
                                                     Integer pageIndex,
                                                     javax.servlet.http.HttpServletResponse response)
Get image file for print [GET request]

Parameters:
guid - Relative path to file from base path directory (ex: folder/example.doc or example.doc)
pageIndex - Page number
response - HTTP servlet response
Returns:
output stream

restoreAnnotationRepliesHandler

public Object restoreAnnotationRepliesHandler(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
Restore annotation replies [POST request]

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

restoreAnnotationReplies

public RestoreAnnotationRepliesResult restoreAnnotationReplies(RestoreAnnotationRepliesData restoreAnnotationRepliesData)
                                                        throws AnnotationException
Restore annotation replies [POST request]

Parameters:
restoreAnnotationRepliesData - restore annotation replies data
Returns:
result object
Throws:
AnnotationException

getPrintDocumentPageImage

public final void getPrintDocumentPageImage(String documentGuid,
                                            Integer pageIndex,
                                            OutputStream outputStream)
                                     throws AnnotationException
Get image file for print [GET request]

Parameters:
documentGuid - Relative path to file from base path directory

(ex: folder/example.doc or example.doc)

pageIndex - Page number
outputStream - stream to write result image
Throws:
AnnotationException

viewDocumentHandler

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

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

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]

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]

Parameters:
callback - callback method name
data - request data
response - HTTP servlet response
Returns:
response object

getPrintableHtmlHandler

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

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]

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]

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]

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

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

listAnnotations

public final ListAnnotationsResult listAnnotations(String fileGuid)
                                            throws AnnotationException
List annotations for document

Parameters:
fileGuid - document guid
Returns:
list annotations response object
Throws:
AnnotationException

exportAnnotationsHandler

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

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

exportAnnotations

public ExportAnnotationsResult exportAnnotations(String fileGuid,
                                                 ExportType exportType,
                                                 Integer mode,
                                                 String applicationPath,
                                                 boolean isWithComments)
                                          throws AnnotationException
Export annotations to file

Parameters:
applicationPath - application path (http://127.0.0.1:8080/document-annotation/)
isWithComments - add comments to exported document
Returns:
export annotation response
Throws:
AnnotationException

createAnnotationHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

createAnnotation

public final CreateAnnotationResult createAnnotation(String fileGuid,
                                                     Position position,
                                                     Rectangle rectangle,
                                                     AnnotationType annotationType,
                                                     String userGuid,
                                                     int pageNumber,
                                                     String svgPath,
                                                     String textField,
                                                     String connectionId)
                                              throws AnnotationException
Create annotation

Parameters:
fileGuid - file guid
position - annotation position
rectangle - annotation rectangle
annotationType - annotation type
userGuid - guid of user
pageNumber - page number
svgPath - svg path
textField - field text
Returns:
Create annotation result
Throws:
AnnotationException

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
userGuid - user id
Returns:
null

getAvatar

public final void getAvatar(String userGuid,
                            OutputStream outputStream)
                     throws AnnotationException
Get avatar handler

Parameters:
userGuid - guid of user for get avatar
outputStream - output stream to write avatar data
Throws:
AnnotationException

addAnnotationReplyHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

addAnnotationReply

public final AddAnnotationReplyResult addAnnotationReply(String annotationGuid,
                                                         String userGuid,
                                                         String fieldText,
                                                         String parentReplyGuid,
                                                         String connectionId)
                                                  throws AnnotationException
Add annotation reply

Parameters:
annotationGuid - annotation guid
userGuid - guid of user
fieldText - field text
parentReplyGuid - parent reply guid
connectionId - connection id
Returns:
add annotation reply result object
Throws:
AnnotationException

editAnnotationReplyHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

editAnnotationReply

public final EditAnnotationReplyResult editAnnotationReply(String replyGuid,
                                                           String replyText,
                                                           String connectionId,
                                                           String annotationGuid)
                                                    throws AnnotationException
Edit annotation reply handler

Parameters:
replyGuid - reply guid
replyText - reply text
connectionId - connection id
annotationGuid - annotation guid
Returns:
edit annotation reply result
Throws:
AnnotationException

deleteAnnotationReplyHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

deleteAnnotationReply

public final DeleteAnnotationReplyResult deleteAnnotationReply(String replyGuid,
                                                               String annotationGuid,
                                                               String connectionId)
                                                        throws AnnotationException
Delete annotation reply handler

Parameters:
replyGuid - reply guid
annotationGuid - annotation guid
connectionId - connection id
Returns:
delete annotation reply result
Throws:
AnnotationException

deleteAnnotationHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

deleteAnnotation

public final DeleteAnnotationResult deleteAnnotation(String userGuid,
                                                     String annotationGuid,
                                                     String connectionId)
                                              throws AnnotationException
Delete annotation

Parameters:
userGuid - guid of user
annotationGuid - annotation guid
connectionId - connection id
Returns:
delete annotation result object
Throws:
AnnotationException

saveTextFieldHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

saveTextField

public final SaveTextFieldResult saveTextField(String annotationGuid,
                                               String text,
                                               String fontFamily,
                                               Float fontSize,
                                               String connectionId)
                                        throws AnnotationException
Save annotation text field handler

Parameters:
annotationGuid - annotation guid
text - fieldText
fontFamily - fontFamily
fontSize - font size
connectionId - connection id
Returns:
save text field result
Throws:
AnnotationException

setTextFieldColorHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

setTextFieldColor

public final SetTextFieldColorResult setTextFieldColor(String annotationGuid,
                                                       String connectionId,
                                                       Integer fontColor)
                                                throws AnnotationException
Set annotation text field handler

Parameters:
annotationGuid - annotation guid
connectionId - connection id
fontColor - font color
Returns:
set text field color result object
Throws:
AnnotationException

moveAnnotationMarkerHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

moveAnnotationMarker

public final MoveAnnotationMarkerResult moveAnnotationMarker(String annotationGuid,
                                                             Double annotationLeft,
                                                             Double annotationTop,
                                                             String connectionId)
                                                      throws AnnotationException
Move annotation handler

Parameters:
annotationGuid - annotation guid
annotationLeft - annotation left
annotationTop - annotation top
connectionId - connection id
Returns:
move annotation marker result object
Throws:
AnnotationException

resizeAnnotationHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

resizeAnnotation

public final ResizeAnnotationResult resizeAnnotation(String annotationGuid,
                                                     Double width,
                                                     Double height,
                                                     String connectionId)
                                              throws AnnotationException
Resize annotation handler

Parameters:
annotationGuid - annotation guid
width - annotation width
height - annotation height
connectionId - connection id
Returns:
resize annotation result object
Throws:
AnnotationException

getDocumentCollaboratorsHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
response object

getDocumentCollaborators

public final GetDocumentCollaboratorsResult getDocumentCollaborators(String fileGuid,
                                                                     String userGuid)
                                                              throws AnnotationException
Get document collaborators

Parameters:
fileGuid - document guid
userGuid - guid of user
Returns:
document collaborators result
Throws:
AnnotationException

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 uploadFileName,
                                      InputStream uploadInputStream)
Upload file for import

Parameters:
uploadFileName - name of uploaded file
uploadInputStream - stream of uploaded file
Returns:
object with response parameters

uploadFile

public final UploadFileResult uploadFile(String uploadFileName,
                                         InputStream uploadInputStream)
                                  throws AnnotationException
Upload file

Parameters:
uploadFileName - name of uploaded file
uploadInputStream - stream of uploaded file
Returns:
upload file result object
Throws:
AnnotationException

importAnnotationsHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
JSON result object

importAnnotations

public ImportAnnotationsResult importAnnotations(String fileGuid,
                                                 String userGuid)
                                          throws AnnotationException
Import annotations from PDF file

Parameters:
fileGuid - document guid
userGuid - guid of user
Returns:
import annotations request
Throws:
AnnotationException

getPrintViewHandler

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

Parameters:
request - HTTP servlet request
response - HTTP servlet response
Returns:
printable HTML string

getPrintView

public final GetPrintViewResult getPrintView(String documentGuid,
                                             String applicationPath)
                                      throws AnnotationException
Return printable HTML string

Parameters:
documentGuid - file guid
applicationPath - applicaion path
Returns:
get print view result object
Throws:
AnnotationException

getPdfWithPrintDialog

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

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

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

Parameters:
resource - resource data received from socket

onAtmosphereMessage

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

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2014. All rights reserved.