org.exoplatform.officeonline.documents

Class OfficeOnlineDocumentEditorPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.officeonline.documents.OfficeOnlineDocumentEditorPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin, org.exoplatform.services.cms.documents.DocumentEditor

public class OfficeOnlineDocumentEditorPlugin
extends org.exoplatform.container.component.BaseComponentPlugin
implements org.exoplatform.services.cms.documents.DocumentEditor

The Class OfficeOnlineDocumentEditorPlugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfficeOnlineDocumentEditorPlugin.EditorError The Class Error.
protected static class	OfficeOnlineDocumentEditorPlugin.EditorSetting The Class EditorSetting.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLIENT_RESOURCE_PREFIX The Constant CLIENT_RESOURCE_PREFIX.
protected CometdOfficeOnlineService	cometdService The cometd service.
protected static long	EDITING_FINISHED_DELAY The Constant EDITING_FINISHED_DELAY.
protected static String	EDITOR_LINK_NOT_FOUND_ERROR The Constant EDITOR_LINK_NOT_FOUND_ERROR.
protected static String	EDITOR_LINK_NOT_FOUND_ERROR_MESSAGE The Constant EDITOR_LINK_NOT_FOUND_ERROR_MESSAGE.
protected Map<javax.jcr.Node,String>	editorLinks The editor links.
protected static String	EXO_SYMLINK The Constant EXO_SYMLINK.
protected org.exoplatform.services.resources.ResourceBundleService	i18nService The i 18 n service.
protected static String	INTERNAL_EDITOR_ERROR The Constant INTERNAL_EDITOR_ERROR.
protected static String	INTERNAL_EDITOR_ERROR_MESSAGE The Constant INTERNAL_EDITOR_ERROR_MESSAGE.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String	PROVIDER_CONFIGURATION_PARAM The Constant PROVIDER_CONFIGURATION_PARAM.
protected static String	PROVIDER_NAME The Constant PROVIDER_NAME.
protected static String	STORAGE_ERROR The Constant STORAGE_ERROR.
protected static String	STORAGE_ERROR_MESSAGE The Constant STORAGE_ERROR_MESSAGE.
protected org.exoplatform.services.cms.documents.DocumentUpdateActivityHandler	updateHandler The update handler.
protected WOPIService	wopiService The wopi service.

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
OfficeOnlineDocumentEditorPlugin(WOPIService wopiService, org.exoplatform.services.resources.ResourceBundleService i18nService, CometdOfficeOnlineService cometdService) Instantiates a new office online document editor plugin.

Method Summary

Modifier and Type	Method and Description
void	beforeDocumentCreate(org.exoplatform.services.cms.documents.NewDocumentTemplate template, String parentPath, String title)
org.exoplatform.services.cms.documents.DocumentUpdateActivityHandler	getDocumentUpdateHandler() Gets the document update handler.
long	getEditingFinishedDelay() Gets the editing finished delay.
protected String	getEditorLink(javax.jcr.Node node, URI requestURI) Returns editor link, adds it to the editorLinks cache.
String	getProviderName()
void	initActivity(String uuid, String workspace, String activityId) Inits the activity.
OfficeOnlineDocumentEditorPlugin.EditorSetting	initExplorer(String fileId, String workspace, org.exoplatform.webui.application.WebuiRequestContext context) Inits the explorer.
OfficeOnlineDocumentEditorPlugin.EditorSetting	initPreview(String fileId, String workspace, URI requestURI, Locale locale) Inits the preview.
boolean	isDocumentSupported(String fileId, String workspace) Checks if is document supported.
void	onDocumentCreated(String workspace, String path)
void	onLastEditorClosed(String fileId, String workspace) On last editor closed handler unlocks node if still locked.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exoplatform.services.cms.documents.DocumentEditor

getPermissions, isActive

Field Detail

LOG

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

The Constant LOG.

PROVIDER_NAME

protected static final String PROVIDER_NAME

The Constant PROVIDER_NAME.

See Also:

Constant Field Values

EDITING_FINISHED_DELAY

protected static final long EDITING_FINISHED_DELAY

The Constant EDITING_FINISHED_DELAY.

See Also:

Constant Field Values

PROVIDER_CONFIGURATION_PARAM

protected static final String PROVIDER_CONFIGURATION_PARAM

The Constant PROVIDER_CONFIGURATION_PARAM.

See Also:

Constant Field Values

CLIENT_RESOURCE_PREFIX

protected static final String CLIENT_RESOURCE_PREFIX

The Constant CLIENT_RESOURCE_PREFIX.

See Also:

Constant Field Values

EDITOR_LINK_NOT_FOUND_ERROR

protected static final String EDITOR_LINK_NOT_FOUND_ERROR

The Constant EDITOR_LINK_NOT_FOUND_ERROR.

See Also:

Constant Field Values

EDITOR_LINK_NOT_FOUND_ERROR_MESSAGE

protected static final String EDITOR_LINK_NOT_FOUND_ERROR_MESSAGE

The Constant EDITOR_LINK_NOT_FOUND_ERROR_MESSAGE.

See Also:

Constant Field Values

STORAGE_ERROR

protected static final String STORAGE_ERROR

The Constant STORAGE_ERROR.

See Also:

Constant Field Values

STORAGE_ERROR_MESSAGE

protected static final String STORAGE_ERROR_MESSAGE

The Constant STORAGE_ERROR_MESSAGE.

See Also:

Constant Field Values

INTERNAL_EDITOR_ERROR

protected static final String INTERNAL_EDITOR_ERROR

The Constant INTERNAL_EDITOR_ERROR.

See Also:

Constant Field Values

INTERNAL_EDITOR_ERROR_MESSAGE

protected static final String INTERNAL_EDITOR_ERROR_MESSAGE

The Constant INTERNAL_EDITOR_ERROR_MESSAGE.

See Also:

Constant Field Values

EXO_SYMLINK

protected static final String EXO_SYMLINK

The Constant EXO_SYMLINK.

See Also:

Constant Field Values

wopiService

protected final WOPIService wopiService

The wopi service.

i18nService

protected final org.exoplatform.services.resources.ResourceBundleService i18nService

The i 18 n service.

cometdService

protected final CometdOfficeOnlineService cometdService

The cometd service.

editorLinks

protected final Map<javax.jcr.Node,String> editorLinks

The editor links.

updateHandler

protected final org.exoplatform.services.cms.documents.DocumentUpdateActivityHandler updateHandler

The update handler.

Constructor Detail

OfficeOnlineDocumentEditorPlugin

public OfficeOnlineDocumentEditorPlugin(WOPIService wopiService,
                                        org.exoplatform.services.resources.ResourceBundleService i18nService,
                                        CometdOfficeOnlineService cometdService)

Instantiates a new office online document editor plugin.

Parameters:

wopiService - the wopi service

i18nService - the i 18 n service

cometdService - the cometd service

Method Detail

onDocumentCreated

public void onDocumentCreated(String workspace,
                              String path)
                       throws Exception

Specified by:

onDocumentCreated in interface org.exoplatform.services.cms.documents.DocumentEditor

Throws:

Exception

beforeDocumentCreate

public void beforeDocumentCreate(org.exoplatform.services.cms.documents.NewDocumentTemplate template,
                                 String parentPath,
                                 String title)
                          throws Exception

Specified by:

beforeDocumentCreate in interface org.exoplatform.services.cms.documents.DocumentEditor

Throws:

Exception

getProviderName

public String getProviderName()

Specified by:

getProviderName in interface org.exoplatform.services.cms.documents.DocumentEditor

initActivity

public void initActivity(String uuid,
                         String workspace,
                         String activityId)
                  throws Exception

Inits the activity.

Specified by:

initActivity in interface org.exoplatform.services.cms.documents.DocumentEditor

Parameters:

uuid - the uuid

workspace - the workspace

activityId - the activity id

Throws:

Exception - the exception

initPreview

public OfficeOnlineDocumentEditorPlugin.EditorSetting initPreview(String fileId,
                                                                  String workspace,
                                                                  URI requestURI,
                                                                  Locale locale)

Inits the preview.

Specified by:

initPreview in interface org.exoplatform.services.cms.documents.DocumentEditor

Parameters:

fileId - the uuid

workspace - the workspace

requestURI - the requestURI

locale - the locale

Returns:

the editor settings

initExplorer

public OfficeOnlineDocumentEditorPlugin.EditorSetting initExplorer(String fileId,
                                                                   String workspace,
                                                                   org.exoplatform.webui.application.WebuiRequestContext context)

Inits the explorer.

Specified by:

initExplorer in interface org.exoplatform.services.cms.documents.DocumentEditor

Parameters:

fileId - the file id

workspace - the workspace

context - the context

Returns:

the editor setting

isDocumentSupported

public boolean isDocumentSupported(String fileId,
                                   String workspace)

Checks if is document supported.

Specified by:

isDocumentSupported in interface org.exoplatform.services.cms.documents.DocumentEditor

Parameters:

fileId - the file id

workspace - the workspace

Returns:

true, if is document supported

getDocumentUpdateHandler

public org.exoplatform.services.cms.documents.DocumentUpdateActivityHandler getDocumentUpdateHandler()

Gets the document update handler.

Specified by:

getDocumentUpdateHandler in interface org.exoplatform.services.cms.documents.DocumentEditor

Returns:

the document update handler

onLastEditorClosed

public void onLastEditorClosed(String fileId,
                               String workspace)

On last editor closed handler unlocks node if still locked.

Specified by:

onLastEditorClosed in interface org.exoplatform.services.cms.documents.DocumentEditor

Parameters:

fileId - the file id

workspace - the workspace

getEditingFinishedDelay

public long getEditingFinishedDelay()

Gets the editing finished delay.

Specified by:

getEditingFinishedDelay in interface org.exoplatform.services.cms.documents.DocumentEditor

Returns:

the editing finished delay

getEditorLink

protected String getEditorLink(javax.jcr.Node node,
                               URI requestURI)
                        throws javax.jcr.RepositoryException,
                               OfficeOnlineException

Returns editor link, adds it to the editorLinks cache.

Parameters:

node - the node

requestURI - the request URI

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

OfficeOnlineException - the office online exception