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 path) Create an editor config for given config node.
DocumentContent	getContent(String userId, String fileKey) Get file content.
Config	getEditor(String userId, String workspace, String path) Return existing editor for given user and node.
ChangeState	getState(String userId, String fileKey) Local state of editing document.
void	removeListener(OnlyofficeEditorListener listener) Remove listener from the service.
void	updateDocument(String userId, DocumentStatus status) Update a config 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 for given user and node. If user not valid or editor not open for given node then null will be returned.

Parameters:

userId - String

workspace - String

path - String

Returns:

Config or null

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

createEditor

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

Create an editor config for given config node.

Parameters:

userSchema - the schema

userHost - the host

userId - String

workspace - String

path - 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 config 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

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