org.openecomp.policy.drools.event.comm

Interface TopicEndpoint

All Superinterfaces:

org.openecomp.policy.drools.properties.Lockable, org.openecomp.policy.drools.properties.Startable

public interface TopicEndpoint
extends org.openecomp.policy.drools.properties.Startable, org.openecomp.policy.drools.properties.Lockable

Abstraction to managed the system's Networked Topic Endpoints, sources of all events input into the System.

Field Summary

Fields

Modifier and Type	Field and Description
static TopicEndpoint	manager singleton for global access

Method Summary

Modifier and Type	Method and Description
List<? extends TopicSink>	addTopicSinks(Properties properties) Add Topic Sinks to the communication infrastructure initialized per properties
List<? extends TopicSource>	addTopicSources(Properties properties) Add Topic Sources to the communication infrastructure initialized per properties
DmaapTopicSink	getDmaapTopicSink(String topicName) get the DMAAP Topic Source for the given topic name
List<DmaapTopicSink>	getDmaapTopicSinks() gets only the DMAAP Topic Sinks
DmaapTopicSource	getDmaapTopicSource(String topicName) get the DMAAP Topic Source for the given topic name
List<DmaapTopicSource>	getDmaapTopicSources() gets only the DMAAP Topic Sources
TopicSink	getTopicSink(Topic.CommInfrastructure commType, String topicName) get the Topic Sinks for the given topic name and underlying communication infrastructure type
List<? extends TopicSink>	getTopicSinks() gets all Topic Sinks
List<? extends TopicSink>	getTopicSinks(List<String> topicNames) get the Topic Sinks for the given topic name
List<? extends TopicSink>	getTopicSinks(String topicName) get the Topic Sinks for the given topic name and all the underlying communication infrastructure type
TopicSource	getTopicSource(Topic.CommInfrastructure commType, String topicName) gets the Topic Source for the given topic name and underlying communication infrastructure type
List<? extends TopicSource>	getTopicSources() gets all Topic Sources
List<? extends TopicSource>	getTopicSources(List<String> topicNames) get the Topic Sources for the given topic name
UebTopicSink	getUebTopicSink(String topicName) get the UEB Topic Source for the given topic name
List<UebTopicSink>	getUebTopicSinks() gets only the UEB Topic Sinks
UebTopicSource	getUebTopicSource(String topicName) get the UEB Topic Source for the given topic name
List<UebTopicSource>	getUebTopicSources() gets only the UEB Topic Sources

Methods inherited from interface org.openecomp.policy.drools.properties.Startable

isAlive, shutdown, start, stop

Methods inherited from interface org.openecomp.policy.drools.properties.Lockable

isLocked, lock, unlock

Field Detail

manager

static final TopicEndpoint manager

singleton for global access

Method Detail

addTopicSources

List<? extends TopicSource> addTopicSources(Properties properties)
                                     throws IllegalArgumentException

Add Topic Sources to the communication infrastructure initialized per properties

Parameters:

properties - properties for Topic Source construction

Returns:

a generic Topic Source

Throws:

IllegalArgumentException - when invalid arguments are provided

addTopicSinks

List<? extends TopicSink> addTopicSinks(Properties properties)
                                 throws IllegalArgumentException

Add Topic Sinks to the communication infrastructure initialized per properties

Parameters:

properties - properties for Topic Sink construction

Returns:

a generic Topic Sink

Throws:

IllegalArgumentException - when invalid arguments are provided

getTopicSources

List<? extends TopicSource> getTopicSources()

gets all Topic Sources

Returns:

the Topic Source List

getTopicSources

List<? extends TopicSource> getTopicSources(List<String> topicNames)
                                     throws IllegalStateException,
                                            IllegalArgumentException

get the Topic Sources for the given topic name

Parameters:

topicName - the topic name

Returns:

the Topic Source List

Throws:

IllegalStateException - if the entity is in an invalid state

IllegalArgumentException - if invalid parameters are present

getTopicSource

TopicSource getTopicSource(Topic.CommInfrastructure commType,
                           String topicName)
                    throws IllegalStateException,
                           IllegalArgumentException,
                           UnsupportedOperationException

gets the Topic Source for the given topic name and underlying communication infrastructure type

Parameters:

commType - communication infrastructure type

topicName - the topic name

Returns:

the Topic Source

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicReaders for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

UnsupportedOperationException - if the operation is not supported.

getUebTopicSource

UebTopicSource getUebTopicSource(String topicName)
                          throws IllegalStateException,
                                 IllegalArgumentException

get the UEB Topic Source for the given topic name

Parameters:

topicName - the topic name

Returns:

the UEB Topic Source

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicReaders for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

getDmaapTopicSource

DmaapTopicSource getDmaapTopicSource(String topicName)
                              throws IllegalStateException,
                                     IllegalArgumentException

get the DMAAP Topic Source for the given topic name

Parameters:

topicName - the topic name

Returns:

the DMAAP Topic Source

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicReaders for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

getTopicSinks

List<? extends TopicSink> getTopicSinks(List<String> topicNames)
                                 throws IllegalStateException,
                                        IllegalArgumentException

get the Topic Sinks for the given topic name

Parameters:

topicNames - the topic names

Returns:

the Topic Sink List

Throws:

IllegalStateException

IllegalArgumentException

getTopicSink

TopicSink getTopicSink(Topic.CommInfrastructure commType,
                       String topicName)
                throws IllegalStateException,
                       IllegalArgumentException,
                       UnsupportedOperationException

get the Topic Sinks for the given topic name and underlying communication infrastructure type

Parameters:

topicName - the topic name

commType - communication infrastructure type

Returns:

the Topic Sink List

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicWriters for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

UnsupportedOperationException

getTopicSinks

List<? extends TopicSink> getTopicSinks(String topicName)
                                 throws IllegalStateException,
                                        IllegalArgumentException

get the Topic Sinks for the given topic name and all the underlying communication infrastructure type

Parameters:

topicName - the topic name

commType - communication infrastructure type

Returns:

the Topic Sink List

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicWriters for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

getUebTopicSink

UebTopicSink getUebTopicSink(String topicName)
                      throws IllegalStateException,
                             IllegalArgumentException

get the UEB Topic Source for the given topic name

Parameters:

topicName - the topic name

Returns:

the Topic Source

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicReaders for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

getDmaapTopicSink

DmaapTopicSink getDmaapTopicSink(String topicName)
                          throws IllegalStateException,
                                 IllegalArgumentException

get the DMAAP Topic Source for the given topic name

Parameters:

topicName - the topic name

Returns:

the Topic Source

Throws:

IllegalStateException - if the entity is in an invalid state, for example multiple TopicReaders for a topic name and communication infrastructure

IllegalArgumentException - if invalid parameters are present

getUebTopicSources

List<UebTopicSource> getUebTopicSources()

gets only the UEB Topic Sources

Returns:

the UEB Topic Source List

getDmaapTopicSources

List<DmaapTopicSource> getDmaapTopicSources()

gets only the DMAAP Topic Sources

Returns:

the DMAAP Topic Source List

getTopicSinks

List<? extends TopicSink> getTopicSinks()

gets all Topic Sinks

Returns:

the Topic Sink List

getUebTopicSinks

List<UebTopicSink> getUebTopicSinks()

gets only the UEB Topic Sinks

Returns:

the UEB Topic Sink List

getDmaapTopicSinks

List<DmaapTopicSink> getDmaapTopicSinks()

gets only the DMAAP Topic Sinks

Returns:

the DMAAP Topic Sink List