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

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITOR_OPEN_EVENT

Method Summary

Modifier and Type	Method and Description
void	addClient(String key, String userId, String clientId) Deprecated.
void	addListener(OnlyofficeEditorListener listener) Add listener to the service.
void	addTypePlugin(org.exoplatform.container.component.ComponentPlugin plugin) Adds DocumentTypePlugin to the service to check mimetypes of documents.
boolean	canDownloadBy(String hostName) Check does given host can download document content by this service.
boolean	canEditDocument(javax.jcr.Node node) Checks if the node isn't locked and can be edited by the current user.
Config	createEditor(String userSchema, String userHost, int userPost, String userId, String workspace, String docId) Create an editor configuration for given user and node.
void	downloadVersion(String key, String userId, String contentUrl) Creates a new version of a document.
DocumentContent	getContent(String userId, String fileKey) Get file content.
javax.jcr.Node	getDocument(String workspace, String path) Gets the document node by its path and optionally a repository workspace.
javax.jcr.Node	getDocumentById(String workspace, String uuid) Gets the document node by its id and optionally a repository workspace.
String	getDocumentId(javax.jcr.Node node) Gets the document ID for given node.
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(javax.jcr.Node node) Gets the editor page URL for opening at Platform server relatively to the current PortalRequest.
String	getEditorLink(String schema, String host, int port, String workspace, String docId) Gets the editor page URL for opening at Platform server.
Config.Editor.User	getLastModifier(String key) Gets the last modifier userId.
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.
boolean	isDocumentMimeSupported(javax.jcr.Node node) Checks if the node has compatible mime-types.
void	removeClient(String key, String userId, String clientId) Deprecated.
void	removeListener(OnlyofficeEditorListener listener) Remove listener from the service.
void	setLastModifier(String key, String userId) Sets the last modifier userId.
void	updateDocument(String userId, DocumentStatus status) Update a configuration associated with given editor Config instance.

Field Detail

EDITOR_OPEN_EVENT

static final String EDITOR_OPEN_EVENT

See Also:

Constant Field Values

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,
                    int userPost,
                    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

userPost - the user post

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 may be saved by this method if ID generation will be required, in this case it should be allowed to edit the node (not locked and user has write permissions).

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(javax.jcr.Node node)
              throws OnlyofficeEditorException,
                     javax.jcr.RepositoryException

Gets the editor page URL for opening at Platform server relatively to the current PortalRequest.

Parameters:

node - the node

Returns:

the editor link

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

getEditorLink

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

Gets the editor page URL for opening at Platform server.

Parameters:

schema - the schema

host - the host

port - the port

workspace - the workspace

docId - the doc ID

Returns:

the editor link

getDocument

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

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

Parameters:

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

path - the path of a document

Returns:

the document or null if nothing found

Throws:

javax.jcr.RepositoryException - the repository exception

BadParameterException - the bad parameter exeption

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

addTypePlugin

void addTypePlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Adds DocumentTypePlugin to the service to check mimetypes of documents.

Parameters:

plugin - - the plugin to be added

canEditDocument

boolean canEditDocument(javax.jcr.Node node)
                 throws javax.jcr.RepositoryException

Checks if the node isn't locked and can be edited by the current user.

Parameters:

node - the node

Returns:

true, if the current user can edit the node

Throws:

javax.jcr.RepositoryException - the repository exeption

getDocumentId

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

Gets the document ID for given node. It will return an ID for use within an editor, otherwise null will be returned.

Parameters:

node - the node

Returns:

the document ID or null

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

See Also:

initDocument(String, String), canEditDocument(Node)

isDocumentMimeSupported

boolean isDocumentMimeSupported(javax.jcr.Node node)
                         throws javax.jcr.RepositoryException

Checks if the node has compatible mime-types.

Parameters:

node - the node

Returns:

true, if the node mime-types are supported

Throws:

javax.jcr.RepositoryException - the repository exeption

getDocumentById

javax.jcr.Node getDocumentById(String workspace,
                               String uuid)
                        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

uuid - the id of a document

Returns:

the document or null if nothing found

Throws:

javax.jcr.RepositoryException - the repository exception

downloadVersion

void downloadVersion(String key,
                     String userId,
                     String contentUrl)

Creates a new version of a document.

Parameters:

key - the key

userId - the userId

contentUrl - the contentUrl

getLastModifier

Config.Editor.User getLastModifier(String key)

Gets the last modifier userId.

Parameters:

key - the key

Returns:

the editor user

setLastModifier

void setLastModifier(String key,
                     String userId)

Sets the last modifier userId.

Parameters:

key - the key

userId - the userId

removeClient

@Deprecated
void removeClient(String key,
                              String userId,
                              String clientId)

Deprecated.

Removes user's client.

Parameters:

key - the key

userId - the userId

clientId - the clientId

addClient

@Deprecated
void addClient(String key,
                           String userId,
                           String clientId)

Deprecated.

Adds user's client.

Parameters:

key - the key

userId - the userId

clientId - the clientId