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 org.exoplatform.services.cache.ExoCache<String,ConcurrentHashMap<String,Config>>	activeCache Cache of Editing documents.
protected ReentrantLock	activeLock Lock for updating Editing documents cache.
protected org.exoplatform.services.security.Authenticator	authenticator The authenticator.
static String	CACHE_NAME The Constant CACHE_NAME.
protected Map<String,String>	config The config.
static String	CONFIG_DS_ACCESS_ONLY The Constant CONFIG_DS_ACCESS_ONLY.
static String	CONFIG_DS_HOST The Constant CONFIG_DS_HOST.
static String	CONFIG_DS_SCHEMA The Constant CONFIG_DS_SCHEMA.
protected boolean	documentserverAccessOnly The documentserver access only.
protected String	documentserverHostName The documentserver host name.
protected String	documentserverUrl The documentserver url.
protected static String	EMPTY_TEXT The Constant EMPTY_TEXT.
protected Map<String,String>	fileTypes The file types.
protected NodeFinder	finder The finder.
protected static char	HTTP_PORT_DELIMITER The Constant HTTP_PORT_DELIMITER.
protected org.exoplatform.services.security.IdentityRegistry	identityRegistry The identity registry.
protected org.exoplatform.services.jcr.RepositoryService	jcrService The jcr service.
protected ConcurrentLinkedQueue<OnlyofficeEditorListener>	listeners The listeners.
protected static int	LOCK_WAIT_ATTEMTS The Constant LOCK_WAIT_ATTEMTS.
protected static long	LOCK_WAIT_TIMEOUT The Constant LOCK_WAIT_TIMEOUT.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected org.exoplatform.services.organization.OrganizationService	organization The organization.
protected static Random	RANDOM The Constant RANDOM.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.
protected static String	TYPE_PRESENTATION The Constant TYPE_PRESENTATION.
protected static String	TYPE_SPREADSHEET The Constant TYPE_SPREADSHEET.
protected static String	TYPE_TEXT The Constant TYPE_TEXT.
protected MessageFormat	uploadParams The upload params.
protected String	uploadUrl The upload url.

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.services.security.Authenticator authenticator, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.container.xml.InitParams params) Cloud Drive service with storage in JCR and with managed features.

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.
protected javax.jcr.version.Version	checkin(javax.jcr.Node node) Deprecated.
protected boolean	checkout(javax.jcr.Node node) Checkout.
Config	createEditor(String schema, String host, String userId, String workspace, String path) Create an editor config for given config node.
protected javax.jcr.Property	data(javax.jcr.Node content) Data.
protected String	documentType(String fileType) Document type.
protected void	download(Config config, DocumentStatus status) Download.
protected void	downloadChange(Config config) Deprecated.
protected StringBuilder	editorUrl(String schema, String host) Editor url.
protected String	fileType(javax.jcr.Node node) File type.
protected void	fireCreated(Config config) Fire created.
protected void	fireError(Config config) Fire error.
protected void	fireGet(Config config) Fire get.
protected void	fireJoined(Config config) Fire joined.
protected void	fireLeaved(Config config) Fire leaved.
protected void	fireSaved(Config config) Fire saved.
protected UUID	generateId(String workspace, String path) Generate id.
DocumentContent	getContent(String userId, String key) Get file content.
protected String[]	getCurrentUsers(ConcurrentHashMap<String,Config> configs) Gets the current users.
protected Config	getEditor(String userId, String nodePath) Gets the editor.
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) Gets the user.
protected String	getUserLang(String userId) Gets the user lang.
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) Mime type.
protected javax.jcr.Node	node(String workspace, String path) Node.
protected javax.jcr.Node	nodeContent(javax.jcr.Node node) Node content.
protected Calendar	nodeCreated(javax.jcr.Node node) Node created.
protected String	nodePath(Config config) Node path.
protected String	nodePath(String workspace, String path) Node path.
protected String	nodeTitle(javax.jcr.Node node) Node title.
protected StringBuilder	platformUrl(String schema, String host) Platform url.
void	removeListener(OnlyofficeEditorListener listener) Remove listener from the service.
void	start() On-start initializer.
void	stop() On-stop finalizer.
protected boolean	syncUsers(ConcurrentHashMap<String,Config> configs, String[] users) Sync users.
protected javax.jcr.Node	systemNode(String workspace, String path) System node.
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 org.exoplatform.services.security.Identity	userIdentity(String userId) Find or create user identity.
protected void	validateUser(String userId, Config config) Validate user.
protected URI	webdavUri(String schema, String host) Webdav uri.
protected String	webdavUrl(String schema, String host, String workspace, String path) Webdav url.

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

The Constant LOG.

RANDOM

protected static final Random RANDOM

The Constant RANDOM.

CONFIG_DS_HOST

public static final String CONFIG_DS_HOST

The Constant CONFIG_DS_HOST.

See Also:

Constant Field Values

CONFIG_DS_SCHEMA

public static final String CONFIG_DS_SCHEMA

The Constant CONFIG_DS_SCHEMA.

See Also:

Constant Field Values

CONFIG_DS_ACCESS_ONLY

public static final String CONFIG_DS_ACCESS_ONLY

The Constant CONFIG_DS_ACCESS_ONLY.

See Also:

Constant Field Values

HTTP_PORT_DELIMITER

protected static final char HTTP_PORT_DELIMITER

The Constant HTTP_PORT_DELIMITER.

See Also:

Constant Field Values

TYPE_TEXT

protected static final String TYPE_TEXT

The Constant TYPE_TEXT.

See Also:

Constant Field Values

TYPE_SPREADSHEET

protected static final String TYPE_SPREADSHEET

The Constant TYPE_SPREADSHEET.

See Also:

Constant Field Values

TYPE_PRESENTATION

protected static final String TYPE_PRESENTATION

The Constant TYPE_PRESENTATION.

See Also:

Constant Field Values

LOCK_WAIT_ATTEMTS

protected static final int LOCK_WAIT_ATTEMTS

The Constant LOCK_WAIT_ATTEMTS.

See Also:

Constant Field Values

LOCK_WAIT_TIMEOUT

protected static final long LOCK_WAIT_TIMEOUT

The Constant LOCK_WAIT_TIMEOUT.

See Also:

Constant Field Values

EMPTY_TEXT

protected static final String EMPTY_TEXT

The Constant EMPTY_TEXT.

CACHE_NAME

public static final String CACHE_NAME

The Constant CACHE_NAME.

jcrService

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

The jcr service.

sessionProviders

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

The session providers.

identityRegistry

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

The identity registry.

finder

protected final NodeFinder finder

The finder.

organization

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

The organization.

authenticator

protected final org.exoplatform.services.security.Authenticator authenticator

The authenticator.

activeCache

protected final org.exoplatform.services.cache.ExoCache<String,ConcurrentHashMap<String,Config>> activeCache

Cache of Editing documents.

activeLock

protected final ReentrantLock activeLock

Lock for updating Editing documents cache.

config

protected final Map<String,String> config

The config.

uploadUrl

protected final String uploadUrl

The upload url.

documentserverHostName

protected final String documentserverHostName

The documentserver host name.

documentserverUrl

protected final String documentserverUrl

The documentserver url.

documentserverAccessOnly

protected final boolean documentserverAccessOnly

The documentserver access only.

fileTypes

protected final Map<String,String> fileTypes

The file types.

uploadParams

protected final MessageFormat uploadParams

The upload params.

listeners

protected final ConcurrentLinkedQueue<OnlyofficeEditorListener> listeners

The 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.services.security.Authenticator authenticator,
                                   org.exoplatform.services.cache.CacheService cacheService,
                                   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

identityRegistry - the identity registry

finder - the finder

organization - the organization

authenticator - the authenticator

cacheService - the cache service

params - the params

Throws:

org.exoplatform.container.configuration.ConfigurationException - the configuration exception

Method Detail

addListener

public void addListener(OnlyofficeEditorListener listener)

Add listener to the service.

Specified by:

addListener in interface OnlyofficeEditorService

Parameters:

listener - the listener

removeListener

public void removeListener(OnlyofficeEditorListener listener)

Remove listener from the service.

Specified by:

removeListener in interface OnlyofficeEditorService

Parameters:

listener - the listener

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 - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

getEditor

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

Gets the editor.

Parameters:

userId - the user id

nodePath - the node path

Returns:

the editor

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

createEditor

public Config createEditor(String schema,
                           String host,
                           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:

schema - the schema

host - 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

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 - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

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 - the onlyoffice editor exception

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

Node title.

Parameters:

node - the node

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

fileType

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

File type.

Parameters:

node - the node

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

documentType

protected String documentType(String fileType)

Document type.

Parameters:

fileType - the file type

Returns:

the string

nodeContent

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

Node content.

Parameters:

node - the node

Returns:

the node

Throws:

javax.jcr.RepositoryException - the repository exception

nodeCreated

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

Node created.

Parameters:

node - the node

Returns:

the calendar

Throws:

javax.jcr.RepositoryException - the repository exception

mimeType

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

Mime type.

Parameters:

content - the content

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

data

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

Data.

Parameters:

content - the content

Returns:

the property

Throws:

javax.jcr.RepositoryException - the repository exception

generateId

protected UUID generateId(String workspace,
                          String path)

Generate id.

Parameters:

workspace - the workspace

path - the path

Returns:

the uuid

nodePath

protected String nodePath(String workspace,
                          String path)

Node path.

Parameters:

workspace - the workspace

path - the path

Returns:

the string

nodePath

protected String nodePath(Config config)

Node path.

Parameters:

config - the config

Returns:

the string

getUser

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

Gets the user.

Parameters:

username - the username

Returns:

the user

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

webdavUrl

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

Webdav url.

Parameters:

schema - the schema

host - the host

workspace - the workspace

path - the path

Returns:

the string

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

uploadContent

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

Deprecated.

Upload content.

Parameters:

localContent - the local content

fileKey - the file key

mimeType - the mime type

length - the length

Returns:

the string

Throws:

IOException - Signals that an I/O exception has occurred.

OnlyofficeEditorException - the onlyoffice editor exception

syncUsers

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

Sync users.

Parameters:

configs - the configs

users - the users

Returns:

true, if actually changed editor config user(s)

getCurrentUsers

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

Gets the current users.

Parameters:

configs - the configs

Returns:

the current users

download

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

Download.

Parameters:

config - the config

status - the status

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

downloadChange

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

Deprecated.

Download change.

Parameters:

config - the config

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

trackChange

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

Deprecated.

Track change.

Parameters:

config - the config

status - the status

Throws:

BadParameterException - the bad parameter exception

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

node

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

Node.

Parameters:

workspace - the workspace

path - the path

Returns:

the node

Throws:

BadParameterException - the bad parameter exception

javax.jcr.RepositoryException - the repository exception

systemNode

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

System node.

Parameters:

workspace - the workspace

path - the path

Returns:

the node

Throws:

BadParameterException - the bad parameter exception

javax.jcr.RepositoryException - the repository exception

checkout

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

Checkout.

Parameters:

node - the node

Returns:

true, if successful

Throws:

javax.jcr.RepositoryException - the repository exception

checkin

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

Deprecated.

Checkin.

Parameters:

node - the node

Returns:

the version

Throws:

javax.jcr.RepositoryException - the repository exception

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 - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

unlock

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

Deprecated.

Unlock.

Parameters:

node - the node

config - the config

Returns:

true, if successful

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

javax.jcr.RepositoryException - the repository exception

validateUser

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

Validate user.

Parameters:

userId - the user id

config - the config

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

getUserLang

protected String getUserLang(String userId)
                      throws OnlyofficeEditorException

Gets the user lang.

Parameters:

userId - the user id

Returns:

the user lang can be null if user has no profile or language in it

Throws:

OnlyofficeEditorException - the onlyoffice editor exception

platformUrl

protected StringBuilder platformUrl(String schema,
                                    String host)

Platform url.

Parameters:

schema - the schema

host - the host

Returns:

the string builder

editorUrl

protected StringBuilder editorUrl(String schema,
                                  String host)

Editor url.

Parameters:

schema - the schema

host - the host

Returns:

the string builder

webdavUri

protected URI webdavUri(String schema,
                        String host)
                 throws URISyntaxException

Webdav uri.

Parameters:

schema - the schema

host - the host

Returns:

the uri

Throws:

URISyntaxException - the URI syntax exception

fireCreated

protected void fireCreated(Config config)

Fire created.

Parameters:

config - the config

fireGet

protected void fireGet(Config config)

Fire get.

Parameters:

config - the config

fireJoined

protected void fireJoined(Config config)

Fire joined.

Parameters:

config - the config

fireLeaved

protected void fireLeaved(Config config)

Fire leaved.

Parameters:

config - the config

fireSaved

protected void fireSaved(Config config)

Fire saved.

Parameters:

config - the config

fireError

protected void fireError(Config config)

Fire error.

Parameters:

config - the config

userIdentity

protected org.exoplatform.services.security.Identity userIdentity(String userId)

Find or create user identity.

Returns:

the identity can be null if not found and cannot be created via current authenticator