org.xwiki.netflux.script

Class NetfluxScriptService

java.lang.Object

org.xwiki.netflux.script.NetfluxScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Singleton
 @Named(value="netflux")
public class NetfluxScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Script-related APIs for real-time synchronization.

Since:

13.9RC1

Version:

$Id: acbcec90d07211ab2c9e9e65ebee8041e5367753 $

Constructor Summary

Constructors

Constructor and Description
NetfluxScriptService()

Method Summary

Modifier and Type	Method and Description
EntityChannel	createChannel(org.xwiki.model.reference.EntityReference entityReference, List<String> path) Associate a new channel to the specified entity, having the given path.
EntityChannel	getChannel(org.xwiki.model.reference.EntityReference entityReference, List<String> path) Looks for a channel associated to the specified entity and having the specified path.
List<EntityChannel>	getChannels(org.xwiki.model.reference.EntityReference entityReference)
List<EntityChannel>	getChannels(org.xwiki.model.reference.EntityReference entityReference, List<String> pathPrefix) Looks for the channels associated to the specified entity and having the specified path prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetfluxScriptService

public NetfluxScriptService()

Method Detail

getChannels

public List<EntityChannel> getChannels(org.xwiki.model.reference.EntityReference entityReference)

Parameters:

entityReference - an entity reference

Returns:

all existing channels associated to the specified entity

getChannels

public List<EntityChannel> getChannels(org.xwiki.model.reference.EntityReference entityReference,
                                       List<String> pathPrefix)

Looks for the channels associated to the specified entity and having the specified path prefix.

Parameters:

entityReference - an entity reference

pathPrefix - the path prefix used to match the channels

Returns:

all existing channels associated to the specified entity and having the specified path prefix

getChannel

public EntityChannel getChannel(org.xwiki.model.reference.EntityReference entityReference,
                                List<String> path)

Looks for a channel associated to the specified entity and having the specified path.

Parameters:

entityReference - the entity the channel is associated with

path - the channel path, used to identify the channel among all the channels associated to the same entity

Returns:

the found channel

createChannel

public EntityChannel createChannel(org.xwiki.model.reference.EntityReference entityReference,
                                   List<String> path)

Associate a new channel to the specified entity, having the given path.

Parameters:

entityReference - the entity to associate the channel with

path - the channel path, used to identify the channel among all the channels associated to the same entity

Returns:

information about the created channel