Config (eXo OnlyOffice Editor :: Extension Services 1.5.0-M04 API)

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 Onlyoffice Document.
`static class`	`Config.Editor` The Onlyoffice 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.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Config()` Instantiates a new config for use with `Externalizable` methods.
`protected`	`Config(String documentserverUrl, String platformRestUrl, String editorUrl, URI explorerUri, String documentType, String workspace, String path, EditorPage editorPage, Boolean isActivity, String docId, Config.Document document, Config.Editor editor)` Editor config constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`callbackUrl(CharSequence baseUrl, String userId, String key)` Callback url.
`void`	`closed()` Mark this config as closed: the editor closed, if it was last user in the editor, then its document should be saved in the storage.
`void`	`closing()` Mark this config as closing: user already closed this editor but document not yet saved in the storage.
`protected static Config.Builder`	`editor(String documentserverUrl, String documentType, String workspace, String path, String docId)` Editor.
`boolean`	`equals(Object obj)`
`protected static String`	`fileUrl(CharSequence baseUrl, String userId, String key)` File url.
`Config`	`forUser(String id, String firstName, String lastName, String lang, String documentserverSecret)` Create a copy of this editor but for another given user.
`Long`	`getClosedTime()` Gets the closedTime.
`String`	`getDocId()` Gets the document ID in storage.
`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.
`EditorPage`	`getEditorPage()` Gets the editor page.
`String`	`getEditorUrl()` Gets the editor absolute URL.
`String`	`getError()` Gets the error.
`URI`	`getExplorerUri()` Gets the explorer page URI.
`String`	`getExplorerUrl()` Gets the explorer absolute URL.
`Long`	`getOpenedTime()` Gets the openedTime.
`String`	`getPath()` Gets the path in storage.
`Calendar`	`getPreviousModified()`
`Boolean`	`getSameModifier()`
`String`	`getToken()` Gets the token.
`String`	`getWorkspace()` Gets a workspace of the storage.
`boolean`	`hasError()` Checks for error.
`Boolean`	`isActivity()` Is activity
`boolean`	`isClosed()` Checks if is editor closed (including closing state).
`boolean`	`isClosing()` Checks if is editor currently closing (saving the document).
`boolean`	`isCreated()` Checks if is created.
`boolean`	`isOpen()` Checks if is editor open.
`void`	`open()` Mark this config as open: user opened this editor.
`void`	`readExternal(ObjectInput in)`
`protected void`	`setClosedTime(Long closedTime)` Sets the closedTime.
`protected void`	`setEditorPage(EditorPage editorPage)` Sets the editorPage.
`protected void`	`setError(String error)` Sets the error.
`protected void`	`setOpenedTime(Long openedTime)` Sets the openedTime.
`void`	`setPreviousModified(Calendar previousModified)`
`void`	`setSameModifier(Boolean samemodifier)`
`void`	`setToken(String token)` Sets the token.
`String`	`toJSON()` Return this config as JSON string.
`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.
- Constructor Detail
  - Config
```
public Config()
```
    Instantiates a new config for use with Externalizable methods. User by serialization.
  - Config
```
protected Config(String documentserverUrl,
                 String platformRestUrl,
                 String editorUrl,
                 URI explorerUri,
                 String documentType,
                 String workspace,
                 String path,
                 EditorPage editorPage,
                 Boolean isActivity,
                 String docId,
                 Config.Document document,
                 Config.Editor editor)
```
    Editor config constructor.
    
    Parameters:
    
    documentserverUrl - the documentserver URL
    
    platformRestUrl - the platform url
    
    editorUrl - the editor url
    
    explorerUri - the explorer uri
    
    documentType - the document type
    
    workspace - the workspace
    
    path - the path
    
    editorPage - the editor page
    
    isActivity - the isActivity
    
    docId - the document ID
    
    document - the document
    
    editor - the editor
- Method Detail
  - editor
```
protected static Config.Builder editor(String documentserverUrl,
                                       String documentType,
                                       String workspace,
                                       String path,
                                       String docId)
```
    Editor.
    
    Parameters:
    
    documentserverUrl - the documentserver url
    
    documentType - the document type
    
    workspace - the workspace
    
    path - the path
    
    docId - the document ID
    
    Returns:
    
    the builder
  - fileUrl
```
protected static String fileUrl(CharSequence baseUrl,
                                String userId,
                                String key)
```
    File url.
    
    Parameters:
    
    baseUrl - the platform url
    
    userId - the user id
    
    key - the key
    
    Returns:
    
    the string
  - callbackUrl
```
protected static String callbackUrl(CharSequence baseUrl,
                                    String userId,
                                    String key)
```
    Callback url.
    
    Parameters:
    
    baseUrl - 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
  - getToken
```
public String getToken()
```
    Gets the token.
    
    Returns:
    
    the token
  - setToken
```
public void setToken(String token)
```
    Sets the token.
    
    Parameters:
    
    token - the token
  - getWorkspace
```
public String getWorkspace()
```
    Gets a workspace of the storage.
    
    Returns:
    
    the workspace
  - getPath
```
public String getPath()
```
    Gets the path in storage.
    
    Returns:
    
    the path
  - isActivity
```
public Boolean isActivity()
```
    Is activity
    
    Returns:
    
    the isActivity
  - getEditorPage
```
public EditorPage getEditorPage()
```
    Gets the editor page.
    
    Returns:
    
    the editorPage
  - getDocId
```
public String getDocId()
```
    Gets the document ID in storage.
    
    Returns:
    
    the docId
  - getEditorUrl
```
public String getEditorUrl()
```
    Gets the editor absolute URL.
    
    Returns:
    
    the editorUrl
  - getExplorerUrl
```
public String getExplorerUrl()
```
    Gets the explorer absolute URL.
    
    Returns:
    
    the explorerUrl
  - getExplorerUri
```
public URI getExplorerUri()
```
    Gets the explorer page URI.
    
    Returns:
    
    the explorer URI
  - getDocumentType
```
public String getDocumentType()
```
    Gets the document type.
    
    Returns:
    
    the documentType
  - getDocument
```
public Config.Document getDocument()
```
    Gets the document.
    
    Returns:
    
    the config
  - getOpenedTime
```
public Long getOpenedTime()
```
    Gets the openedTime.
    
    Returns:
    
    the openedTime
  - getClosedTime
```
public Long getClosedTime()
```
    Gets the closedTime.
    
    Returns:
    
    the closedTime
  - setOpenedTime
```
protected void setOpenedTime(Long openedTime)
```
    Sets the openedTime.
    
    Parameters:
    
    openedTime - the openedTime
  - setClosedTime
```
protected void setClosedTime(Long closedTime)
```
    Sets the closedTime.
    
    Parameters:
    
    closedTime - the closedTime
  - setEditorPage
```
protected void setEditorPage(EditorPage editorPage)
```
    Sets the editorPage.
    
    Parameters:
    
    editorPage - the editorPage
  - getEditorConfig
```
public Config.Editor getEditorConfig()
```
    Gets the editor config.
    
    Returns:
    
    the editor
  - setPreviousModified
```
public void setPreviousModified(Calendar previousModified)
```
  - getPreviousModified
```
public Calendar getPreviousModified()
```
  - setSameModifier
```
public void setSameModifier(Boolean samemodifier)
```
  - getSameModifier
```
public Boolean getSameModifier()
```
  - forUser
```
public Config forUser(String id,
                      String firstName,
                      String lastName,
                      String lang,
                      String documentserverSecret)
```
    Create a copy of this editor but for another given user.
    
    Parameters:
    
    id - String
    
    firstName - String
    
    lastName - String
    
    lang - String
    
    documentserverSecret - the documentserverSecret
    
    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 editor open.
    
    Returns:
    
    true, if is open
  - isClosed
```
public boolean isClosed()
```
    Checks if is editor closed (including closing state).
    
    Returns:
    
    true, if is in closed or closing state
  - isClosing
```
public boolean isClosing()
```
    Checks if is editor currently closing (saving the document). A closing state is a sub-form of closed state.
    
    Returns:
    
    true of document in closing (saving) state
  - open
```
public void open()
```
    Mark this config as open: user opened this editor.
  - closing
```
public void closing()
```
    Mark this config as closing: user already closed this editor but document not yet saved in the storage. This state is actual for last user who will save the document submitted by the DS. Note that only already open editor can be set to closing state, otherwise this method will have not effect.
  - closed
```
public void closed()
```
    Mark this config as closed: the editor closed, if it was last user in the editor, then its document should be saved in the storage.
  - setError
```
protected 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
  - toJSON
```
public String toJSON()
              throws org.exoplatform.ws.frameworks.json.impl.JsonException
```
    Return this config as JSON string.
    
    Returns:
    
    the string
    
    Throws:
    
    org.exoplatform.ws.frameworks.json.impl.JsonException - the json exception

Class Config

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATETIME_FORMAT

NO_LANG

EMPTY

Constructor Detail

Config

Config

Method Detail

editor

fileUrl

callbackUrl

writeExternal

readExternal

getDocumentserverJsUrl

getDocumentserverUrl

getToken

setToken

getWorkspace

getPath

isActivity

getEditorPage

getDocId

getEditorUrl

getExplorerUrl

getExplorerUri

getDocumentType

getDocument

getOpenedTime

getClosedTime

setOpenedTime

setClosedTime

setEditorPage

getEditorConfig

setPreviousModified

getPreviousModified

setSameModifier

getSameModifier

forUser

isCreated

isOpen

isClosed

isClosing

open

closing

closed

setError

hasError

getError

equals

toString

toJSON