org.exoplatform.onlyoffice

Class Config

java.lang.Object

org.exoplatform.onlyoffice.Config

All Implemented Interfaces:

Externalizable, Serializable

public class Config
extends Object
implements Externalizable

Onlyoffice editor config for its JS API.
This class implements Externalizable for serialization in eXo cache (actual in cluster). Created by The eXo Platform SAS.

Version:

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

Author:

Peter Nedonosko

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.Builder The Class Builder.
static class	Config.Document The Class Document.
static class	Config.Editor The Class Editor.

Field Summary

Fields

Modifier and Type	Field and Description
protected static SimpleDateFormat	DATETIME_FORMAT The Constant DATETIME_FORMAT.
protected static String	EMPTY The Constant EMPTY.
protected static String	NO_LANG The Constant NO_LANG.
protected Boolean	open Marker of editor state.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Config() Instantiates a new config for use with Externalizable methods.
protected	Config(String documentserverUrl, String platformUrl, String workspace, String path, String documentType, Config.Document document, Config.Editor editor) Editor config constructor.

Method Summary

Modifier and Type	Method and Description
protected static String	callbackUrl(String platformUrl, String userId, String key) Callback url.
void	close() Mark this this config as closed: user already closed this editor.
protected static Config.Builder	editor(String documentserverUrl, String workspace, String path, String documentType) Editor.
boolean	equals(Object obj)
protected static String	fileUrl(String platformUrl, String userId, String key) File url.
Config	forUser(String id, String firstName, String lastName, String lang) Create a copy of this editor but for another given user.
javax.jcr.Node	getContextNode() Gets the context node.
Config.Document	getDocument() Gets the document.
String	getDocumentserverJsUrl() Gets the documentserver js url.
String	getDocumentserverUrl() Gets the documentserver url.
String	getDocumentType() Gets the document type.
Config.Editor	getEditorConfig() Gets the editor config.
String	getError() Gets the error.
String	getPath() Gets the path.
String	getWorkspace() Gets the workspace.
boolean	hasError() Checks for error.
boolean	isClosed() Checks if is closed.
boolean	isCreated() Checks if is created.
boolean	isOpen() Checks if is open.
void	open() Mark this this config as open: user opened this editor.
void	readExternal(ObjectInput in)
protected void	setContextNode(javax.jcr.Node node) Sets the context node.
void	setError(String error) Sets the error.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

DATETIME_FORMAT

protected static final SimpleDateFormat DATETIME_FORMAT

The Constant DATETIME_FORMAT.

NO_LANG

protected static final String NO_LANG

The Constant NO_LANG.

EMPTY

protected static final String EMPTY

The Constant EMPTY.

open

protected Boolean open

Marker of editor state. By default editor state is undefined and will be treated as not open nor not closed. When editor will be open in Onlyoffice it will send a status (1) and then need mark the editor open.

Constructor Detail

Config

public Config()

Instantiates a new config for use with Externalizable methods.

Config

protected Config(String documentserverUrl,
                 String platformUrl,
                 String workspace,
                 String path,
                 String documentType,
                 Config.Document document,
                 Config.Editor editor)

Editor config constructor.

Parameters:

documentserverUrl - the documentserver url

platformUrl - the platform url

workspace - the workspace

path - the path

documentType - the document type

document - the document

editor - the editor

Method Detail

editor

protected static Config.Builder editor(String documentserverUrl,
                                       String workspace,
                                       String path,
                                       String documentType)

Editor.

Parameters:

documentserverUrl - the documentserver url

workspace - the workspace

path - the path

documentType - the document type

Returns:

the builder

fileUrl

protected static String fileUrl(String platformUrl,
                                String userId,
                                String key)

File url.

Parameters:

platformUrl - the platform url

userId - the user id

key - the key

Returns:

the string

callbackUrl

protected static String callbackUrl(String platformUrl,
                                    String userId,
                                    String key)

Callback url.

Parameters:

platformUrl - the platform url

userId - the user id

key - the key

Returns:

the string

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

getDocumentserverJsUrl

public String getDocumentserverJsUrl()

Gets the documentserver js url.

Returns:

the documentserverJsUrl

getDocumentserverUrl

public String getDocumentserverUrl()

Gets the documentserver url.

Returns:

the documentserverUrl

getContextNode

public javax.jcr.Node getContextNode()

Gets the context node.

Returns:

the node in context, can be null

setContextNode

protected void setContextNode(javax.jcr.Node node)

Sets the context node.

Parameters:

node - the node to set

getWorkspace

public String getWorkspace()

Gets the workspace.

Returns:

the workspace

getPath

public String getPath()

Gets the path.

Returns:

the path

getDocumentType

public String getDocumentType()

Gets the document type.

Returns:

the documentType

getDocument

public Config.Document getDocument()

Gets the document.

Returns:

the config

getEditorConfig

public Config.Editor getEditorConfig()

Gets the editor config.

Returns:

the editor

forUser

public Config forUser(String id,
                      String firstName,
                      String lastName,
                      String lang)

Create a copy of this editor but for another given user.

Parameters:

id - String

firstName - String

lastName - String

lang - String

Returns:

Config an instance of config similar to this but with another user in the editor

isCreated

public boolean isCreated()

Checks if is created.

Returns:

true, if is created

isOpen

public boolean isOpen()

Checks if is open.

Returns:

true, if is open

isClosed

public boolean isClosed()

Checks if is closed.

Returns:

true, if is closed

open

public void open()

Mark this this config as open: user opened this editor.

close

public void close()

Mark this this config as closed: user already closed this editor.

setError

public void setError(String error)

Sets the error.

Parameters:

error - the new error

hasError

public boolean hasError()

Checks for error.

Returns:

true, if successful

getError

public String getError()

Gets the error.

Returns:

the error

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object