org.exoplatform.onlyoffice

Class Config

java.lang.Object

org.exoplatform.onlyoffice.Config

public class Config
extends Object

Onlyoffice editor config for its JS API.
Created by The eXo Platform SAS.

Version:

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

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static SimpleDateFormat	DATETIME_FORMAT
protected Config.Document	document
protected String	documentserverJsUrl
protected String	documentserverUrl
protected String	documentType
protected Config.Editor	editorConfig
protected String	error
protected javax.jcr.Node	node
protected Boolean	open Marker of editor state.
protected String	path
protected String	platformUrl
protected String	workspace

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Config(String documentserverUrl, String platformUrl, String workspace, String path, String documentType, Config.Document document, Config.Editor editor) Config constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	callbackUrl(String platformUrl, String userId, String key)
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)
boolean	equals(Object obj)
protected static String	fileUrl(String platformUrl, String userId, String key)
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()
Config.Document	getDocument()
String	getDocumentserverJsUrl()
String	getDocumentserverUrl()
String	getDocumentType()
Config.Editor	getEditorConfig()
String	getError()
String	getPath()
String	getWorkspace()
boolean	hasError()
boolean	isClosed()
boolean	isCreated()
boolean	isOpen()
void	open() Mark this this config as open: user opened this editor.
protected void	setContextNode(javax.jcr.Node node)
void	setError(String error)
String	toString()

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

documentserverUrl

protected final String documentserverUrl

documentserverJsUrl

protected final String documentserverJsUrl

platformUrl

protected final String platformUrl

workspace

protected final String workspace

path

protected final String path

documentType

protected final String documentType

document

protected final Config.Document document

editorConfig

protected final Config.Editor editorConfig

error

protected String error

node

protected transient javax.jcr.Node node

open

protected transient 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

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

Config constructor.

Method Detail

editor

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

fileUrl

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

callbackUrl

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

getDocumentserverJsUrl

public String getDocumentserverJsUrl()

Returns:

the documentserverJsUrl

getDocumentserverUrl

public String getDocumentserverUrl()

Returns:

the documentserverUrl

getContextNode

public javax.jcr.Node getContextNode()

Returns:

the node in context, can be null

setContextNode

protected void setContextNode(javax.jcr.Node node)

Parameters:

node - the node to set

getWorkspace

public String getWorkspace()

Returns:

the workspace

getPath

public String getPath()

Returns:

the path

getDocumentType

public String getDocumentType()

Returns:

the documentType

getDocument

public Config.Document getDocument()

Returns:

the config

getEditorConfig

public Config.Editor getEditorConfig()

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()

isOpen

public boolean isOpen()

isClosed

public boolean isClosed()

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)

hasError

public boolean hasError()

getError

public String getError()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object