org.exoplatform.onlyoffice.rest

Class EditorService

java.lang.Object

org.exoplatform.onlyoffice.rest.EditorService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class EditorService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

REST service implementing Onlyoffice config storage service.
Created by The eXo Platform SAS.

Version:

$Id: EditorService.java 00000 Feb 12, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected OnlyofficeEditorService	editors
static String	INIT_COOKIE_PATH
protected Map<UUID,Config>	initiated
protected DriveServiceLocator	locator
protected static org.exoplatform.services.log.Log	LOG

Constructor Summary

Constructors

Constructor and Description
EditorService(OnlyofficeEditorService editors, DriveServiceLocator locator) REST cloudDrives uses OnlyofficeEditorService for actual job.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	config(javax.ws.rs.core.UriInfo uriInfo, String workspace, String path) Config configuration for Onlyoffice JS.
javax.ws.rs.core.Response	content(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, String userId, String key) Document content download link.
protected String	getClientHost(javax.servlet.http.HttpServletRequest request)
protected String	getClientIpAddr(javax.servlet.http.HttpServletRequest request)
protected boolean	isValidName(String hostName)
javax.ws.rs.core.Response	localState(javax.ws.rs.core.UriInfo uriInfo, String userId, String key) Editing document state in local storage.
javax.ws.rs.core.Response	status(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, String userId, String key, String statusText) Config status posted from the Document Server.

Methods inherited from class java.lang.Object

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

Field Detail

INIT_COOKIE_PATH

public static final String INIT_COOKIE_PATH

See Also:

Constant Field Values

LOG

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

editors

protected final OnlyofficeEditorService editors

locator

protected final DriveServiceLocator locator

initiated

protected final Map<UUID,Config> initiated

Constructor Detail

EditorService

public EditorService(OnlyofficeEditorService editors,
             DriveServiceLocator locator)

REST cloudDrives uses OnlyofficeEditorService for actual job.

Parameters:

editors -

locator -

jcrService -

sessionProviders -

finder -

Method Detail

status

public javax.ws.rs.core.Response status(@Context
                               javax.ws.rs.core.UriInfo uriInfo,
                               @Context
                               javax.servlet.http.HttpServletRequest request,
                               String userId,
                               String key,
                               String statusText)

Config status posted from the Document Server.
WARNING! It is publicly accessible service but access from the Documents Server host can be restricted (by default).

Parameters:

uriInfo - - request info

key - - config key generated when requested editor config

status - DocumentStatus

Returns:

Response

content

public javax.ws.rs.core.Response content(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                javax.servlet.http.HttpServletRequest request,
                                String userId,
                                String key)

Document content download link.
WARNING! It is publicly accessible service but access from the Documents Server host can be restricted (by default).

Parameters:

uriInfo - - request info

key - - file key generated by /config method

Returns:

Response

config

@RolesAllowed(value="users")
public javax.ws.rs.core.Response config(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            String workspace,
                                            String path)

Config configuration for Onlyoffice JS.

Parameters:

uriInfo - - request with base URI

providerId - - provider name see more in CloudProvider

Returns:

response with

localState

@RolesAllowed(value="users")
public javax.ws.rs.core.Response localState(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                String userId,
                                                String key)

Editing document state in local storage.

Parameters:

uriInfo - - request info

key - - config key generated when requested editor config

status - DocumentStatus

Returns:

Response

getClientIpAddr

protected String getClientIpAddr(javax.servlet.http.HttpServletRequest request)

getClientHost

protected String getClientHost(javax.servlet.http.HttpServletRequest request)

isValidName

protected boolean isValidName(String hostName)