public abstract class Connector
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Constructor and Description |
---|
Connector(ConnectorFactory connectorFactory,
java.lang.String name,
java.util.Properties properties) |
Modifier and Type | Method and Description |
---|---|
void |
deccrementStatValue(java.lang.String group,
java.lang.String name,
long value)
Decrements the named statistic by the value given
|
void |
decrementStatValue(java.lang.String group,
java.lang.String name)
Decrements the named statistic
|
ConnectorFactory |
getConnectorFactory()
Returns the ConnectionFactory that created this connector.
|
java.lang.String |
getName() |
java.util.Properties |
getProperties() |
void |
incrementStatValue(java.lang.String group,
java.lang.String name)
Increments the named statistic
|
void |
incrementStatValue(java.lang.String group,
java.lang.String name,
long value)
Increments the named statistic by the value given
|
void |
initialize()
This is called by the integration node when a node using this connector is started.
|
void |
terminate()
This is called by the integration node when the node using the connector is being stopped or deleted.
|
void |
writeActivityLog(java.lang.String messageNumber,
java.lang.String[] inserts)
Writes an entry to activity log using the context that this connector is being run in.
|
void |
writeActivityLog(java.lang.String messageNumber,
java.lang.String[] inserts,
java.util.Properties extraTags)
Writes an entry to activity log using the context that this connector is being run in.
|
public static final java.lang.String copyright
public Connector(ConnectorFactory connectorFactory, java.lang.String name, java.util.Properties properties) throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void initialize() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void terminate() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
- Throwing an exception will cause an error to be written to the system log but will not prevent the flow being stopped.public final ConnectorFactory getConnectorFactory() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final void writeActivityLog(java.lang.String messageNumber, java.lang.String[] inserts) throws com.ibm.broker.plugin.MbException
messageNumber
- message number for the catalog to use.inserts
- the inserts to include in the messagecom.ibm.broker.plugin.MbException
public final void writeActivityLog(java.lang.String messageNumber, java.lang.String[] inserts, java.util.Properties extraTags) throws com.ibm.broker.plugin.MbException
messageNumber
- message number for the catalog to use.inserts
- the inserts to include in the messageextraTags
- a map of tags to values which will be used to tag this log message.com.ibm.broker.plugin.MbException
public final java.util.Properties getProperties() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public final java.lang.String getName() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
public void incrementStatValue(java.lang.String group, java.lang.String name) throws com.ibm.broker.plugin.MbException
group
- name
- com.ibm.broker.plugin.MbException
public void incrementStatValue(java.lang.String group, java.lang.String name, long value) throws com.ibm.broker.plugin.MbException
group
- name
- value
- com.ibm.broker.plugin.MbException
public void decrementStatValue(java.lang.String group, java.lang.String name) throws com.ibm.broker.plugin.MbException
group
- name
- com.ibm.broker.plugin.MbException
public void deccrementStatValue(java.lang.String group, java.lang.String name, long value) throws com.ibm.broker.plugin.MbException
group
- name
- value
- com.ibm.broker.plugin.MbException