org.exoplatform.onlyoffice

Class OnlyofficeEditorServiceImpl

java.lang.Object

org.exoplatform.onlyoffice.OnlyofficeEditorServiceImpl

All Implemented Interfaces:

OnlyofficeEditorService, org.picocontainer.Startable

public class OnlyofficeEditorServiceImpl
extends Object
implements OnlyofficeEditorService, org.picocontainer.Startable

Service implementing OnlyofficeEditorService and Startable.
Created by The eXo Platform SAS.

Version:

$Id: OnlyofficeEditorServiceImpl.java 00000 Jan 31, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<String,ConcurrentHashMap<String,Config>>	active Editing documents.
protected URI	baseWebdavUri
protected Map<String,String>	config
static String	CONFIG_DS_ACCESS_ONLY
static String	CONFIG_DS_HOST
static String	CONFIG_DS_SCHEMA
static String	CONFIG_HOST
static String	CONFIG_SCHEMA
protected boolean	documentserverAccessOnly
protected String	documentserverHost
protected String	documentserverUrl
protected Map<String,String>	fileTypes
protected NodeFinder	finder
protected org.exoplatform.services.security.IdentityRegistry	identityRegistry
protected org.exoplatform.services.jcr.RepositoryService	jcrService
protected ConcurrentLinkedQueue<OnlyofficeEditorListener>	listeners
protected static int	LOCK_WAIT_ATTEMTS
protected static long	LOCK_WAIT_TIMEOUT
protected static org.exoplatform.services.log.Log	LOG
protected org.exoplatform.services.organization.OrganizationService	organization
protected String	platformUrl
protected static Random	RANDOM
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders
protected static String	TYPE_PRESENTATION
protected static String	TYPE_SPREADSHEET
protected static String	TYPE_TEXT
protected MessageFormat	uploadParams
protected String	uploadUrl

Constructor Summary

Constructors

Constructor and Description

OnlyofficeEditorServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.security.IdentityRegistry identityRegistry, NodeFinder finder, org.exoplatform.services.organization.OrganizationService organization, org.exoplatform.container.xml.InitParams params) Cloud Drive service with storage in JCR and with managed features.

Method Summary

Methods

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.
protected javax.jcr.version.Version	checkin(javax.jcr.Node node) Deprecated.
protected boolean	checkout(javax.jcr.Node node)
Config	createEditor(String userId, String workspace, String path) Create an editor config for given config node.
protected javax.jcr.Property	data(javax.jcr.Node content)
protected String	documentType(String fileType)
protected void	download(Config config, DocumentStatus status)
protected void	downloadChange(Config config) Deprecated.
protected String	fileType(javax.jcr.Node node)
protected void	fireCreated(Config config)
protected void	fireError(Config config)
protected void	fireGet(Config config)
protected void	fireJoined(Config config)
protected void	fireLeaved(Config config)
protected void	fireSaved(Config config)
protected UUID	generateId(String workspace, String path)
DocumentContent	getContent(String userId, String key) Get file content.
protected String[]	getCurrentUsers(ConcurrentHashMap<String,Config> configs)
protected Config	getEditor(String userId, String nodePath)
Config	getEditor(String userId, String workspace, String path) Return existing editor for given user and node.
ChangeState	getState(String userId, String key) Local state of editing document.
protected org.exoplatform.services.organization.User	getUser(String username)
protected String	getUserLang(String userId)
protected javax.jcr.lock.Lock	lock(javax.jcr.Node node, Config config) Lock by current user of the node.
protected String	mimeType(javax.jcr.Node content)
protected javax.jcr.Node	node(String workspace, String path)
protected javax.jcr.Node	nodeContent(javax.jcr.Node node)
protected Calendar	nodeCreated(javax.jcr.Node node)
protected String	nodePath(Config config)
protected String	nodePath(String workspace, String path)
protected String	nodeTitle(javax.jcr.Node node)
void	removeListener(OnlyofficeEditorListener listener) Remove listener from the service.
void	start() On-start initializer.
void	stop() On-stop finalizer.
protected void	syncUsers(ConcurrentHashMap<String,Config> configs, String[] users)
protected javax.jcr.Node	systemNode(String workspace, String path)
protected void	trackChange(Config config, DocumentStatus status) Deprecated.
protected boolean	unlock(javax.jcr.Node node, Config config) Deprecated.
void	updateDocument(String userId, DocumentStatus status) Update a config associated with given editor Config instance.
protected String	uploadContent(InputStream localContent, String fileKey, String mimeType, long length) Deprecated.
protected void	validateUser(String userId, Config config)
protected String	webdavUrl(String workspace, String path)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.exoplatform.services.log.Log LOG

RANDOM

protected static final Random RANDOM

CONFIG_HOST

public static final String CONFIG_HOST

See Also:

Constant Field Values

CONFIG_SCHEMA

public static final String CONFIG_SCHEMA

See Also:

Constant Field Values

CONFIG_DS_HOST

public static final String CONFIG_DS_HOST

See Also:

Constant Field Values

CONFIG_DS_SCHEMA

public static final String CONFIG_DS_SCHEMA

See Also:

Constant Field Values

CONFIG_DS_ACCESS_ONLY

public static final String CONFIG_DS_ACCESS_ONLY

See Also:

Constant Field Values

TYPE_TEXT

protected static final String TYPE_TEXT

See Also:

Constant Field Values

TYPE_SPREADSHEET

protected static final String TYPE_SPREADSHEET

See Also:

Constant Field Values

TYPE_PRESENTATION

protected static final String TYPE_PRESENTATION

See Also:

Constant Field Values

LOCK_WAIT_ATTEMTS

protected static final int LOCK_WAIT_ATTEMTS

See Also:

Constant Field Values

LOCK_WAIT_TIMEOUT

protected static final long LOCK_WAIT_TIMEOUT

See Also:

Constant Field Values

jcrService

protected final org.exoplatform.services.jcr.RepositoryService jcrService

sessionProviders

protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders

identityRegistry

protected final org.exoplatform.services.security.IdentityRegistry identityRegistry

finder

protected final NodeFinder finder

organization

protected final org.exoplatform.services.organization.OrganizationService organization

active

protected final ConcurrentHashMap<String,ConcurrentHashMap<String,Config>> active

Editing documents.

config

protected final Map<String,String> config

platformUrl

protected final String platformUrl

uploadUrl

protected final String uploadUrl

documentserverHost

protected final String documentserverHost

documentserverUrl

protected final String documentserverUrl

documentserverAccessOnly

protected final boolean documentserverAccessOnly

baseWebdavUri

protected final URI baseWebdavUri

fileTypes

protected final Map<String,String> fileTypes

uploadParams

protected final MessageFormat uploadParams

listeners

protected final ConcurrentLinkedQueue<OnlyofficeEditorListener> listeners

Constructor Detail

OnlyofficeEditorServiceImpl

public OnlyofficeEditorServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService,
                           org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                           org.exoplatform.services.security.IdentityRegistry identityRegistry,
                           NodeFinder finder,
                           org.exoplatform.services.organization.OrganizationService organization,
                           org.exoplatform.container.xml.InitParams params)
                            throws org.exoplatform.container.configuration.ConfigurationException

Cloud Drive service with storage in JCR and with managed features.

Parameters:

jcrService - RepositoryService

sessionProviders - SessionProviderService

features - CloudDriveFeatures

Throws:

org.exoplatform.container.configuration.ConfigurationException

Method Detail

addListener

public void addListener(OnlyofficeEditorListener listener)

Add listener to the service.

Specified by:

addListener in interface OnlyofficeEditorService

removeListener

public void removeListener(OnlyofficeEditorListener listener)

Remove listener from the service.

Specified by:

removeListener in interface OnlyofficeEditorService

getEditor

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

Specified by:

getEditor in interface OnlyofficeEditorService

Parameters:

userId - String

workspace - String

path - String

Returns:

Config or null

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

getEditor

protected Config getEditor(String userId,
               String nodePath)
                    throws OnlyofficeEditorException,
                           javax.jcr.RepositoryException

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

createEditor

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

Create an editor config for given config node.

Specified by:

createEditor in interface OnlyofficeEditorService

Parameters:

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

getContent

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

Get file content.

Specified by:

getContent in interface OnlyofficeEditorService

Parameters:

userId - String

key - String

Returns:

DocumentContent

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

canDownloadBy

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

Specified by:

canDownloadBy in interface OnlyofficeEditorService

Parameters:

hostName - String

Returns:

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

getState

public ChangeState getState(String userId,
                   String key)
                     throws OnlyofficeEditorException

Local state of editing document.

Specified by:

getState in interface OnlyofficeEditorService

Parameters:

userId - String

key - String

Returns:

ChangeState

Throws:

OnlyofficeEditorException

updateDocument

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

Specified by:

updateDocument in interface OnlyofficeEditorService

Parameters:

userId - String

status - DocumentStatus

Throws:

OnlyofficeEditorException - if editor exception happened

javax.jcr.RepositoryException - if storage exception happened

start

public void start()

On-start initializer.

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

On-stop finalizer.

Specified by:

stop in interface org.picocontainer.Startable

nodeTitle

protected String nodeTitle(javax.jcr.Node node)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

fileType

protected String fileType(javax.jcr.Node node)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

documentType

protected String documentType(String fileType)

nodeContent

protected javax.jcr.Node nodeContent(javax.jcr.Node node)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

nodeCreated

protected Calendar nodeCreated(javax.jcr.Node node)
                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

mimeType

protected String mimeType(javax.jcr.Node content)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

data

protected javax.jcr.Property data(javax.jcr.Node content)
                           throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

generateId

protected UUID generateId(String workspace,
              String path)

nodePath

protected String nodePath(String workspace,
              String path)

nodePath

protected String nodePath(Config config)

getUser

protected org.exoplatform.services.organization.User getUser(String username)
                                                      throws OnlyofficeEditorException

Throws:

OnlyofficeEditorException

webdavUrl

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

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

uploadContent

@Deprecated
protected String uploadContent(InputStream localContent,
                              String fileKey,
                              String mimeType,
                              long length)
                        throws IOException,
                               OnlyofficeEditorException

Deprecated.

Throws:

IOException

OnlyofficeEditorException

syncUsers

protected void syncUsers(ConcurrentHashMap<String,Config> configs,
             String[] users)

getCurrentUsers

protected String[] getCurrentUsers(ConcurrentHashMap<String,Config> configs)

download

protected void download(Config config,
            DocumentStatus status)
                 throws OnlyofficeEditorException,
                        javax.jcr.RepositoryException

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

downloadChange

@Deprecated
protected void downloadChange(Config config)
                       throws OnlyofficeEditorException,
                              javax.jcr.RepositoryException

Deprecated.

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

trackChange

@Deprecated
protected void trackChange(Config config,
                          DocumentStatus status)
                    throws BadParameterException,
                           OnlyofficeEditorException,
                           javax.jcr.RepositoryException

Deprecated.

Throws:

BadParameterException

OnlyofficeEditorException

javax.jcr.RepositoryException

node

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

Throws:

BadParameterException

javax.jcr.RepositoryException

systemNode

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

Throws:

BadParameterException

javax.jcr.RepositoryException

checkout

protected boolean checkout(javax.jcr.Node node)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

checkin

@Deprecated
protected javax.jcr.version.Version checkin(javax.jcr.Node node)
                                     throws javax.jcr.RepositoryException

Deprecated.

Throws:

javax.jcr.RepositoryException

lock

protected javax.jcr.lock.Lock lock(javax.jcr.Node node,
                       Config config)
                            throws OnlyofficeEditorException,
                                   javax.jcr.RepositoryException

Lock by current user of the node. If lock attempts will succeed in predefined time this method will throw OnlyofficeEditorException. If node isn't mix:versionable it will be added first and node saved.

Parameters:

node - Node

config - Config

Returns:

Lock acquired by current user.

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

unlock

@Deprecated
protected boolean unlock(javax.jcr.Node node,
                        Config config)
                  throws OnlyofficeEditorException,
                         javax.jcr.RepositoryException

Deprecated.

Throws:

OnlyofficeEditorException

javax.jcr.RepositoryException

validateUser

protected void validateUser(String userId,
                Config config)
                     throws OnlyofficeEditorException

Throws:

OnlyofficeEditorException

getUserLang

protected String getUserLang(String userId)
                      throws OnlyofficeEditorException

Throws:

OnlyofficeEditorException

fireCreated

protected void fireCreated(Config config)

fireGet

protected void fireGet(Config config)

fireJoined

protected void fireJoined(Config config)

fireLeaved

protected void fireLeaved(Config config)

fireSaved

protected void fireSaved(Config config)

fireError

protected void fireError(Config config)