Class DocumentBroadcastConfig
- java.lang.Object
-
- org.apache.jackrabbit.oak.plugins.document.DocumentBroadcastConfig
-
- All Implemented Interfaces:
DynamicBroadcastConfig
public class DocumentBroadcastConfig extends java.lang.Object implements DynamicBroadcastConfig
-
-
Field Summary
-
Fields inherited from interface org.apache.jackrabbit.oak.plugins.document.persistentCache.broadcast.DynamicBroadcastConfig
ID, LISTENER
-
-
Constructor Summary
Constructors Constructor Description DocumentBroadcastConfig(DocumentNodeStore documentNodeStore)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
connect(java.util.Map<java.lang.String,java.lang.String> clientInfo)
Announce a new client to others.void
disconnect(java.lang.String id)
Sign off.java.util.List<java.util.Map<java.lang.String,java.lang.String>>
getClientInfo()
Get the client info of all connected clients.java.lang.String
getConfig()
Get the global configuration data that is not associated to a specific client.
-
-
-
Constructor Detail
-
DocumentBroadcastConfig
public DocumentBroadcastConfig(DocumentNodeStore documentNodeStore)
-
-
Method Detail
-
getConfig
public java.lang.String getConfig()
Description copied from interface:DynamicBroadcastConfig
Get the global configuration data that is not associated to a specific client.- Specified by:
getConfig
in interfaceDynamicBroadcastConfig
- Returns:
- the configuration
-
getClientInfo
public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getClientInfo()
Description copied from interface:DynamicBroadcastConfig
Get the client info of all connected clients.- Specified by:
getClientInfo
in interfaceDynamicBroadcastConfig
- Returns:
- the list of client info maps
-
connect
public java.lang.String connect(java.util.Map<java.lang.String,java.lang.String> clientInfo)
Description copied from interface:DynamicBroadcastConfig
Announce a new client to others.- Specified by:
connect
in interfaceDynamicBroadcastConfig
- Parameters:
clientInfo
- the client info- Returns:
- a unique id (to be used when disconnecting)
-
disconnect
public void disconnect(java.lang.String id)
Description copied from interface:DynamicBroadcastConfig
Sign off.- Specified by:
disconnect
in interfaceDynamicBroadcastConfig
- Parameters:
id
- the unique id
-
-