WOPIService (eXo OfficeOnline Editor :: Extension Services 1.0.0-M01 API)

java.lang.Object
- org.exoplatform.officeonline.AbstractOfficeOnlineService
- - org.exoplatform.officeonline.WOPIService

All Implemented Interfaces:

org.picocontainer.Startable
```
public class WOPIService
extends AbstractOfficeOnlineService
```
The Class WOPIService.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WOPIService.DocumentTypesConfig
NewDocumentTypesConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WOPIService.DocumentTypesConfig` NewDocumentTypesConfig.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BASE_FILE_NAME` The Constant BASE_FILE_NAME.
`protected static String`	`BRAND_NAME` The Constant BRAND_NAME.
`protected String`	`brandName` The brand name.
`protected static String`	`BREADCRUMB_BRAND_NAME` The Constant BREADCRUMB_BRAND_NAME.
`protected static String`	`BREADCRUMB_BRAND_URL` The Constant BREADCRUMB_BRAND_URL.
`protected static String`	`BREADCRUMB_CONFIGURATION_PROPERTIES` The Constant BREADCRUMB_CONFIGURATION_PROPERTIES.
`protected static String`	`BREADCRUMB_FOLDER_NAME` The Constant BREADCRUMB_FOLDER_NAME.
`protected static String`	`BREADCRUMB_FOLDER_URL` The Constant BREADCRUMB_FOLDER_URL.
`protected static String`	`CLOSE_URL` The Constant CLOSE_URL.
`protected static String`	`DEFAULT_FILENAME` The Constant DEFAULT_FILENAME.
`protected WOPIDiscoveryPlugin`	`discoveryPlugin` The discovery plugin.
`protected DocumentTypePlugin`	`documentTypePlugin` The documentTypePlugin.
`protected static String`	`DOWNLOAD_URL` The Constant DOWNLOAD_URL.
`static String`	`EDIT_ACTION` The Constant EDIT_ACTION.
`protected static String`	`EDIT_NOTIFICATION_POST_MESSAGE` The Constant EDIT_NOTIFICATION_POST_MESSAGE.
`protected static String`	`EDIT_PARAM` The Constant EDIT_PARAM.
`static String`	`EDITNEW_ACTION` The Constant EDIT_ACTION.
`protected static String`	`EDITNEW_PARAM` The Constant EDITNEW_PARAM.
`protected static String`	`FILE_URL` The Constant FILE_URL.
`protected static String`	`FILE_VERSION_POST_MESSAGE` The Constant FILE_VERSION_POST_MESSAGE.
`protected static String`	`FILE_VERSION_URL` The Constant FILE_VERSION_URL.
`protected static String`	`FILES_ENDPOINT` The Constant FILES_ENDPOINT.
`protected static String`	`HOST_EDIT_URL` The Constant HOST_EDIT_URL.
`protected static String`	`HOST_VIEW_URL` The Constant HOST_VIEW_URL.
`protected static String`	`IS_ANONYMOUS_USER` The Constant IS_ANONYMOUS_USER.
`protected static String`	`JCR_FROZEN_NODE` The Constant JCR_FROZEN_NODE.
`protected static String`	`LICENSE_CHECK_FOR_EDIT_IS_ENABLED` The Constant LICENSE_CHECK_FOR_EDIT_IS_ENABLED.
`protected ConcurrentLinkedQueue<OfficeOnlineListener>`	`listeners` The listeners.
`protected WOPILockManagerPlugin`	`lockManager` The lock manager.
`protected static org.exoplatform.services.log.Log`	`LOG` The Constant LOG.
`protected static int`	`MAX_FILENAME_LENGHT` The Constant MAX_FILENAME_LENGHT.
`protected static String`	`MSOFFICE_IS_EDITOR_VERSION` The Constant MSOFFICE_IS_EDITOR_VERSION.
`protected static String`	`MSOFFICE_VERSION_OWNER` The Constant MSOFFICE_VERSION_OWNER.
`protected static String`	`NT_FILE` The Constant NT_FILE.
`protected static String`	`NT_RESOURCE` The Constant NT_RESOURCE.
`protected static String`	`OWNER_ID` The Constant OWNER_ID.
`protected static String`	`PLACEHOLDER_DC_LLCC` The Constant PLACEHOLDER_DC_LLCC.
`protected static String`	`PLACEHOLDER_UI_LLCC` The Constant PLACEHOLDER_UI_LLCC.
`protected static String`	`PLACEHOLDER_WOPISRC` The Constant PLACEHOLDER_WOPISRC.
`protected String`	`platformHost` The platform host.
`protected int`	`platformPort` The platform port.
`protected String`	`platformScheme` The platform scheme.
`protected static String`	`POST_MESSAGE_ORIGIN` The Constant POST_MESSAGE_ORIGIN.
`protected static String`	`SHARE_URL` The Constant SHARE_URL.
`protected static String`	`SHARE_URL_READ_ONLY` The Constant SHARE_URL_READ_ONLY.
`protected static String`	`SHARE_URL_READ_WRITE` The Constant SHARE_URL_READ_WRITE.
`protected static String`	`SIGNOUT_URL` The Constant SIGNOUT_URL.
`protected static String`	`SIZE` The Constant SIZE.
`protected static String`	`SUPPORTED_SHARE_URL_TYPES` The Constant SUPPORTED_SHARE_URL_TYPES.
`protected static String`	`SUPPORTS_DELETE_FILE` The Constant SUPPORTS_DELETE_FILE.
`protected static String`	`SUPPORTS_EXTENDED_LOCK_LENGTH` The Constant SUPPORTS_EXTENDED_LOCK_LENGTH.
`protected static String`	`SUPPORTS_GET_LOCK` The Constant SUPPORTS_GET_LOCK.
`protected static String`	`SUPPORTS_LOCKS` The Constant SUPPORTS_LOCKS.
`protected static String`	`SUPPORTS_RENAME` The Constant SUPPORTS_RENAME.
`protected static String`	`SUPPORTS_UPDATE` The Constant SUPPORTS_UPDATE.
`protected static String`	`SUPPORTS_USER_INFO` The Constant SUPPORTS_USER_INFO.
`protected static String`	`TOKEN_CONFIGURATION_PROPERTIES` The Constant TOKEN_CONFIGURATION_PROPERTIES.
`protected org.exoplatform.services.cms.documents.TrashService`	`trashService` The trash service.
`protected static String`	`USER_FRIENDLY_NAME` The Constant USER_FRIENDLY_NAME.
`protected static String`	`USER_ID` The Constant USER_ID.
`protected static String`	`USER_INFO` The Constant USER_INFO.
`static String`	`USERINFO_CACHE_NAME` The Constant USERIONFO_CACHE_NAME.
`protected org.exoplatform.services.cache.ExoCache<String,String>`	`userInfoCache` The user info cache.
`protected String`	`usersPath` The user drives paths in JCR.
`protected static String`	`VERSION` The Constant VERSION.
`protected static String`	`VERSION_ACCUMULATION` The Constant VERSION_ACCUMULATION.
`protected static String`	`VERSION_ACCUMULATION_PROPERTIES` The Constant VERSION_ACCUMULATION_PROPERTIES.
`protected static long`	`VERSION_TIMEOUT` The Constant VERSION_TIMEOUT.
`protected boolean`	`versionAccumulation` The version accumulation.
`static String`	`VIEW_ACTION` The Constant VIEW_ACTION.
`protected static String`	`VIEW_PARAM` The Constant VIEW_PARAM.
`protected static String`	`WOPI_CONFIGURATION_PROPERTIES` The Constant WOPI_CONFIGURATION_PROPERTIES.
`protected static String`	`WOPI_URL` The Constant WOPI_URL.
`protected WOPIAvailabilityCheckerPlugin`	`wopiAvailabilityChecker` The wopi availability checker.
`protected String`	`wopiUrl` The wopi url.

Fields inherited from class org.exoplatform.officeonline.AbstractOfficeOnlineService
ALGORITHM, authenticator, documentService, EXO_DATE_MODIFIED, EXO_LAST_MODIFIED_DATE, EXO_LAST_MODIFIER, EXO_NAME, EXO_OWNER, EXO_PRIVILEGEABLE, EXO_TITLE, identityRegistry, JCR_CONTENT, JCR_DATA, JCR_LAST_MODIFIED, JCR_MIME_TYPE, jcrService, KEY_CACHE_NAME, keyCache, MIX_VERSIONABLE, MSOFFICE_FILE, MSOFFICE_PREFERENCES, MSOFFICE_USER_PREFERENCES, nodeFinder, organization, PATH, SECRET_KEY, sessionProviders, TOKEN_DELIMITER, TOKEN_DELIMITER_PATTERN, TOKEN_EXPIRES, userACL, UTF_8, WOPITEST, WOPITESTX

Constructor Summary

Constructors
Constructor and Description
WOPIService(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.cms.documents.TrashService trashService, org.exoplatform.services.security.IdentityRegistry identityRegistry, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator, org.exoplatform.services.security.Authenticator authenticator, org.exoplatform.services.cms.link.NodeFinder nodeFinder, org.exoplatform.container.xml.InitParams initParams) Instantiates a new WOPI service.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addBreadcrumbProperties(Map<String,Serializable> map, javax.jcr.Node node, EditorConfig config)` Adds the breadcrumb properties.
`protected void`	`addFileURLProperties(Map<String,Serializable> map, javax.jcr.Node node, EditorConfig config)` Adds the file URL properties.
`protected void`	`addHostCapabilitiesProperties(Map<String,Serializable> map)` Adds the host capabilities properties.
`void`	`addListener(OfficeOnlineListener listener)` Adds the listener.
`protected void`	`addRequiredProperties(Map<String,Serializable> map, javax.jcr.Node node)` Adds the required properties.
`void`	`addTypePlugin(org.exoplatform.container.component.ComponentPlugin plugin)`
`protected void`	`addUserMetadataProperties(Map<String,Serializable> map)` Adds the user metadata properties.
`protected void`	`addUserPermissionsProperties(Map<String,Serializable> map, javax.jcr.Node node)` Adds the user permissions properties.
`boolean`	`canEdit(javax.jcr.Node node)` Can edit.
`protected boolean`	`canUpdate(javax.jcr.Node node)` Checks parent node permissions.
`boolean`	`canView(javax.jcr.Node node)` Can view.
`Map<String,Serializable>`	`checkFileInfo(EditorConfig config)` Check file info.
`protected void`	`checkNodeLock(javax.jcr.Node node, String lockId)` Check node lock.
`protected boolean`	`checkout(javax.jcr.Node node)` Checkout.
`protected String`	`createFile(javax.jcr.Node parent, String filename, InputStream data)` Creates the file.
`protected void`	`createVersionOfDraft(javax.jcr.Node node)` Creates a version of draft.
`void`	`delete(EditorConfig config, String lockId)` Delete.
`protected Key`	`generateSecretKey()` Generate secret key.
`String`	`getActionUrl(RequestInfo requestInfo, String fileId, String workspace, String action)` Gets the action url.
`String`	`getEditorLink(javax.jcr.Node node, String baseUrl, String action)` Gets the editor link.
`String`	`getEditorLink(javax.jcr.Node node, String scheme, String host, int port, String action)` Gets the editor link.
`String`	`getEditorLink(String fileId, String workspace, String baseUrl, String action)` Gets the editor URL.
`StringBuilder`	`getExplorerURL(javax.jcr.Node node, String baseUrl)` Gets the explorer URL.
`protected String`	`getFileExtension(javax.jcr.Node node)` Gets the file extension.
`String`	`getFileName(String fileId, String workspace)` Gets the file name.
`String`	`getFileVersion(String fileId, String workspace)` Gets the file version.
`protected javax.jcr.Node`	`getFrozen(javax.jcr.Node node)` Gets the frozen.
`String`	`getLockId(EditorConfig config)` Gets the lock.
`String`	`getMimeTypeByExtension(String extension)` Gets the mime type by extension.
`protected String`	`getUserId(String path)` Gets userId from node path.
`protected String`	`getVersioningUser(javax.jcr.Node frozen)` Gets the versioning user.
`String`	`getWOPISrc(RequestInfo requestInfo, String fileId)` Gets the WOPI src.
`protected String`	`increaseName(String origin, int count)` Increase name.
`boolean`	`isDocumentSupported(javax.jcr.Node node)` Checks if is document supported.
`protected Boolean`	`isEditorVersion(javax.jcr.Node frozen)` Checks if is editor version.
`boolean`	`isNewDocument(javax.jcr.Node node)` Checks if is new document.
`boolean`	`isVersionAccumulationEnabled()` Checks if is version accumulation enabled.
`void`	`lock(EditorConfig config, String lockId)` Lock.
`void`	`onSaved(EditorConfig config)` On saved.
`void`	`putFile(EditorConfig config, String lockId, InputStream data)` Put file.
`String`	`putRelativeFile(EditorConfig config, String filename, boolean overwrite, InputStream data)` Put relative file.
`String`	`putSuggestedFile(EditorConfig config, String target, InputStream data)` Put relative file in suggested mode.
`void`	`putUserInfo(String userId, String userInfo)` Put user info.
`void`	`refreshLock(EditorConfig config, String lockId)` Refresh lock.
`void`	`relock(EditorConfig config, String providedLock, String oldLock)` Relock.
`void`	`removeListener(OfficeOnlineListener listener)` Removes the listener.
`String`	`renameFile(EditorConfig config, String newTitle, String lockId)` Rename file.
`void`	`setVersionAccumulation(boolean versionAccumulation)` Sets the version accumulation.
`void`	`setWOPIAvailabilityCheckerPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Sets the WOPIAvailabilityCheckerPlugin.
`void`	`setWOPIDiscoveryPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Sets the plugin.
`void`	`setWOPILockManagerPlugin(org.exoplatform.container.component.ComponentPlugin plugin)` Sets the plugin.
`void`	`start()` Start.
`void`	`stop()` Stop.
`void`	`unlock(EditorConfig config, String providedLock)` Unlock.
`boolean`	`verifyProofKey(String proofKeyHeader, String oldProofKeyHeader, String contextPath, String accessToken, String timestampHeader)` Verify proof key.

Methods inherited from class org.exoplatform.officeonline.AbstractOfficeOnlineService
addFilePreferences, buildEditorConfig, createEditorConfig, explorerLink, explorerUri, generateAccessToken, getContent, getNode, getSize, getSymlink, getUser, getUserSession, nodeByUUID, nodeContent, nodeTitle, platformRestUrl, platformUrl, restoreConvoState, setUserConvoState, userIdentity

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.
- MSOFFICE_VERSION_OWNER
```
protected static final String MSOFFICE_VERSION_OWNER
```
  The Constant MSOFFICE_VERSION_OWNER.
  
  See Also:
  
  Constant Field Values
- JCR_FROZEN_NODE
```
protected static final String JCR_FROZEN_NODE
```
  The Constant JCR_FROZEN_NODE.
  
  See Also:
  
  Constant Field Values
- NT_RESOURCE
```
protected static final String NT_RESOURCE
```
  The Constant NT_RESOURCE.
  
  See Also:
  
  Constant Field Values
- NT_FILE
```
protected static final String NT_FILE
```
  The Constant NT_FILE.
  
  See Also:
  
  Constant Field Values
- MSOFFICE_IS_EDITOR_VERSION
```
protected static final String MSOFFICE_IS_EDITOR_VERSION
```
  The Constant MSOFFICE_IS_EDITOR_VERSION.
  
  See Also:
  
  Constant Field Values
- BASE_FILE_NAME
```
protected static final String BASE_FILE_NAME
```
  The Constant BASE_FILE_NAME.
  
  See Also:
  
  Constant Field Values
- DEFAULT_FILENAME
```
protected static final String DEFAULT_FILENAME
```
  The Constant DEFAULT_FILENAME.
  
  See Also:
  
  Constant Field Values
- OWNER_ID
```
protected static final String OWNER_ID
```
  The Constant OWNER_ID.
  
  See Also:
  
  Constant Field Values
- FILES_ENDPOINT
```
protected static final String FILES_ENDPOINT
```
  The Constant FILES_ENDPOINT.
  
  See Also:
  
  Constant Field Values
- SIZE
```
protected static final String SIZE
```
  The Constant SIZE.
  
  See Also:
  
  Constant Field Values
- USER_ID
```
protected static final String USER_ID
```
  The Constant USER_ID.
  
  See Also:
  
  Constant Field Values
- VERSION
```
protected static final String VERSION
```
  The Constant VERSION.
  
  See Also:
  
  Constant Field Values
- BREADCRUMB_BRAND_NAME
```
protected static final String BREADCRUMB_BRAND_NAME
```
  The Constant BREADCRUMB_BRAND_NAME.
  
  See Also:
  
  Constant Field Values
- BREADCRUMB_BRAND_URL
```
protected static final String BREADCRUMB_BRAND_URL
```
  The Constant BREADCRUMB_BRAND_URL.
  
  See Also:
  
  Constant Field Values
- BREADCRUMB_FOLDER_NAME
```
protected static final String BREADCRUMB_FOLDER_NAME
```
  The Constant BREADCRUMB_FOLDER_NAME.
  
  See Also:
  
  Constant Field Values
- BREADCRUMB_FOLDER_URL
```
protected static final String BREADCRUMB_FOLDER_URL
```
  The Constant BREADCRUMB_FOLDER_URL.
  
  See Also:
  
  Constant Field Values
- CLOSE_URL
```
protected static final String CLOSE_URL
```
  The Constant CLOSE_URL.
  
  See Also:
  
  Constant Field Values
- DOWNLOAD_URL
```
protected static final String DOWNLOAD_URL
```
  The Constant DOWNLOAD_URL.
  
  See Also:
  
  Constant Field Values
- FILE_URL
```
protected static final String FILE_URL
```
  The Constant FILE_URL.
  
  See Also:
  
  Constant Field Values
- FILE_VERSION_URL
```
protected static final String FILE_VERSION_URL
```
  The Constant FILE_VERSION_URL.
  
  See Also:
  
  Constant Field Values
- HOST_EDIT_URL
```
protected static final String HOST_EDIT_URL
```
  The Constant HOST_EDIT_URL.
  
  See Also:
  
  Constant Field Values
- HOST_VIEW_URL
```
protected static final String HOST_VIEW_URL
```
  The Constant HOST_VIEW_URL.
  
  See Also:
  
  Constant Field Values
- SIGNOUT_URL
```
protected static final String SIGNOUT_URL
```
  The Constant SIGNOUT_URL.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_EXTENDED_LOCK_LENGTH
```
protected static final String SUPPORTS_EXTENDED_LOCK_LENGTH
```
  The Constant SUPPORTS_EXTENDED_LOCK_LENGTH.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_GET_LOCK
```
protected static final String SUPPORTS_GET_LOCK
```
  The Constant SUPPORTS_GET_LOCK.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_LOCKS
```
protected static final String SUPPORTS_LOCKS
```
  The Constant SUPPORTS_LOCKS.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_RENAME
```
protected static final String SUPPORTS_RENAME
```
  The Constant SUPPORTS_RENAME.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_UPDATE
```
protected static final String SUPPORTS_UPDATE
```
  The Constant SUPPORTS_UPDATE.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_DELETE_FILE
```
protected static final String SUPPORTS_DELETE_FILE
```
  The Constant SUPPORTS_DELETE_FILE.
  
  See Also:
  
  Constant Field Values
- SUPPORTS_USER_INFO
```
protected static final String SUPPORTS_USER_INFO
```
  The Constant SUPPORTS_USER_INFO.
  
  See Also:
  
  Constant Field Values
- SUPPORTED_SHARE_URL_TYPES
```
protected static final String SUPPORTED_SHARE_URL_TYPES
```
  The Constant SUPPORTED_SHARE_URL_TYPES.
  
  See Also:
  
  Constant Field Values
- POST_MESSAGE_ORIGIN
```
protected static final String POST_MESSAGE_ORIGIN
```
  The Constant POST_MESSAGE_ORIGIN.
  
  See Also:
  
  Constant Field Values
- FILE_VERSION_POST_MESSAGE
```
protected static final String FILE_VERSION_POST_MESSAGE
```
  The Constant FILE_VERSION_POST_MESSAGE.
  
  See Also:
  
  Constant Field Values
- EDIT_NOTIFICATION_POST_MESSAGE
```
protected static final String EDIT_NOTIFICATION_POST_MESSAGE
```
  The Constant EDIT_NOTIFICATION_POST_MESSAGE.
  
  See Also:
  
  Constant Field Values
- IS_ANONYMOUS_USER
```
protected static final String IS_ANONYMOUS_USER
```
  The Constant IS_ANONYMOUS_USER.
  
  See Also:
  
  Constant Field Values
- USER_INFO
```
protected static final String USER_INFO
```
  The Constant USER_INFO.
  
  See Also:
  
  Constant Field Values
- LICENSE_CHECK_FOR_EDIT_IS_ENABLED
```
protected static final String LICENSE_CHECK_FOR_EDIT_IS_ENABLED
```
  The Constant LICENSE_CHECK_FOR_EDIT_IS_ENABLED.
  
  See Also:
  
  Constant Field Values
- USER_FRIENDLY_NAME
```
protected static final String USER_FRIENDLY_NAME
```
  The Constant USER_FRIENDLY_NAME.
  
  See Also:
  
  Constant Field Values
- PLACEHOLDER_WOPISRC
```
protected static final String PLACEHOLDER_WOPISRC
```
  The Constant PLACEHOLDER_WOPISRC.
  
  See Also:
  
  Constant Field Values
- PLACEHOLDER_DC_LLCC
```
protected static final String PLACEHOLDER_DC_LLCC
```
  The Constant PLACEHOLDER_DC_LLCC.
  
  See Also:
  
  Constant Field Values
- PLACEHOLDER_UI_LLCC
```
protected static final String PLACEHOLDER_UI_LLCC
```
  The Constant PLACEHOLDER_UI_LLCC.
  
  See Also:
  
  Constant Field Values
- SHARE_URL
```
protected static final String SHARE_URL
```
  The Constant SHARE_URL.
  
  See Also:
  
  Constant Field Values
- SHARE_URL_READ_ONLY
```
protected static final String SHARE_URL_READ_ONLY
```
  The Constant SHARE_URL_READ_ONLY.
  
  See Also:
  
  Constant Field Values
- SHARE_URL_READ_WRITE
```
protected static final String SHARE_URL_READ_WRITE
```
  The Constant SHARE_URL_READ_WRITE.
  
  See Also:
  
  Constant Field Values
- TOKEN_CONFIGURATION_PROPERTIES
```
protected static final String TOKEN_CONFIGURATION_PROPERTIES
```
  The Constant TOKEN_CONFIGURATION_PROPERTIES.
  
  See Also:
  
  Constant Field Values
- BREADCRUMB_CONFIGURATION_PROPERTIES
```
protected static final String BREADCRUMB_CONFIGURATION_PROPERTIES
```
  The Constant BREADCRUMB_CONFIGURATION_PROPERTIES.
  
  See Also:
  
  Constant Field Values
- WOPI_CONFIGURATION_PROPERTIES
```
protected static final String WOPI_CONFIGURATION_PROPERTIES
```
  The Constant WOPI_CONFIGURATION_PROPERTIES.
  
  See Also:
  
  Constant Field Values
- VERSION_ACCUMULATION_PROPERTIES
```
protected static final String VERSION_ACCUMULATION_PROPERTIES
```
  The Constant VERSION_ACCUMULATION_PROPERTIES.
  
  See Also:
  
  Constant Field Values
- VERSION_ACCUMULATION
```
protected static final String VERSION_ACCUMULATION
```
  The Constant VERSION_ACCUMULATION.
  
  See Also:
  
  Constant Field Values
- WOPI_URL
```
protected static final String WOPI_URL
```
  The Constant WOPI_URL.
  
  See Also:
  
  Constant Field Values
- BRAND_NAME
```
protected static final String BRAND_NAME
```
  The Constant BRAND_NAME.
  
  See Also:
  
  Constant Field Values
- MAX_FILENAME_LENGHT
```
protected static final int MAX_FILENAME_LENGHT
```
  The Constant MAX_FILENAME_LENGHT.
  
  See Also:
  
  Constant Field Values
- USERINFO_CACHE_NAME
```
public static final String USERINFO_CACHE_NAME
```
  The Constant USERIONFO_CACHE_NAME.
- EDIT_ACTION
```
public static final String EDIT_ACTION
```
  The Constant EDIT_ACTION.
  
  See Also:
  
  Constant Field Values
- EDITNEW_ACTION
```
public static final String EDITNEW_ACTION
```
  The Constant EDIT_ACTION.
  
  See Also:
  
  Constant Field Values
- VIEW_ACTION
```
public static final String VIEW_ACTION
```
  The Constant VIEW_ACTION.
  
  See Also:
  
  Constant Field Values
- VIEW_PARAM
```
protected static final String VIEW_PARAM
```
  The Constant VIEW_PARAM.
  
  See Also:
  
  Constant Field Values
- EDIT_PARAM
```
protected static final String EDIT_PARAM
```
  The Constant EDIT_PARAM.
  
  See Also:
  
  Constant Field Values
- EDITNEW_PARAM
```
protected static final String EDITNEW_PARAM
```
  The Constant EDITNEW_PARAM.
  
  See Also:
  
  Constant Field Values
- VERSION_TIMEOUT
```
protected static final long VERSION_TIMEOUT
```
  The Constant VERSION_TIMEOUT.
  
  See Also:
  
  Constant Field Values
- usersPath
```
protected final String usersPath
```
  The user drives paths in JCR.
- trashService
```
protected final org.exoplatform.services.cms.documents.TrashService trashService
```
  The trash service.
- discoveryPlugin
```
protected WOPIDiscoveryPlugin discoveryPlugin
```
  The discovery plugin.
- wopiAvailabilityChecker
```
protected WOPIAvailabilityCheckerPlugin wopiAvailabilityChecker
```
  The wopi availability checker.
- lockManager
```
protected WOPILockManagerPlugin lockManager
```
  The lock manager.
- brandName
```
protected String brandName
```
  The brand name.
- wopiUrl
```
protected String wopiUrl
```
  The wopi url.
- versionAccumulation
```
protected boolean versionAccumulation
```
  The version accumulation.
- platformScheme
```
protected String platformScheme
```
  The platform scheme.
- platformHost
```
protected String platformHost
```
  The platform host.
- platformPort
```
protected int platformPort
```
  The platform port.
- userInfoCache
```
protected org.exoplatform.services.cache.ExoCache<String,String> userInfoCache
```
  The user info cache.
- documentTypePlugin
```
protected DocumentTypePlugin documentTypePlugin
```
  The documentTypePlugin.
- listeners
```
protected final ConcurrentLinkedQueue<OfficeOnlineListener> listeners
```
  The listeners.

Constructor Detail

WOPIService

public WOPIService(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.cms.documents.TrashService trashService,
                   org.exoplatform.services.security.IdentityRegistry identityRegistry,
                   org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator,
                   org.exoplatform.services.security.Authenticator authenticator,
                   org.exoplatform.services.cms.link.NodeFinder nodeFinder,
                   org.exoplatform.container.xml.InitParams initParams)

Instantiates a new WOPI 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; trashService - the trash service; identityRegistry - the identity registry; hierarchyCreator - the hierarchy creator; authenticator - the authenticator; nodeFinder - the node finder; initParams - the init params

Method Detail

putFile

public void putFile(EditorConfig config,
                    String lockId,
                    InputStream data)
             throws Exception

Put file.

Parameters:: config - the config; lockId - the lock id; data - the data
Throws:: Exception - the exception

getVersioningUser
```
protected String getVersioningUser(javax.jcr.Node frozen)
                            throws javax.jcr.RepositoryException
```
Gets the versioning user.

Parameters:

frozen - the frozen

Returns:

the versioning user

Throws:

javax.jcr.RepositoryException - the repository exception

getFrozen
```
protected javax.jcr.Node getFrozen(javax.jcr.Node node)
                            throws javax.jcr.RepositoryException
```
Gets the frozen.

Parameters:

node - the node

Returns:

the frozen

Throws:

javax.jcr.RepositoryException - the repository exception

isEditorVersion
```
protected Boolean isEditorVersion(javax.jcr.Node frozen)
                           throws javax.jcr.RepositoryException
```
Checks if is editor version.

Parameters:

frozen - the frozen

Returns:

the boolean

Throws:

javax.jcr.RepositoryException - the repository exception

createVersionOfDraft
```
protected void createVersionOfDraft(javax.jcr.Node node)
                             throws javax.jcr.RepositoryException,
                                    OfficeOnlineException
```
Creates a version of draft. Used to create version after manually uploaded content.

Parameters:

node - the node

Throws:

javax.jcr.RepositoryException - the repository exception

OfficeOnlineException - the OfficeOnlineException 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

checkFileInfo

public Map<String,Serializable> checkFileInfo(EditorConfig config)
                                       throws javax.jcr.RepositoryException,
                                              FileNotFoundException

Check file info.

Parameters:: config - the config
Returns:: the map
Throws:: javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception

verifyProofKey

public boolean verifyProofKey(String proofKeyHeader,
                              String oldProofKeyHeader,
                              String contextPath,
                              String accessToken,
                              String timestampHeader)

Verify proof key. Runs wopi discovery in case of failure/success with old key

Parameters:: proofKeyHeader - the proof key header; oldProofKeyHeader - the old proof key header; contextPath - the contextPath; accessToken - the access token; timestampHeader - the timestamp header
Returns:: true, if successful

setWOPIDiscoveryPlugin

public void setWOPIDiscoveryPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Sets the plugin.

Parameters:: plugin - the plugin

setWOPIAvailabilityCheckerPlugin

public void setWOPIAvailabilityCheckerPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Sets the WOPIAvailabilityCheckerPlugin.

Parameters:: plugin - the plugin

setWOPILockManagerPlugin

public void setWOPILockManagerPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Sets the plugin.

Parameters:: plugin - the plugin

getActionUrl

public String getActionUrl(RequestInfo requestInfo,
                           String fileId,
                           String workspace,
                           String action)
                    throws javax.jcr.RepositoryException,
                           OfficeOnlineException

Gets the action url.

Parameters:: requestInfo - the request info; fileId - the file id; workspace - the workspace; action - the action
Returns:: the action url
Throws:: javax.jcr.RepositoryException - the repository exception; OfficeOnlineException - the office online exception

isNewDocument
```
public boolean isNewDocument(javax.jcr.Node node)
                      throws javax.jcr.RepositoryException
```
Checks if is new document.

Parameters:

node - the node

Returns:

true, if is new document

Throws:

javax.jcr.RepositoryException - the repository exception

renameFile

public String renameFile(EditorConfig config,
                         String newTitle,
                         String lockId)
                  throws javax.jcr.RepositoryException,
                         OfficeOnlineException,
                         LockMismatchException

Rename file.

Parameters:: config - the config; newTitle - the new title; lockId - the lock id
Returns:: the string
Throws:: javax.jcr.RepositoryException - the repository exception; OfficeOnlineException - the office online exception; LockMismatchException - the lock mismatch exception

canUpdate
```
protected boolean canUpdate(javax.jcr.Node node)
                     throws javax.jcr.RepositoryException
```
Checks parent node permissions.

Parameters:

node - the node

Returns:

true if user can rename

Throws:

javax.jcr.RepositoryException - the repository exception

getFileExtension

protected String getFileExtension(javax.jcr.Node node)
                           throws javax.jcr.RepositoryException,
                                  FileExtensionNotFoundException

Gets the file extension.

Parameters:: node - the node
Returns:: the file extension
Throws:: javax.jcr.RepositoryException - the repository exception; FileExtensionNotFoundException - the file extension not found exception

getEditorLink

public String getEditorLink(String fileId,
                            String workspace,
                            String baseUrl,
                            String action)
                     throws javax.jcr.RepositoryException,
                            FileNotFoundException,
                            EditorLinkNotFoundException

Gets the editor URL.

Parameters:: fileId - the file id; workspace - the workspace; baseUrl - the base url; action - the action
Returns:: the editor URL
Throws:: javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception; EditorLinkNotFoundException - the editor link not found exception

getEditorLink

public String getEditorLink(javax.jcr.Node node,
                            String scheme,
                            String host,
                            int port,
                            String action)
                     throws javax.jcr.RepositoryException,
                            EditorLinkNotFoundException

Gets the editor link.

Parameters:: node - the node; scheme - the scheme; host - the host; port - the port; action - the action
Returns:: the editor link
Throws:: javax.jcr.RepositoryException - the repository exception; EditorLinkNotFoundException - the editor link not found exception

getEditorLink

public String getEditorLink(javax.jcr.Node node,
                            String baseUrl,
                            String action)
                     throws javax.jcr.RepositoryException,
                            EditorLinkNotFoundException

Gets the editor link.

Parameters:: node - the node; baseUrl - the base url; action - the action
Returns:: the editor link
Throws:: javax.jcr.RepositoryException - the repository exception; EditorLinkNotFoundException - the editor link not found exception

isDocumentSupported
```
public boolean isDocumentSupported(javax.jcr.Node node)
                            throws javax.jcr.RepositoryException
```
Checks if is document supported.

Parameters:

node - the node

Returns:

true, if is document supported

Throws:

javax.jcr.RepositoryException - the repository exception

getWOPISrc

public String getWOPISrc(RequestInfo requestInfo,
                         String fileId)

Gets the WOPI src.

Parameters:: requestInfo - the request info; fileId - the file id
Returns:: the WOPI src

start
```
public void start()
```
Start.

stop
```
public void stop()
```
Stop.

addRequiredProperties

protected void addRequiredProperties(Map<String,Serializable> map,
                                     javax.jcr.Node node)
                              throws javax.jcr.RepositoryException

Adds the required properties.

Parameters:: map - the map; node - the node
Throws:: javax.jcr.RepositoryException - the repository exception

addHostCapabilitiesProperties
```
protected void addHostCapabilitiesProperties(Map<String,Serializable> map)
```
Adds the host capabilities properties.

Parameters:

map - the map

addUserMetadataProperties
```
protected void addUserMetadataProperties(Map<String,Serializable> map)
```
Adds the user metadata properties.

Parameters:

map - the map

addUserPermissionsProperties

protected void addUserPermissionsProperties(Map<String,Serializable> map,
                                            javax.jcr.Node node)
                                     throws javax.jcr.RepositoryException

Adds the user permissions properties.

Parameters:: map - the map; node - the node
Throws:: javax.jcr.RepositoryException - the repository exception

canEdit
```
public boolean canEdit(javax.jcr.Node node)
```
Can edit.

Parameters:

node - the node

Returns:

true, if successful

canView
```
public boolean canView(javax.jcr.Node node)
```
Can view.

Parameters:

node - the node

Returns:

true, if successful

addFileURLProperties

protected void addFileURLProperties(Map<String,Serializable> map,
                                    javax.jcr.Node node,
                                    EditorConfig config)
                             throws javax.jcr.RepositoryException

Adds the file URL properties.

Parameters:: map - the map; node - the node; config - the config
Throws:: javax.jcr.RepositoryException - the repository exception

getExplorerURL

public StringBuilder getExplorerURL(javax.jcr.Node node,
                                    String baseUrl)
                             throws javax.jcr.RepositoryException

Gets the explorer URL.

Parameters:: node - the node; baseUrl - the base url
Returns:: the explorer URL
Throws:: javax.jcr.RepositoryException - the repository exception

addBreadcrumbProperties

protected void addBreadcrumbProperties(Map<String,Serializable> map,
                                       javax.jcr.Node node,
                                       EditorConfig config)

Adds the breadcrumb properties.

Parameters:: map - the map; node - the node; config - the config

generateSecretKey
```
protected Key generateSecretKey()
```
Generate secret key.

Returns:

the key

lock

public void lock(EditorConfig config,
                 String lockId)
          throws LockMismatchException,
                 javax.jcr.RepositoryException,
                 FileNotFoundException

Lock.

Parameters:: config - the config; lockId - the lock id
Throws:: LockMismatchException - the lock mismatch exception; javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception

getLockId
```
public String getLockId(EditorConfig config)
                 throws FileNotFoundException,
                        javax.jcr.RepositoryException
```
Gets the lock.

Parameters:

config - the config

Returns:

the lock

Throws:

FileNotFoundException - the file not found exception

javax.jcr.RepositoryException - the repository exception

relock

public void relock(EditorConfig config,
                   String providedLock,
                   String oldLock)
            throws LockMismatchException,
                   javax.jcr.RepositoryException,
                   FileNotFoundException

Relock.

Parameters:: config - the config; providedLock - the provided lock; oldLock - the old lock
Throws:: LockMismatchException - the lock mismatch exception; javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception

unlock

public void unlock(EditorConfig config,
                   String providedLock)
            throws LockMismatchException,
                   javax.jcr.RepositoryException,
                   FileNotFoundException

Unlock.

Parameters:: config - the config; providedLock - the provided lock
Throws:: LockMismatchException - the lock mismatch exception; javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception

refreshLock

public void refreshLock(EditorConfig config,
                        String lockId)
                 throws LockMismatchException,
                        javax.jcr.RepositoryException,
                        FileNotFoundException

Refresh lock.

Parameters:: config - the config; lockId - the lock id
Throws:: LockMismatchException - the lock mismatch exception; javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception

putSuggestedFile

public String putSuggestedFile(EditorConfig config,
                               String target,
                               InputStream data)
                        throws javax.jcr.RepositoryException,
                               FileNotFoundException,
                               FileExtensionNotFoundException,
                               PermissionDeniedException

Put relative file in suggested mode.

Parameters:: config - the config; target - the target; data - the data
Returns:: the fileId
Throws:: javax.jcr.RepositoryException - the repository exception; FileNotFoundException - the file not found exception; FileExtensionNotFoundException - the file extension not found exception; PermissionDeniedException - the permission denied exception

putRelativeFile

public String putRelativeFile(EditorConfig config,
                              String filename,
                              boolean overwrite,
                              InputStream data)
                       throws IllegalFileNameException,
                              FileNotFoundException,
                              javax.jcr.RepositoryException,
                              FileLockedException,
                              UpdateConflictException,
                              FileExtensionNotFoundException,
                              PermissionDeniedException

Put relative file.

Parameters:: config - the config; filename - the filename; overwrite - the overwrite; data - the data
Returns:: the node uuid
Throws:: IllegalFileNameException - the illegal file name exception; FileNotFoundException - the file not found exception; javax.jcr.RepositoryException - the repository exception; FileLockedException - the file locked exception; UpdateConflictException - the update conflict exception; FileExtensionNotFoundException - the file extension not found exception; PermissionDeniedException - the permission denied exception

createFile

protected String createFile(javax.jcr.Node parent,
                            String filename,
                            InputStream data)
                     throws javax.jcr.RepositoryException,
                            FileExtensionNotFoundException

Creates the file.

Parameters:: parent - the parent; filename - the filename; data - the data
Returns:: the string
Throws:: javax.jcr.RepositoryException - the repository exception; FileExtensionNotFoundException - the file extension not found exception

getMimeTypeByExtension
```
public String getMimeTypeByExtension(String extension)
                              throws FileExtensionNotFoundException
```
Gets the mime type by extension.

Parameters:

extension - the extension

Returns:

the mime type by extension

Throws:

FileExtensionNotFoundException - the file extension not found exception

getFileVersion

public String getFileVersion(String fileId,
                             String workspace)
                      throws FileNotFoundException,
                             javax.jcr.RepositoryException

Gets the file version.

Parameters:: fileId - the file id; workspace - the workspace
Returns:: the file version
Throws:: FileNotFoundException - the file not found exception; javax.jcr.RepositoryException - the repository exception

getFileName

public String getFileName(String fileId,
                          String workspace)
                   throws FileNotFoundException,
                          javax.jcr.RepositoryException

Gets the file name.

Parameters:: fileId - the file id; workspace - the workspace
Returns:: the file name
Throws:: FileNotFoundException - the file not found exception; javax.jcr.RepositoryException - the repository exception

delete

public void delete(EditorConfig config,
                   String lockId)
            throws javax.jcr.RepositoryException,
                   OfficeOnlineException,
                   LockMismatchException

Delete.

Parameters:: config - the config; lockId - the lock id
Throws:: javax.jcr.RepositoryException - the repository exception; OfficeOnlineException - the office online exception; LockMismatchException - the lock mismatch exception

checkNodeLock

protected void checkNodeLock(javax.jcr.Node node,
                             String lockId)
                      throws LockMismatchException,
                             javax.jcr.RepositoryException

Check node lock.

Parameters:: node - the node; lockId - the lock id
Throws:: LockMismatchException - the lock mismatch exception; javax.jcr.RepositoryException - the repository exception

putUserInfo

public void putUserInfo(String userId,
                        String userInfo)

Put user info.

Parameters:: userId - the user id; userInfo - the user info

addTypePlugin

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

isVersionAccumulationEnabled
```
public boolean isVersionAccumulationEnabled()
```
Checks if is version accumulation enabled.

Returns:

true, if is version accumulation enabled

setVersionAccumulation
```
public void setVersionAccumulation(boolean versionAccumulation)
```
Sets the version accumulation.

Parameters:

versionAccumulation - the new version accumulation

getUserId
```
protected String getUserId(String path)
```
Gets userId from node path.

Parameters:

path - the node path

Returns:

the userId

increaseName

protected String increaseName(String origin,
                              int count)

Increase name.

Parameters:: origin - the origin; count - the count
Returns:: the string

addListener
```
public void addListener(OfficeOnlineListener listener)
```
Adds the listener.

Parameters:

listener - the listener

removeListener
```
public void removeListener(OfficeOnlineListener listener)
```
Removes the listener.

Parameters:

listener - the listener

onSaved

public void onSaved(EditorConfig config)

On saved.

Parameters:: config - the config

Class WOPIService

Nested Class Summary

Field Summary

Fields inherited from class org.exoplatform.officeonline.AbstractOfficeOnlineService

Constructor Summary

Method Summary

Methods inherited from class org.exoplatform.officeonline.AbstractOfficeOnlineService

Methods inherited from class java.lang.Object

Field Detail

LOG

MSOFFICE_VERSION_OWNER

JCR_FROZEN_NODE

NT_RESOURCE

NT_FILE

MSOFFICE_IS_EDITOR_VERSION

BASE_FILE_NAME

DEFAULT_FILENAME

OWNER_ID

FILES_ENDPOINT

SIZE

USER_ID

VERSION

BREADCRUMB_BRAND_NAME

BREADCRUMB_BRAND_URL

BREADCRUMB_FOLDER_NAME

BREADCRUMB_FOLDER_URL

CLOSE_URL

DOWNLOAD_URL

FILE_URL

FILE_VERSION_URL

HOST_EDIT_URL

HOST_VIEW_URL

SIGNOUT_URL

SUPPORTS_EXTENDED_LOCK_LENGTH

SUPPORTS_GET_LOCK

SUPPORTS_LOCKS

SUPPORTS_RENAME

SUPPORTS_UPDATE

SUPPORTS_DELETE_FILE

SUPPORTS_USER_INFO

SUPPORTED_SHARE_URL_TYPES

POST_MESSAGE_ORIGIN

FILE_VERSION_POST_MESSAGE

EDIT_NOTIFICATION_POST_MESSAGE

IS_ANONYMOUS_USER

USER_INFO

LICENSE_CHECK_FOR_EDIT_IS_ENABLED

USER_FRIENDLY_NAME

PLACEHOLDER_WOPISRC

PLACEHOLDER_DC_LLCC

PLACEHOLDER_UI_LLCC

SHARE_URL

SHARE_URL_READ_ONLY

SHARE_URL_READ_WRITE

TOKEN_CONFIGURATION_PROPERTIES

BREADCRUMB_CONFIGURATION_PROPERTIES

WOPI_CONFIGURATION_PROPERTIES

VERSION_ACCUMULATION_PROPERTIES

VERSION_ACCUMULATION

WOPI_URL

BRAND_NAME

MAX_FILENAME_LENGHT

USERINFO_CACHE_NAME

EDIT_ACTION

EDITNEW_ACTION

VIEW_ACTION

VIEW_PARAM

EDIT_PARAM

EDITNEW_PARAM

VERSION_TIMEOUT

usersPath

trashService

discoveryPlugin

wopiAvailabilityChecker

lockManager

brandName

wopiUrl

versionAccumulation

platformScheme

platformHost