com.vaadin.collaborationengine

Interface Backend

All Known Implementing Classes:

LocalBackend

public interface Backend

The interface between a cluster backend and Collaboration Engine.

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Backend.EventLog A strictly ordered log of submitted events.

Method Summary

Modifier and Type	Method and Description
Backend.EventLog	openEventLog(String logId) Opens an event log with the given id.

Method Detail

openEventLog

Backend.EventLog openEventLog(String logId)

Opens an event log with the given id. The returned object can be used to capture any common state related to this particular event log. An actual underlying connection is not needed until EventLog#subscribe(Consumer) is invoked, but it is still recommended to make this method fail fast in case it would not be possible to open an actual underlying connection later.

Parameters:

logId - the id of the event log to open, not null

Returns:

an object representing the event log, not null