org.exoplatform.onlyoffice.webui

Class OnlyofficeEditorUIService

java.lang.Object

org.exoplatform.onlyoffice.webui.OnlyofficeEditorUIService

public class OnlyofficeEditorUIService
extends Object

Support for stateful WebUI: keep tracking requests to open/close editor by users on partical file. Created by The eXo Platform SAS

Version:

$Id: OnlyofficeEditorUIService.java 00000 Mar 3, 2016 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	OnlyofficeEditorUIService.EditorListener The listener interface for receiving editor events.
protected static class	OnlyofficeEditorUIService.State The Enum State.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentHashMap<String,OnlyofficeEditorUIService.State>	editors Open editors.
protected OnlyofficeEditorService	editorService The editor service.

Constructor Summary

Constructors

Constructor and Description
OnlyofficeEditorUIService(OnlyofficeEditorService editorService) Instantiates a new onlyoffice editor UI service.

Method Summary

Modifier and Type	Method and Description
boolean	canClose(String userId, String workspace, String path) Can close.
boolean	canOpen(String userId, String workspace, String path) Can open.
boolean	canShow(String userId, String workspace, String path) Can show.
boolean	close(String userId, String workspace, String path) Close.
boolean	closed(String userId, String workspace, String path) Closed.
protected String	editorId(String userId, String workspace, String path) Editor id.
boolean	isClosed(String userId, String workspace, String path) Checks if is closed.
boolean	isClosing(String userId, String workspace, String path) Checks if is closing.
boolean	isOpen(String userId, String workspace, String path) Checks if is open.
boolean	isOpening(String userId, String workspace, String path) Checks if is opening.
boolean	open(String userId, String workspace, String path) Open.
boolean	opened(String userId, String workspace, String path) Opened.
boolean	reset(String userId, String workspace, String path) Reset.

Methods inherited from class java.lang.Object

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

Field Detail

editors

protected final ConcurrentHashMap<String,OnlyofficeEditorUIService.State> editors

Open editors.

editorService

protected final OnlyofficeEditorService editorService

The editor service.

Constructor Detail

OnlyofficeEditorUIService

public OnlyofficeEditorUIService(OnlyofficeEditorService editorService)

Instantiates a new onlyoffice editor UI service.

Parameters:

editorService - the editor service

Method Detail

open

public boolean open(String userId,
                    String workspace,
                    String path)

Open.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

opened

public boolean opened(String userId,
                      String workspace,
                      String path)

Opened.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

close

public boolean close(String userId,
                     String workspace,
                     String path)

Close.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

closed

public boolean closed(String userId,
                      String workspace,
                      String path)

Closed.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

reset

public boolean reset(String userId,
                     String workspace,
                     String path)

Reset.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

isOpening

public boolean isOpening(String userId,
                         String workspace,
                         String path)

Checks if is opening.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if is opening

isOpen

public boolean isOpen(String userId,
                      String workspace,
                      String path)

Checks if is open.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if is open

isClosing

public boolean isClosing(String userId,
                         String workspace,
                         String path)

Checks if is closing.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if is closing

isClosed

public boolean isClosed(String userId,
                        String workspace,
                        String path)

Checks if is closed.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if is closed

canShow

public boolean canShow(String userId,
                       String workspace,
                       String path)

Can show.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

canOpen

public boolean canOpen(String userId,
                       String workspace,
                       String path)

Can open.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

canClose

public boolean canClose(String userId,
                        String workspace,
                        String path)

Can close.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

true, if successful

editorId

protected String editorId(String userId,
                          String workspace,
                          String path)

Editor id.

Parameters:

userId - the user id

workspace - the workspace

path - the path

Returns:

the string