@API(type=EXTENDABLE,
src=PUBLIC)
public abstract class WebappEditingSessionLifecycleListener
extends java.lang.Object
Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
Constructor and Description |
---|
WebappEditingSessionLifecycleListener() |
Modifier and Type | Method and Description |
---|---|
void |
editingSessionAboutToBeSerialized(java.lang.String sessionId,
AuthorDocumentModel documentModel)
The editing session was serialized to disk in order to free memory space.
|
void |
editingSessionAboutToBeStarted(java.lang.String sessionId,
java.lang.String licenseeId,
java.net.URL systemId,
java.util.Map<java.lang.String,java.lang.Object> options)
Method called when a new editing session is about to be started.
|
void |
editingSessionClosed(java.lang.String sessionId,
AuthorDocumentModel documentModel)
The session was closed by the user.
|
void |
editingSessionDeserialized(java.lang.String sessionId,
AuthorDocumentModel documentModel)
The editing session was deserialized because the user made some changes
to it.
|
void |
editingSessionStarted(java.lang.String sessionId,
AuthorDocumentModel documentModel)
Method called when the editing session has already started.
|
public WebappEditingSessionLifecycleListener()
public void editingSessionAboutToBeStarted(java.lang.String sessionId, java.lang.String licenseeId, java.net.URL systemId, java.util.Map<java.lang.String,java.lang.Object> options) throws EditingSessionOpenVetoException
sessionId
- The id of the session in which the editing of the opened
document happens.licenseeId
- The licensee id of the user that opened the document. If one user uses
multiple browsers, it will have a different such id for each of the browsers.systemId
- The system id of the XML document about to be opened.options
- The options containing
- the cookies used for the document load request
- the key is the cookie name prefixed with 'cookie-'
- the value is a String
- the other HTTP headers
- the key is the header name prefixed with "header-"
- the value is a list of strings.
- the session id set by the Servlet container with the key: "session-id".
- options set explicitly by the client JS code, the value being a string.EditingSessionOpenVetoException
- When implementation decides that
the editing session should not be started.public void editingSessionStarted(java.lang.String sessionId, AuthorDocumentModel documentModel)
sessionId
- The if of the session.documentModel
- The model of the edited document. From it one can
derive the URL and the options used to open it.
For the URL : documentModel.getAuthorDocumentController().getAuthorDocumentNode().getSystemID()
For the editing session options: documentModel.getAuthorAccess().getEditorAccess().getEditingContext()
This document model may change during the lifetime of the session as it is
inactivated and activated back.public void editingSessionClosed(java.lang.String sessionId, AuthorDocumentModel documentModel)
sessionId
- The id of the session.documentModel
- The model of the edited document.public void editingSessionAboutToBeSerialized(java.lang.String sessionId, AuthorDocumentModel documentModel)
sessionId
- The id of the editing session.documentModel
- The model of edited document.public void editingSessionDeserialized(java.lang.String sessionId, AuthorDocumentModel documentModel)
sessionId
- The id of the editing session.documentModel
- The document model may not be the same as the one
created when the editing session was opened.© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.