org.xwiki.netflux

Interface EntityChannelStore

@Role
 @Unstable
public interface EntityChannelStore

The component used to create and associate channels to XWiki entities.

Since:

13.9RC1

Version:

$Id: 23f6a5c6946cbb0108645e7593b68afa8f0c97a9 $

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.
default Optional<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)
default 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.

Method Detail

getChannels

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

Parameters:

entityReference - an entity reference

Returns:

all existing channels associated to the specified entity

getChannels

default 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

default Optional<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

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