org.sodeac.common.message.dispatcher.api

Interface ISubChannel<T>

All Superinterfaces:

IChannel<T>

All Known Implementing Classes:

SubChannelImpl

public interface ISubChannel<T>
extends IChannel<T>

API for a special scope in channels.

Author:

Sebastian Palarus

Method Summary

Modifier and Type	Method and Description
default ISubChannel<?>	createSubChannel(UUID scopeId, String scopeName, Map<String,Object> configurationProperties, Map<String,Object> stateProperties) creates a ISubChannel in global scope (IChannel) with this scope as parent scope.
void	dispose() dispose this scope and remove it from global scope
String	getChannelName() getter for scope name
ISubChannel<?>	getParentChannel() getter for parent scope, if exists.
UUID	getScopeId() getter for scope id.

Methods inherited from interface org.sodeac.common.message.dispatcher.api.IChannel

createChildScope, createChildScope, getAdapter, getAdapter, getChildScope, getChildScopes, getConfigurationPropertyBlock, getDispatcher, getId, getMessage, getMessageSnapshot, getMessageSnapshotPoll, getRootChannel, getStatePropertyBlock, getTask, getTaskPropertyBlock, removeAdapter, removeMessage, removeMessageList, removeTask, rescheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTask, setAdapter, signal, storeMessage, storeMessage, storeMessageWithResult, storeMessageWithResult

Method Detail

getScopeId

UUID getScopeId()

getter for scope id. ScopeId is unique key (by global session) addressed this scope

Returns:

scope id

getParentChannel

ISubChannel<?> getParentChannel()

getter for parent scope, if exists. The parent scope is defined by virtual tree structure

Returns:

parentScope or null

getChannelName

String getChannelName()

getter for scope name

Returns:

human readable name of this scope (or null if nut defined)

dispose

void dispose()

dispose this scope and remove it from global scope

createSubChannel

default ISubChannel<?> createSubChannel(UUID scopeId,
                                        String scopeName,
                                        Map<String,Object> configurationProperties,
                                        Map<String,Object> stateProperties)

creates a ISubChannel in global scope (IChannel) with this scope as parent scope.

Parameters:

scopeId - unique id of scope (unique by queue) or null for auto-generation

scopeName - human readable name of scope (nullable)

configurationProperties - blue print for configuration propertyblock of new scope (nullable)

stateProperties - blue print for state propertyblock of new scope (nullable)

Returns:

new scope, or null, if scope already exists