org.openecomp.policy.drools.event.comm.bus.internal

Class InlineBusTopicSink

java.lang.Object

org.openecomp.policy.drools.event.comm.bus.internal.BusTopicBase

org.openecomp.policy.drools.event.comm.bus.internal.InlineBusTopicSink

All Implemented Interfaces:

BusTopic, BusTopicSink, Topic, TopicSink, org.openecomp.policy.drools.properties.Lockable, org.openecomp.policy.drools.properties.Startable

Direct Known Subclasses:

InlineDmaapTopicSink, InlineUebTopicSink

public abstract class InlineBusTopicSink
extends BusTopicBase
implements BusTopicSink

Transport Agnostic Bus Topic Sink to carry out the core functionality to interact with a sink regardless if it is UEB or DMaaP.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openecomp.policy.drools.event.comm.Topic

Topic.CommInfrastructure

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alive Am I running? reflects invocation of start()/stop() !locked & start() => alive stop() => !alive
protected boolean	locked Am I locked? reflects invocation of lock()/unlock() operations locked => !alive (but not in the other direction necessarily) locked => !offer, !run, !start, !stop (but this last one is obvious since locked => !alive)
protected static org.apache.log4j.Logger	networkLogger Not to be converted to PolicyLogger.
protected String	partitionId The partition key to publish to
protected BusPublisher	publisher message bus publisher

Fields inherited from class org.openecomp.policy.drools.event.comm.bus.internal.BusTopicBase

apiKey, apiSecret, recentEvents, servers, topic

Fields inherited from interface org.openecomp.policy.drools.event.comm.bus.BusTopicSink

DEFAULT_LOG_SEND_FAILURES_AFTER

Fields inherited from interface org.openecomp.policy.drools.event.comm.Topic

NETWORK_LOGGER

Constructor Summary

Constructors

Constructor and Description
InlineBusTopicSink(List<String> servers, String topic, String apiKey, String apiSecret, String partitionId) constructor for abstract sink

Method Summary

Modifier and Type	Method and Description
String	getPartitionKey() return the partition key in used by the system to publish messages
abstract Topic.CommInfrastructure	getTopicCommInfrastructure() gets the communication infrastructure type
abstract void	init() Initialize the Bus publisher
boolean	isAlive()
boolean	isLocked()
boolean	lock()
boolean	send(String message) Sends a string message over this Topic Endpoint
void	setPartitionKey(String partitionKey) Sets the UEB partition key for published messages
void	shutdown()
boolean	start()
boolean	stop()
boolean	unlock()

Methods inherited from class org.openecomp.policy.drools.event.comm.bus.internal.BusTopicBase

getApiKey, getApiSecret, getRecentEvents, getServers, getTopic, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openecomp.policy.drools.event.comm.bus.BusTopic

getApiKey, getApiSecret

Methods inherited from interface org.openecomp.policy.drools.event.comm.Topic

getRecentEvents, getServers, getTopic

Field Detail

networkLogger

protected static final org.apache.log4j.Logger networkLogger

Not to be converted to PolicyLogger. This will contain all in/out traffic and only that in a single file in a concise format.

partitionId

protected String partitionId

The partition key to publish to

alive

protected volatile boolean alive

Am I running? reflects invocation of start()/stop() !locked & start() => alive stop() => !alive

locked

protected volatile boolean locked

Am I locked? reflects invocation of lock()/unlock() operations locked => !alive (but not in the other direction necessarily) locked => !offer, !run, !start, !stop (but this last one is obvious since locked => !alive)

publisher

protected BusPublisher publisher

message bus publisher

Constructor Detail

InlineBusTopicSink

public InlineBusTopicSink(List<String> servers,
                          String topic,
                          String apiKey,
                          String apiSecret,
                          String partitionId)
                   throws IllegalArgumentException

constructor for abstract sink

Parameters:

servers - servers

topic - topic

apiKey - api secret

apiSecret - api secret

partitionId - partition id

Throws:

IllegalArgumentException - in invalid parameters are passed in

Method Detail

init

public abstract void init()

Initialize the Bus publisher

start

public boolean start()
              throws IllegalStateException

Specified by:

start in interface org.openecomp.policy.drools.properties.Startable

Throws:

IllegalStateException

stop

public boolean stop()

Specified by:

stop in interface org.openecomp.policy.drools.properties.Startable

lock

public boolean lock()

Specified by:

lock in interface org.openecomp.policy.drools.properties.Lockable

unlock

public boolean unlock()

Specified by:

unlock in interface org.openecomp.policy.drools.properties.Lockable

isLocked

public boolean isLocked()

Specified by:

isLocked in interface org.openecomp.policy.drools.properties.Lockable

isAlive

public boolean isAlive()

Specified by:

isAlive in interface org.openecomp.policy.drools.properties.Startable

send

public boolean send(String message)
             throws IllegalArgumentException,
                    IllegalStateException

Sends a string message over this Topic Endpoint

Specified by:

send in interface TopicSink

Parameters:

message - message to send

Returns:

true if the send operation succeeded, false otherwise

Throws:

IllegalArgumentException - an invalid message has been provided

IllegalStateException - the entity is in an state that prevents it from sending messages, for example, locked or stopped.

setPartitionKey

public void setPartitionKey(String partitionKey)

Sets the UEB partition key for published messages

Specified by:

setPartitionKey in interface BusTopicSink

Parameters:

partitionKey - the partition key

getPartitionKey

public String getPartitionKey()

return the partition key in used by the system to publish messages

Specified by:

getPartitionKey in interface BusTopicSink

Returns:

the partition key

shutdown

public void shutdown()
              throws IllegalStateException

Specified by:

shutdown in interface org.openecomp.policy.drools.properties.Startable

Throws:

IllegalStateException

getTopicCommInfrastructure

public abstract Topic.CommInfrastructure getTopicCommInfrastructure()

gets the communication infrastructure type

Specified by:

getTopicCommInfrastructure in interface Topic

Returns: