org.exoplatform.onlyoffice

Interface OnlyofficeEditorService

All Known Implementing Classes:

OnlyofficeEditorServiceImpl

public interface OnlyofficeEditorService

Created by The eXo Platform SAS.

Version:

$Id: CloudDriveService.java 00000 Feb 14, 2013 pnedonosko $

Author:

Peter Nedonosko

Method Summary

Modifier and Type	Method and Description
void	addListener(OnlyofficeEditorListener listener) Add listener to the service.
boolean	canDownloadBy(String hostName) Check does given host can download document content by this service.
Config	createEditor(String userSchema, String userHost, String userId, String workspace, String docId) Create an editor configuration for given user and node.
DocumentContent	getContent(String userId, String fileKey) Get file content.
javax.jcr.Node	getDocument(String workspace, String id) Gets the document node by its ID and optionally a repository workspace.
Config	getEditor(String userId, String workspace, String path) Return existing editor configuration for given user and node.
Config	getEditorByKey(String userId, String key) Return existing editor for given temporal key.
String	getEditorLink(String schema, String host, String workspace, String docId) Gets the editor page URL for opening at Platform server.
ChangeState	getState(String userId, String fileKey) Local state of editing document.
String	initDocument(javax.jcr.Node node) Inits the document and returns an ID for use within editors.
String	initDocument(String workspace, String path) Inits the document and returns an ID for use within editors.
void	removeListener(OnlyofficeEditorListener listener) Remove listener from the service.
void	updateDocument(String userId, DocumentStatus status) Update a configuration associated with given editor Config instance.

Method Detail

getEditor

Config getEditor(String userId,
                 String workspace,
                 String path)
          throws OnlyofficeEditorException,
                 javax.jcr.RepositoryException

Return existing editor configuration for given user and node. If editor not open for given node or user then null will be returned. If user not valid then OnlyofficeEditorException will be thrown.

Parameters:

userId - String

workspace - String

path - String

Returns:

Config or null

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

getEditorByKey

Config getEditorByKey(String userId,
                      String key)
               throws OnlyofficeEditorException,
                      javax.jcr.RepositoryException

Return existing editor for given temporal key. If editor or user not found then null will be returned. If user not valid then OnlyofficeEditorException will be thrown.

Parameters:

userId - the user id

key - the key, see getEditor(String, String, String)

Returns:

the editor by key

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

createEditor

Config createEditor(String userSchema,
                    String userHost,
                    String userId,
                    String workspace,
                    String docId)
             throws OnlyofficeEditorException,
                    javax.jcr.RepositoryException

Create an editor configuration for given user and node.

Parameters:

userSchema - the schema

userHost - the host

userId - String

workspace - String

docId - String a document reference in the workspace, see initDocument(String, String)

Returns:

Config instance in case of successful creation or null if local file type not supported.

Throws:

OnlyofficeEditorException - if editor exception happened

javax.jcr.RepositoryException - if storage exception happened

updateDocument

void updateDocument(String userId,
                    DocumentStatus status)
             throws OnlyofficeEditorException,
                    javax.jcr.RepositoryException

Update a configuration associated with given editor Config instance. A Node from that the config was created will be updated. This operation will close the editor and it will not be usable after that.

Parameters:

userId - String

status - DocumentStatus

Throws:

OnlyofficeEditorException - if editor exception happened

javax.jcr.RepositoryException - if storage exception happened

initDocument

String initDocument(javax.jcr.Node node)
             throws OnlyofficeEditorException,
                    javax.jcr.RepositoryException

Inits the document and returns an ID for use within editors. Node will be saved by this method.

Parameters:

node - the node of the document

Returns:

the string with document ID for use within editors

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

initDocument

String initDocument(String workspace,
                    String path)
             throws OnlyofficeEditorException,
                    javax.jcr.RepositoryException

Inits the document and returns an ID for use within editors. Node will be saved by this method.

Parameters:

workspace - the workspace

path - the path

Returns:

the string

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

getEditorLink

String getEditorLink(String schema,
                     String host,
                     String workspace,
                     String docId)

Gets the editor page URL for opening at Platform server.

Parameters:

schema - the schema

host - the host

workspace - the workspace

docId - the doc ID

Returns:

the editor link

getDocument

javax.jcr.Node getDocument(String workspace,
                           String id)
                    throws javax.jcr.RepositoryException

Gets the document node by its ID and optionally a repository workspace.

Parameters:

workspace - the workspace, can be null, then a default one will be used

id - the ID of a document

Returns:

the document or null if nothing found

Throws:

javax.jcr.RepositoryException - the repository exception

getContent

DocumentContent getContent(String userId,
                           String fileKey)
                    throws OnlyofficeEditorException,
                           javax.jcr.RepositoryException

Get file content.

Parameters:

userId - String

fileKey - String

Returns:

DocumentContent

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

canDownloadBy

boolean canDownloadBy(String hostName)

Check does given host can download document content by this service. It's optional feature, configurable and allow only configured Document server by default.

Parameters:

hostName - String

Returns:

true if client host with given name can download document content, false otherwise.

getState

ChangeState getState(String userId,
                     String fileKey)
              throws OnlyofficeEditorException

Local state of editing document.

Parameters:

userId - String

fileKey - String

Returns:

ChangeState

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

addListener

void addListener(OnlyofficeEditorListener listener)

Add listener to the service.

Parameters:

listener - the listener

removeListener

void removeListener(OnlyofficeEditorListener listener)

Remove listener from the service.

Parameters:

listener - the listener