org.exoplatform.officeonline

Class AbstractOfficeOnlineService

java.lang.Object

org.exoplatform.officeonline.AbstractOfficeOnlineService

All Implemented Interfaces:

org.picocontainer.Startable

Direct Known Subclasses:

EditorService, WOPIService

public abstract class AbstractOfficeOnlineService
extends Object
implements org.picocontainer.Startable

The Class AbstractOfficeOnlineService.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALGORITHM The Constant ALGORITHM.
protected org.exoplatform.services.security.Authenticator	authenticator The authenticator.
protected org.exoplatform.services.cms.documents.DocumentService	documentService The document service.
protected static String	EXO_DATE_MODIFIED The Constant EXO_DATE_MODIFIED.
protected static String	EXO_LAST_MODIFIED_DATE The Constant EXO_LAST_MODIFIED_DATE.
protected static String	EXO_LAST_MODIFIER The Constant EXO_LAST_MODIFIER.
protected static String	EXO_NAME The Constant EXO_NAME.
protected static String	EXO_OWNER The Constant EXO_OWNER.
protected static String	EXO_PRIVILEGEABLE The Constant EXO_PRIVILEGEABLE.
protected static String	EXO_TITLE The Constant EXO_TITLE.
protected org.exoplatform.services.security.IdentityRegistry	identityRegistry The identity registry.
protected static String	JCR_CONTENT The Constant JCR_CONTENT.
protected static String	JCR_DATA The Constant JCR_DATA.
protected static String	JCR_LAST_MODIFIED The Constant JCR_LAST_MODIFIED.
protected static String	JCR_MIME_TYPE The Constant JCR_MIME_TYPE.
protected org.exoplatform.services.jcr.RepositoryService	jcrService The jcr service.
static String	KEY_CACHE_NAME The Constant KEY_CACHE_NAME.
protected org.exoplatform.services.cache.ExoCache<String,Key>	keyCache Cache of Editing documents.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String	MIX_VERSIONABLE The Constant MIX_VERSIONABLE.
protected static String	MSOFFICE_FILE The Constant MSOFFICE_FILE.
protected static String	MSOFFICE_PREFERENCES The Constant MSOFFICE_PREFERENCES.
protected static String	MSOFFICE_USER_PREFERENCES The Constant MSOFFICE_USER_PREFERENCES.
protected org.exoplatform.services.cms.link.NodeFinder	nodeFinder The node finder.
protected org.exoplatform.services.organization.OrganizationService	organization The organization.
protected static String	PATH The Constant PATH.
protected static String	SECRET_KEY The Constant SECRET_KEY.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.
protected static String	TOKEN_DELIMITER The Constant TOKEN_DELIMITER.
protected static String	TOKEN_DELIMITER_PATTERN The Constant TOKEN_DELIMITER_PATTERN.
protected static long	TOKEN_EXPIRES The Constant TOKEN_EXPIRES.
protected org.exoplatform.portal.config.UserACL	userACL The user ACL.
protected static String	UTF_8 The Constant UTF_8.
protected static String	WOPITEST The Constant WOPITEST.
protected static String	WOPITESTX The Constant WOPITESTX.

Constructor Summary

Constructors

Constructor and Description

AbstractOfficeOnlineService(org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.organization.OrganizationService organization, org.exoplatform.services.cms.documents.DocumentService documentService, org.exoplatform.services.cache.CacheService cacheService, org.exoplatform.portal.config.UserACL userACL, org.exoplatform.services.security.IdentityRegistry identityRegistry, org.exoplatform.services.security.Authenticator authenticator, org.exoplatform.services.cms.link.NodeFinder nodeFinder) Instantiates a new abstract office online service.

Method Summary

Modifier and Type	Method and Description
void	addFilePreferences(javax.jcr.Node node, String userId, String path) Addds file preferences to the node (path for opening shared doc for particular user).
EditorConfig	buildEditorConfig(String token) Builds the editor config.
EditorConfig	createEditorConfig(String userId, String fileId, String workspace, RequestInfo requestInfo) Creates the editor config.
protected String	explorerLink(String jcrPath) ECMS explorer page relative URL (within the Platform).
protected URI	explorerUri(String baseUrl, String ecmsLink) Explorer uri.
AccessToken	generateAccessToken(EditorConfig.Builder configBuilder) Generate access token.
DocumentContent	getContent(EditorConfig config) Gets the content.
javax.jcr.Node	getNode(String workspace, String path) Gets the node.
protected Long	getSize(javax.jcr.Node node) Gets the size.
protected javax.jcr.Node	getSymlink(javax.jcr.Node node, String userId) Gets parent folder of the file based on file preferences.
protected org.exoplatform.services.organization.User	getUser(String username) Gets the user.
protected javax.jcr.Session	getUserSession(String workspace) Gets the user session.
javax.jcr.Node	nodeByUUID(String uuid, String workspace) Node by UUID.
protected javax.jcr.Node	nodeContent(javax.jcr.Node node) Node content.
String	nodeTitle(javax.jcr.Node node) Node title.
protected StringBuilder	platformRestUrl(CharSequence platformUrl) Platform REST URL.
protected StringBuilder	platformUrl(String schema, String host, int port) Platform url.
protected void	restoreConvoState(org.exoplatform.services.security.ConversationState contextState, org.exoplatform.services.jcr.ext.common.SessionProvider contextProvider) Restores the conversation state.
protected boolean	setUserConvoState(String userId) Sets ConversationState by userId.
protected org.exoplatform.services.security.Identity	userIdentity(String userId) Find or create user identity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picocontainer.Startable

start, stop

Field Detail

LOG

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

The Constant LOG.

UTF_8

protected static final String UTF_8

The Constant UTF_8.

See Also:

Constant Field Values

KEY_CACHE_NAME

public static final String KEY_CACHE_NAME

The Constant KEY_CACHE_NAME.

SECRET_KEY

protected static final String SECRET_KEY

The Constant SECRET_KEY.

See Also:

Constant Field Values

ALGORITHM

protected static final String ALGORITHM

The Constant ALGORITHM.

See Also:

Constant Field Values

TOKEN_DELIMITER

protected static final String TOKEN_DELIMITER

The Constant TOKEN_DELIMITER.

See Also:

Constant Field Values

TOKEN_DELIMITER_PATTERN

protected static final String TOKEN_DELIMITER_PATTERN

The Constant TOKEN_DELIMITER_PATTERN.

See Also:

Constant Field Values

TOKEN_EXPIRES

protected static final long TOKEN_EXPIRES

The Constant TOKEN_EXPIRES.

See Also:

Constant Field Values

JCR_CONTENT

protected static final String JCR_CONTENT

The Constant JCR_CONTENT.

See Also:

Constant Field Values

WOPITESTX

protected static final String WOPITESTX

The Constant WOPITESTX.

See Also:

Constant Field Values

WOPITEST

protected static final String WOPITEST

The Constant WOPITEST.

See Also:

Constant Field Values

JCR_DATA

protected static final String JCR_DATA

The Constant JCR_DATA.

See Also:

Constant Field Values

EXO_LAST_MODIFIER

protected static final String EXO_LAST_MODIFIER

The Constant EXO_LAST_MODIFIER.

See Also:

Constant Field Values

EXO_LAST_MODIFIED_DATE

protected static final String EXO_LAST_MODIFIED_DATE

The Constant EXO_LAST_MODIFIED_DATE.

See Also:

Constant Field Values

EXO_DATE_MODIFIED

protected static final String EXO_DATE_MODIFIED

The Constant EXO_DATE_MODIFIED.

See Also:

Constant Field Values

JCR_LAST_MODIFIED

protected static final String JCR_LAST_MODIFIED

The Constant JCR_LAST_MODIFIED.

See Also:

Constant Field Values

MIX_VERSIONABLE

protected static final String MIX_VERSIONABLE

The Constant MIX_VERSIONABLE.

See Also:

Constant Field Values

EXO_OWNER

protected static final String EXO_OWNER

The Constant EXO_OWNER.

See Also:

Constant Field Values

EXO_TITLE

protected static final String EXO_TITLE

The Constant EXO_TITLE.

See Also:

Constant Field Values

EXO_PRIVILEGEABLE

protected static final String EXO_PRIVILEGEABLE

The Constant EXO_PRIVILEGEABLE.

See Also:

Constant Field Values

JCR_MIME_TYPE

protected static final String JCR_MIME_TYPE

The Constant JCR_MIME_TYPE.

See Also:

Constant Field Values

EXO_NAME

protected static final String EXO_NAME

The Constant EXO_NAME.

See Also:

Constant Field Values

PATH

protected static final String PATH

The Constant PATH.

See Also:

Constant Field Values

MSOFFICE_USER_PREFERENCES

protected static final String MSOFFICE_USER_PREFERENCES

The Constant MSOFFICE_USER_PREFERENCES.

See Also:

Constant Field Values

MSOFFICE_FILE

protected static final String MSOFFICE_FILE

The Constant MSOFFICE_FILE.

See Also:

Constant Field Values

MSOFFICE_PREFERENCES

protected static final String MSOFFICE_PREFERENCES

The Constant MSOFFICE_PREFERENCES.

See Also:

Constant Field Values

keyCache

protected final org.exoplatform.services.cache.ExoCache<String,Key> keyCache

Cache of Editing documents.

sessionProviders

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

The session providers.

userACL

protected final org.exoplatform.portal.config.UserACL userACL

The user ACL.

jcrService

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

The jcr service.

organization

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

The organization.

documentService

protected final org.exoplatform.services.cms.documents.DocumentService documentService

The document service.

identityRegistry

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

The identity registry.

authenticator

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

The authenticator.

nodeFinder

protected org.exoplatform.services.cms.link.NodeFinder nodeFinder

The node finder.

Constructor Detail

AbstractOfficeOnlineService

public AbstractOfficeOnlineService(org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                                   org.exoplatform.services.jcr.RepositoryService jcrService,
                                   org.exoplatform.services.organization.OrganizationService organization,
                                   org.exoplatform.services.cms.documents.DocumentService documentService,
                                   org.exoplatform.services.cache.CacheService cacheService,
                                   org.exoplatform.portal.config.UserACL userACL,
                                   org.exoplatform.services.security.IdentityRegistry identityRegistry,
                                   org.exoplatform.services.security.Authenticator authenticator,
                                   org.exoplatform.services.cms.link.NodeFinder nodeFinder)

Instantiates a new abstract office online service.

Parameters:

sessionProviders - the session providers

jcrService - the jcr service

organization - the organization

documentService - the document service

cacheService - the cache service

userACL - the user ACL

identityRegistry - the identity registry

authenticator - the authenticator

nodeFinder - the node finder

Method Detail

nodeByUUID

public javax.jcr.Node nodeByUUID(String uuid,
                                 String workspace)
                          throws FileNotFoundException,
                                 javax.jcr.RepositoryException

Node by UUID.

Parameters:

uuid - the uuid

workspace - the workspace

Returns:

the node

Throws:

FileNotFoundException - the file not found exception

javax.jcr.RepositoryException - the repository exception

getUserSession

protected javax.jcr.Session getUserSession(String workspace)
                                    throws javax.jcr.RepositoryException

Gets the user session.

Parameters:

workspace - the workspace

Returns:

the user session

Throws:

javax.jcr.RepositoryException - the repository exception

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

getContent

public DocumentContent getContent(EditorConfig config)
                           throws OfficeOnlineException

Gets the content.

Parameters:

config - the config

Returns:

the content

Throws:

OfficeOnlineException - the office online exception

platformUrl

protected StringBuilder platformUrl(String schema,
                                    String host,
                                    int port)

Platform url.

Parameters:

schema - the schema

host - the host

port - the port

Returns:

the string builder

platformRestUrl

protected StringBuilder platformRestUrl(CharSequence platformUrl)

Platform REST URL.

Parameters:

platformUrl - the platform URL

Returns:

the string builder

getUser

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

Gets the user.

Parameters:

username - the username

Returns:

the user

explorerUri

protected URI explorerUri(String baseUrl,
                          String ecmsLink)

Explorer uri.

Parameters:

baseUrl - the base url

ecmsLink - the ecms link

Returns:

the uri

explorerLink

protected String explorerLink(String jcrPath)

ECMS explorer page relative URL (within the Platform).

Parameters:

jcrPath - the jcr path

Returns:

the string

getSize

protected Long getSize(javax.jcr.Node node)

Gets the size.

Parameters:

node - the node

Returns:

the size

createEditorConfig

public EditorConfig createEditorConfig(String userId,
                                       String fileId,
                                       String workspace,
                                       RequestInfo requestInfo)
                                throws OfficeOnlineException,
                                       javax.jcr.RepositoryException

Creates the editor config.

Parameters:

userId - the userId

fileId - the file id

workspace - the workspace

requestInfo - the request info

Returns:

the editor config

Throws:

OfficeOnlineException - the office online exception

javax.jcr.RepositoryException - the repository exception

generateAccessToken

public AccessToken generateAccessToken(EditorConfig.Builder configBuilder)
                                throws OfficeOnlineException

Generate access token.

Parameters:

configBuilder - the config builder

Returns:

the string

Throws:

OfficeOnlineException - the office online exception

getNode

public javax.jcr.Node getNode(String workspace,
                              String path)
                       throws javax.jcr.RepositoryException

Gets the node.

Parameters:

workspace - the workspace

path - the path

Returns:

the node

Throws:

javax.jcr.RepositoryException - the repository exception

buildEditorConfig

public EditorConfig buildEditorConfig(String token)
                               throws OfficeOnlineException

Builds the editor config.

Parameters:

token - the access token

Returns:

the editor config

Throws:

OfficeOnlineException - the office online exception

setUserConvoState

protected boolean setUserConvoState(String userId)

Sets ConversationState by userId.

Parameters:

userId - the userId

Returns:

true if successful, false when the user is not found

restoreConvoState

protected void restoreConvoState(org.exoplatform.services.security.ConversationState contextState,
                                 org.exoplatform.services.jcr.ext.common.SessionProvider contextProvider)

Restores the conversation state.

Parameters:

contextState - the contextState

contextProvider - the contextProvider

userIdentity

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

Find or create user identity.

Parameters:

userId - the user id

Returns:

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

addFilePreferences

public void addFilePreferences(javax.jcr.Node node,
                               String userId,
                               String path)
                        throws javax.jcr.RepositoryException

Addds file preferences to the node (path for opening shared doc for particular user).

Parameters:

node - the node

userId - the userId

path - the path

Throws:

javax.jcr.RepositoryException - the repositoryException

nodeTitle

public 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

getSymlink

protected javax.jcr.Node getSymlink(javax.jcr.Node node,
                                    String userId)
                             throws javax.jcr.RepositoryException

Gets parent folder of the file based on file preferences.

Parameters:

node - the node

userId - the userId

Returns:

the Node

Throws:

javax.jcr.RepositoryException - the repository exception