org.exoplatform.officeonline.rest

Class WOPIResource

java.lang.Object

org.exoplatform.officeonline.rest.WOPIResource

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

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

The Class WOPIResource is responsible for handling WOPI requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WOPIResource.Operation The Enum Operation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_TOKEN The Constant ACCESS_TOKEN.
protected static String	API_VERSION The Constant API_VERSION.
static String	EDITOR_CONFIG_ATTRIBUTE The Constant ACCESS_TOKEN.
protected static String	FILE_CONVERSION The Constant FILE_CONVERSION.
protected static String	INVALID_FILE_NAME_ERROR The Constant INVALID_FILE_NAME_ERROR.
protected static String	ITEM_VERSION The Constant ITEM_VERSION.
protected static String	LOCK The Constant LOCK.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String	MAX_EXPECTED_SIZE The Constant MAX_EXPECTED_SIZE.
protected static String	OLD_LOCK The Constant OLD_LOCK.
protected static String	OVERRIDE The Constant OVERRIDE.
protected static String	OVERWRITE_RELATIVE_TARGET The Constant OVERWRITE_RELATIVE_TARGET.
protected static String	PROOF The Constant PROOF.
protected static String	PROOF_OLD The Constant PROOF_OLD.
protected static String	RELATIVE_TARGET The Constant RELATIVE_TARGET.
protected static String	REQUESTED_NAME The Constant REQUESTED_NAME.
protected static String	SUGGESTED_TARGET The Constant SUGGESTED_TARGET.
protected static String	TIMESTAMP The Constant TIMESTAMP.
protected static String	URL_TYPE The Constant URL_TYPE.
protected WOPIService	wopiService The editor service.
static String	WRONG_TOKEN_ATTRIBUTE The Constant WRONG_TOKEN.

Constructor Summary

Constructors

Constructor and Description
WOPIResource(WOPIService wopiService) Instantiates a new WOPI service.

Method Summary

Modifier and Type	Method and Description
protected void	addItemVersionHeader(javax.ws.rs.core.Response.ResponseBuilder response, EditorConfig config) Adds the item version header.
javax.ws.rs.core.Response	available() Endpoint for checking if WOPI is available.
javax.ws.rs.core.Response	checkFileInfo(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context) Check file info.
protected String	convertStreamToString(InputStream inputStream)
javax.ws.rs.core.Response	files(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context, WOPIResource.Operation operation, String fileId) Files.
protected String	getClientHost(javax.servlet.http.HttpServletRequest request) Gets the client host.
protected String	getClientIpAddr(javax.servlet.http.HttpServletRequest request) Gets the client ip addr.
protected EditorConfig	getEditorConfig(javax.servlet.ServletContext context) Gets the editor config.
javax.ws.rs.core.Response	getFile(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context, String fileId) Files.
protected boolean	isValidHost(String host) Checks if is valid host.
protected boolean	notEmpty(String str) Check string is not empty.
javax.ws.rs.core.Response	putFile(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context, WOPIResource.Operation operation, String fileId) Files.
protected javax.ws.rs.core.Response	putUserInfo(EditorConfig config, String userInfo)
protected void	verifyProofKey(javax.servlet.http.HttpServletRequest request) Verify proof key.
javax.ws.rs.core.Response	versionGet(javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request) Return Office Online REST API version.

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN

public static final String ACCESS_TOKEN

The Constant ACCESS_TOKEN.

See Also:

Constant Field Values

WRONG_TOKEN_ATTRIBUTE

public static final String WRONG_TOKEN_ATTRIBUTE

The Constant WRONG_TOKEN.

See Also:

Constant Field Values

EDITOR_CONFIG_ATTRIBUTE

public static final String EDITOR_CONFIG_ATTRIBUTE

The Constant ACCESS_TOKEN.

See Also:

Constant Field Values

FILE_CONVERSION

protected static final String FILE_CONVERSION

The Constant FILE_CONVERSION.

See Also:

Constant Field Values

ITEM_VERSION

protected static final String ITEM_VERSION

The Constant ITEM_VERSION.

See Also:

Constant Field Values

LOCK

protected static final String LOCK

The Constant LOCK.

See Also:

Constant Field Values

MAX_EXPECTED_SIZE

protected static final String MAX_EXPECTED_SIZE

The Constant MAX_EXPECTED_SIZE.

See Also:

Constant Field Values

OLD_LOCK

protected static final String OLD_LOCK

The Constant OLD_LOCK.

See Also:

Constant Field Values

OVERRIDE

protected static final String OVERRIDE

The Constant OVERRIDE.

See Also:

Constant Field Values

PROOF

protected static final String PROOF

The Constant PROOF.

See Also:

Constant Field Values

PROOF_OLD

protected static final String PROOF_OLD

The Constant PROOF_OLD.

See Also:

Constant Field Values

RELATIVE_TARGET

protected static final String RELATIVE_TARGET

The Constant RELATIVE_TARGET.

See Also:

Constant Field Values

OVERWRITE_RELATIVE_TARGET

protected static final String OVERWRITE_RELATIVE_TARGET

The Constant OVERWRITE_RELATIVE_TARGET.

See Also:

Constant Field Values

REQUESTED_NAME

protected static final String REQUESTED_NAME

The Constant REQUESTED_NAME.

See Also:

Constant Field Values

SUGGESTED_TARGET

protected static final String SUGGESTED_TARGET

The Constant SUGGESTED_TARGET.

See Also:

Constant Field Values

INVALID_FILE_NAME_ERROR

protected static final String INVALID_FILE_NAME_ERROR

The Constant INVALID_FILE_NAME_ERROR.

See Also:

Constant Field Values

URL_TYPE

protected static final String URL_TYPE

The Constant URL_TYPE.

See Also:

Constant Field Values

TIMESTAMP

protected static final String TIMESTAMP

The Constant TIMESTAMP.

See Also:

Constant Field Values

API_VERSION

protected static final String API_VERSION

The Constant API_VERSION.

See Also:

Constant Field Values

LOG

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

The Constant LOG.

wopiService

protected final WOPIService wopiService

The editor service.

Constructor Detail

WOPIResource

public WOPIResource(WOPIService wopiService)

Instantiates a new WOPI service.

Parameters:

wopiService - the wopi service

Method Detail

putFile

public javax.ws.rs.core.Response putFile(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         javax.servlet.http.HttpServletRequest request,
                                         @Context
                                         javax.servlet.ServletContext context,
                                         @HeaderParam(value="X-WOPI-Override")
                                         WOPIResource.Operation operation,
                                         String fileId)

Files.

Parameters:

uriInfo - the uri info

request - the request

context - the context

operation - the operation

fileId - the file id

Returns:

the response

getFile

public javax.ws.rs.core.Response getFile(@Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         javax.servlet.http.HttpServletRequest request,
                                         @Context
                                         javax.servlet.ServletContext context,
                                         String fileId)

Files.

Parameters:

uriInfo - the uri info

request - the request

context - the context

fileId - the file id

Returns:

the response

available

public javax.ws.rs.core.Response available()

Endpoint for checking if WOPI is available.

Returns:

the response

files

public javax.ws.rs.core.Response files(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.servlet.http.HttpServletRequest request,
                                       @Context
                                       javax.servlet.ServletContext context,
                                       @HeaderParam(value="X-WOPI-Override")
                                       WOPIResource.Operation operation,
                                       String fileId)

Files.

Parameters:

uriInfo - the uri info

request - the request

context - the context

operation - the operation

fileId - the file id

Returns:

the response

putUserInfo

protected javax.ws.rs.core.Response putUserInfo(EditorConfig config,
                                                String userInfo)

checkFileInfo

public javax.ws.rs.core.Response checkFileInfo(@Context
                                               javax.ws.rs.core.UriInfo uriInfo,
                                               @Context
                                               javax.servlet.http.HttpServletRequest request,
                                               @Context
                                               javax.servlet.ServletContext context)

Check file info.

Parameters:

uriInfo - the uri info

request - the request

context - the context

Returns:

the response

verifyProofKey

protected void verifyProofKey(javax.servlet.http.HttpServletRequest request)
                       throws ProofKeyValidationException

Verify proof key.

Parameters:

request - the request

Throws:

ProofKeyValidationException - the proof key validation exception

getEditorConfig

protected EditorConfig getEditorConfig(javax.servlet.ServletContext context)
                                throws AuthenticationFailedException,
                                       EditorConfigNotFoundException

Gets the editor config.

Parameters:

context - the context

Returns:

the editor config

Throws:

AuthenticationFailedException - the authentication failed exception

EditorConfigNotFoundException - the editor config not found exception

versionGet

public javax.ws.rs.core.Response versionGet(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            @Context
                                            javax.servlet.http.HttpServletRequest request)

Return Office Online REST API version.

Parameters:

uriInfo - - request with base URI

request - the request

Returns:

response with

getClientIpAddr

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

Gets the client ip addr.

Parameters:

request - the request

Returns:

the client ip addr

getClientHost

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

Gets the client host.

Parameters:

request - the request

Returns:

the client host

addItemVersionHeader

protected void addItemVersionHeader(javax.ws.rs.core.Response.ResponseBuilder response,
                                    EditorConfig config)

Adds the item version header.

Parameters:

response - the response

config - the config

notEmpty

protected boolean notEmpty(String str)

Check string is not empty.

Parameters:

str - the str

Returns:

true, if not empty, false otherwise

isValidHost

protected boolean isValidHost(String host)

Checks if is valid host. It's a trivial check for null, non empty string and not "unknown" text.

Parameters:

host - the host name or IP address

Returns:

true, if is valid host

convertStreamToString

protected String convertStreamToString(InputStream inputStream)
                                throws IOException

Throws:

IOException