IBM Integration BusTM
JavaTM Connector API
A B C D E G I L M O P R S T V W 

A

AdminInterface - Interface in com.ibm.broker.connector
AdminInterface is an interface that can be added to the OutputConnector or the EventInputConnector to provide administration to the system being connected to.
adminKey() - Method in interface com.ibm.broker.connector.AdminInterface
 
appendByteArray(byte[]) - Method in class com.ibm.broker.connector.ByteArrayInputRecord
Call this method to append bytes to the record.
appendByteArray(byte[], long) - Method in class com.ibm.broker.connector.ByteArrayInputRecord
 

B

buildInputRecord() - Method in class com.ibm.broker.connector.ByteArrayPollingResult
Provides a default implementation of buildInputRecord.
buildInputRecord() - Method in class com.ibm.broker.connector.ByteArrayResponseRecord
Provides a default implementation of buildInputRecord.
buildInputRecord() - Method in class com.ibm.broker.connector.Event
This is called by the integration node when the record representing the Event is required.
buildInputRecord() - Method in class com.ibm.broker.connector.PollingResult
This is called by the integration node when the record representing the result is required.
buildInputRecord() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the integration node when the record representing the result is required.
buildInputRecord() - Method in class com.ibm.broker.connector.TimeoutPollingResult
Returns null for an TimeoutPollingResult as there is no record to build.
buildInputRecord() - Method in class com.ibm.broker.connector.TimeoutResponseRecord
Returns null for an TimeoutResponseRecord as there is no record to build.
buildProperties() - Method in class com.ibm.broker.connector.Event
This is called by the integration node when the additional information on found in the record is required.
buildProperties() - Method in class com.ibm.broker.connector.PollingResult
This is called by the integration node when the additional information in found in the record is required.
buildProperties() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the integration node when the additional information in found in the record is required.
ByteArrayInputRecord - Class in com.ibm.broker.connector
ByteArrayInputRecord provides a default class to handle input records for polling results and events, allowing a record to be created that is based on a byte array.
ByteArrayInputRecord() - Constructor for class com.ibm.broker.connector.ByteArrayInputRecord
 
ByteArrayPollingResult - Class in com.ibm.broker.connector
ByteArrayPollingResult provides a default class to handle byte array based polling results.
ByteArrayPollingResult(PollingInputConnector, byte[]) - Constructor for class com.ibm.broker.connector.ByteArrayPollingResult
Provides a default implementation.
ByteArrayPollingResult(PollingInputConnector, byte[], long) - Constructor for class com.ibm.broker.connector.ByteArrayPollingResult
Provides a default implementation.
ByteArrayResponseRecord - Class in com.ibm.broker.connector
ByteArrayResponseRecord provides a default class to handle byte array based response record.
ByteArrayResponseRecord(RequestConnector, byte[]) - Constructor for class com.ibm.broker.connector.ByteArrayResponseRecord
Provides a default implementation.
ByteArrayResponseRecord(RequestConnector, byte[], long) - Constructor for class com.ibm.broker.connector.ByteArrayResponseRecord
Provides a default implementation.

C

changeAdminObject(String, Properties, String, String) - Method in interface com.ibm.broker.connector.AdminInterface
This is called by the integration node to execute an administration operation against the message provider.
com.ibm.broker.connector - package com.ibm.broker.connector
This package provides the classes for creating Connectors.
confirm() - Method in class com.ibm.broker.connector.Event
This is called by the integration node if the processing of the event completes with out error.
confirm() - Method in class com.ibm.broker.connector.PollingResult
This is called by the integration node if the processing of the result completes without error.
confirm() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the integration node if the processing of the result completes without error.
Connector - Class in com.ibm.broker.connector
 
Connector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.Connector
 
ConnectorClassLoader - Class in com.ibm.broker.connector
ConnectorClassLoader builds a classloader out of the url paths provided in the constructor, the shared-classes folders, and the broker /classes folder, searched in that order.
ConnectorClassLoader(String) - Constructor for class com.ibm.broker.connector.ConnectorClassLoader
 
ConnectorFactory - Class in com.ibm.broker.connector
ConnectorFactory is the base class which must be extended to implement a connector which can run in IBM Integration Bus.
ConnectorStats - Interface in com.ibm.broker.connector
Connector Stats is an interface that should be implemented by connectors that want to report resource statistics
containerName() - Method in class com.ibm.broker.connector.ContainerServices
The name of the container running the connectors.
ContainerServices - Class in com.ibm.broker.connector
ContainerServices gives access to key functions provided by the container, such as tracing and logging.
copyright - Static variable in interface com.ibm.broker.connector.AdminInterface
 
copyright - Static variable in class com.ibm.broker.connector.ByteArrayInputRecord
 
copyright - Static variable in class com.ibm.broker.connector.ByteArrayPollingResult
 
copyright - Static variable in class com.ibm.broker.connector.ByteArrayResponseRecord
 
copyright - Static variable in class com.ibm.broker.connector.Connector
 
copyright - Static variable in class com.ibm.broker.connector.ConnectorFactory
 
copyright - Static variable in class com.ibm.broker.connector.ContainerServices
 
copyright - Static variable in class com.ibm.broker.connector.ElementInputRecord
 
copyright - Static variable in class com.ibm.broker.connector.Event
 
copyright - Static variable in class com.ibm.broker.connector.EventInputConnector
 
copyright - Static variable in class com.ibm.broker.connector.InputConnector
 
copyright - Static variable in class com.ibm.broker.connector.InputRecord
 
copyright - Static variable in class com.ibm.broker.connector.OutputConnector
 
copyright - Static variable in class com.ibm.broker.connector.OutputInteraction
 
copyright - Static variable in class com.ibm.broker.connector.PollingInputConnector
 
copyright - Static variable in class com.ibm.broker.connector.PollingResult
 
copyright - Static variable in class com.ibm.broker.connector.ProviderLoader
 
copyright - Static variable in class com.ibm.broker.connector.RequestConnector
 
copyright - Static variable in class com.ibm.broker.connector.RequestInteraction
 
copyright - Static variable in class com.ibm.broker.connector.ResponseRecord
 
copyright - Static variable in class com.ibm.broker.connector.TimeoutPollingResult
 
copyright - Static variable in class com.ibm.broker.connector.TimeoutResponseRecord
 
createEventInputConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
Deprecated.
use #createInputConnector() instead
createInputConnector(String, Properties, SecurityIdentity) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when a connector to receive data from the system is required.
createInputConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
Deprecated.
createOutputConnector(String, Properties, SecurityIdentity) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when a connector to send data to the system is required.
createOutputConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
Deprecated.
createOutputInteraction() - Method in class com.ibm.broker.connector.OutputConnector
This is called by an integration node to create an OutputInteraction to send data to the system.
createRequestConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when a connector to send data to the system is required.
createRequestInteraction() - Method in class com.ibm.broker.connector.RequestConnector
This is called by an integration node to create an OutputInteraction to send data to the system.

D

deccrementStatValue(String, String, long) - Method in class com.ibm.broker.connector.Connector
Decrements the named statistic by the value given
decrementStatValue(String, String) - Method in class com.ibm.broker.connector.Connector
Decrements the named statistic
deliverEvents(Event[]) - Method in class com.ibm.broker.connector.EventInputConnector
Used to deliver Events to be processed by IBM Integration Bus.
discard() - Method in class com.ibm.broker.connector.PasswordCredential
 

E

ElementInputRecord - Class in com.ibm.broker.connector
 
ElementInputRecord() - Constructor for class com.ibm.broker.connector.ElementInputRecord
 
Event - Class in com.ibm.broker.connector
Event is the base class which must be extended to implement the receiving of an event from the system.
Event() - Constructor for class com.ibm.broker.connector.Event
 
EventInputConnector - Class in com.ibm.broker.connector
EventInputConnector is the base class which must be extended to implement a connector which can receive events from the system.
EventInputConnector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.EventInputConnector
Constructor that must be used to create EventInputConnector objects.
eventSource() - Method in class com.ibm.broker.connector.Event
This is called by the the integration node after an event is received.

G

getByteData() - Method in class com.ibm.broker.connector.OutputRecord
Call this to get a byte array that contains the data represented by the record
getByteData() - Method in class com.ibm.broker.connector.RequestRecord
Call this to get a byte array that contains the data represented by the record
getBytes() - Method in class com.ibm.broker.connector.ByteArrayPollingResult
Returns the data associated with this result.
getBytes() - Method in class com.ibm.broker.connector.ByteArrayResponseRecord
Returns the data associated with this result.
getCatalogName() - Method in class com.ibm.broker.connector.ConnectorFactory
 
getConnector() - Method in class com.ibm.broker.connector.Event
 
getConnector() - Method in class com.ibm.broker.connector.OutputInteraction
Returns the OutputConnector that constructed this interaction.
getConnector() - Method in class com.ibm.broker.connector.PollingResult
Returns the owning NBPollingInputConnector.
getConnector() - Method in class com.ibm.broker.connector.RequestInteraction
Returns the RequestConnector that constructed this interaction.
getConnector() - Method in class com.ibm.broker.connector.ResponseRecord
Returns the owning NBRequestConnector.
getConnectorFactory() - Method in class com.ibm.broker.connector.Connector
Returns the ConnectionFactory that created this connector.
getConnectorStatNames() - Method in class com.ibm.broker.connector.ConnectorFactory
Gets the names of the stats used by a connector
getContainerServices() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns a ContainerServices object which can be used by a connector writer to obtain function and resources provided by the environment running the connector.
getCredential() - Method in interface com.ibm.broker.connector.SecurityIdentity
 
getDataLocation() - Method in class com.ibm.broker.connector.OutputRecord
Call this to get a MbElement that represents the record
getDataLocation() - Method in class com.ibm.broker.connector.RequestRecord
Call this to get a MbElement that represents the record
getDestinationName() - Method in class com.ibm.broker.connector.InputRecord
This is called by the broker to decide where the message will be sent.
getElement() - Method in class com.ibm.broker.connector.ElementInputRecord
Call this method to get the root element for this record.
getEventInputConnectors() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns an array of all EventInputConnectors which have been created by this factory and have not been terminated.
getFileSeparator() - Method in class com.ibm.broker.connector.ContainerServices
 
getInfo() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node to get a information about the ConnectorFactory.
getInteractions() - Method in class com.ibm.broker.connector.OutputConnector
Returns all OutputInteractions created by this connector that have not been terminated.
getInteractions() - Method in class com.ibm.broker.connector.RequestConnector
Returns all OutputInteractions created by this connector that have not been terminated.
getName() - Method in class com.ibm.broker.connector.Connector
 
getName() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns a provider name.
getName() - Method in interface com.ibm.broker.connector.SecurityIdentity
 
getNextCallInterval() - Method in class com.ibm.broker.connector.TimeoutPollingResult
 
getNextCallInterval() - Method in class com.ibm.broker.connector.TimeoutResponseRecord
 
getOffset() - Method in class com.ibm.broker.connector.ByteArrayPollingResult
Returns the offset passed in on the constructor, or if the two argument constructor was used, the Length of the byte array.
getOffset() - Method in class com.ibm.broker.connector.ByteArrayResponseRecord
Returns the offset passed in on the constructor, or if the two argument constructor was used, the Length of the byte array.
getOutputConnectors() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns an array of all OutputConnectors which have been created by this factory and have not been terminated.
getPassword() - Method in class com.ibm.broker.connector.PasswordCredential
 
getPollingInputConnectors() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns an array of all NBPollingInputConnectors which have been created by this factory and have not been terminated.
getProperties() - Method in class com.ibm.broker.connector.Connector
 
getProperties() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns a properties for this connector factory.
getRequestConnectors() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns an array of all RequestConnectors which have been created by this factory and have not been terminated.
getStatsNames() - Method in interface com.ibm.broker.connector.ConnectorStats
 
getUserName() - Method in class com.ibm.broker.connector.PasswordCredential
 
getUTF8Data() - Method in class com.ibm.broker.connector.OutputRecord
Call this to get a UTF8 string that contains the data represented by the record
getUTF8Data() - Method in class com.ibm.broker.connector.RequestRecord
Call this to get a UTF8 string that contains the data represented by the record
getWorkDirectory() - Method in class com.ibm.broker.connector.ContainerServices
 

I

incrementStatValue(String, String) - Method in class com.ibm.broker.connector.Connector
Increments the named statistic
incrementStatValue(String, String, long) - Method in class com.ibm.broker.connector.Connector
Increments the named statistic by the value given
initialize() - Method in class com.ibm.broker.connector.Connector
This is called by the integration node when a node using this connector is started.
initialize(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when an integration server is started up.
initialize() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the integration node when the OutputInteraction is constructed.
initialize() - Method in class com.ibm.broker.connector.RequestInteraction
This is called by the integration node when the OutputInteraction is constructed.
InputConnector - Class in com.ibm.broker.connector
InputConnector is an abstract base class for all Input connectors.
InputConnector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.InputConnector
Constructor that must be used to create InputConnector objects.
InputRecord - Class in com.ibm.broker.connector
InputRecord is an abstract base class for records returned from Event.buildInputRecord or PollingResult.buildInputRecord A record represents a single message to be sent down a message flow.
InputRecord() - Constructor for class com.ibm.broker.connector.InputRecord
 
isStarted() - Method in class com.ibm.broker.connector.InputConnector
isStarted reports the running state of the connector.

L

listAdminObjectProperties(String, String) - Method in interface com.ibm.broker.connector.AdminInterface
This is called by the integration node to get a list of properties for a given object name.
listAdminObjectsForType(String) - Method in interface com.ibm.broker.connector.AdminInterface
This is called by the integration node to get a list of all objects that exist for the given object type.
listAdminObjectTypes() - Method in interface com.ibm.broker.connector.AdminInterface
This is called by the integration node to get a name to use this administered object.
logEvent() - Method in class com.ibm.broker.connector.Event
This is called by the integration node after send to allow the connector writer to do there own logging.
logNoData() - Method in class com.ibm.broker.connector.PollingInputConnector
If it is not overridden then a standard activity log message is written stating it is waiting for data.
logNoEvent() - Method in class com.ibm.broker.connector.EventInputConnector
This is called by the integration node when no events have been received for a while.
logResult() - Method in class com.ibm.broker.connector.PollingResult
This is called by the integration node after readData to allow the connector writer to do there own logging.
logResult() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the integration node after readData to allow the connector writer to do there own logging.
logSend() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the integration node after send to allow the connector writer to do their own logging.
logSend() - Method in class com.ibm.broker.connector.RequestInteraction
This is called by the integration node after send to allow the connector writer to do their own logging.

M

markAsFailed() - Method in class com.ibm.broker.connector.Event
This is called by the integration node if the processing of the event fails with an error.
markAsFailed() - Method in class com.ibm.broker.connector.PollingResult
This is called by the integration node if the processing of the result fails with an error.
markAsFailed() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the integration node if the processing of the result fails with an error.

O

OutputConnector - Class in com.ibm.broker.connector
OutputConnector is the base class which must be extended to implement a connector which can send data to a system.
OutputConnector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.OutputConnector
 
OutputInteraction - Class in com.ibm.broker.connector
 
OutputInteraction(OutputConnector) - Constructor for class com.ibm.broker.connector.OutputInteraction
 
OutputRecord - Class in com.ibm.broker.connector
 

P

PasswordCredential - Class in com.ibm.broker.connector
 
PasswordCredential(SecurityIdentityImpl) - Constructor for class com.ibm.broker.connector.PasswordCredential
 
PollingInputConnector - Class in com.ibm.broker.connector
PollingInputConnector is the base class which must be extended to implement a connector which can poll for data from the system.
PollingInputConnector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.PollingInputConnector
Constructor that must be used to create PollingInputConnector objects.
PollingResult - Class in com.ibm.broker.connector
PollingResult is the base class for a polling result from the system.
PollingResult(PollingInputConnector) - Constructor for class com.ibm.broker.connector.PollingResult
Initializes a new instance of the PollingResult class.
ProviderLoader - Class in com.ibm.broker.connector
 

R

readData(long) - Method in class com.ibm.broker.connector.PollingInputConnector
Called by the Integration Bus to obtain data to be processed.
request(Properties, RequestRecord) - Method in class com.ibm.broker.connector.RequestInteraction
This is called by the integration node to send data to the system.
RequestConnector - Class in com.ibm.broker.connector
RequestConnector is the base class which must be extended to implement a connector which can send data to a system.
RequestConnector(ConnectorFactory, String, Properties) - Constructor for class com.ibm.broker.connector.RequestConnector
 
RequestInteraction - Class in com.ibm.broker.connector
 
RequestInteraction(RequestConnector) - Constructor for class com.ibm.broker.connector.RequestInteraction
 
RequestRecord - Class in com.ibm.broker.connector
 
ResponseRecord - Class in com.ibm.broker.connector
ResponseRecord is the base class for a polling result from the system.
ResponseRecord(RequestConnector) - Constructor for class com.ibm.broker.connector.ResponseRecord
Initializes a new instance of the ResponseRecord class.
resultSource() - Method in class com.ibm.broker.connector.PollingResult
This is called by the the integration node after a result is received.
resultSource() - Method in class com.ibm.broker.connector.ResponseRecord
This is called by the the integration node after a result is received.

S

SecurityCredential - Interface in com.ibm.broker.connector
 
SecurityIdentity - Interface in com.ibm.broker.connector
 
send(Properties, OutputRecord) - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the integration node to send data to the system.
sentDestination() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the integration node after send to find out what destination was sent to.
sentDestination() - Method in class com.ibm.broker.connector.RequestInteraction
This is called by the integration node after send to find out what destination was sent to.
setException(MbException) - Method in class com.ibm.broker.connector.InputRecord
 
start() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when the first usage of the provider is about to happen.
start() - Method in class com.ibm.broker.connector.InputConnector
Start is called when the node using the connector is ready to start receiving data.
stop() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when the last connector using the provider is destroyed.
stop() - Method in class com.ibm.broker.connector.InputConnector
stop is called when the integration node using the connector no longer wants to receive data.

T

terminate() - Method in class com.ibm.broker.connector.Connector
This is called by the integration node when the node using the connector is being stopped or deleted.
terminate() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by the integration node when the integration server is about to stop.
terminate() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the integration node when the OutputInteraction is no longer needed.
terminate() - Method in class com.ibm.broker.connector.RequestInteraction
This is called by the integration node when the OutputInteraction is no longer needed.
throwMbRecoverableException(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Throws an MbRecoverableException based on message key and inserts.
throwMbRecoverableException(Exception) - Method in class com.ibm.broker.connector.ContainerServices
Throws an MbRecoverableException based a normal java exception.
TimeoutPollingResult - Class in com.ibm.broker.connector
NBTimeoutPollingResult is a class which is used to indicate the readData method has no data to return.
TimeoutPollingResult(PollingInputConnector) - Constructor for class com.ibm.broker.connector.TimeoutPollingResult
Initializes a new instance of the NBTimeoutPollingResult" class with no further waiting required.
TimeoutPollingResult(PollingInputConnector, long) - Constructor for class com.ibm.broker.connector.TimeoutPollingResult
Initializes a new instance of the NBTimeoutPollingResult" class that causes a pause before readData is called again.
TimeoutResponseRecord - Class in com.ibm.broker.connector
NBTimeoutResponseRecord is a class which is used to indicate the readData method has no data to return.
TimeoutResponseRecord(RequestConnector) - Constructor for class com.ibm.broker.connector.TimeoutResponseRecord
Initializes a new instance of the NBTimeoutResponseRecord" class with no further waiting required.
TimeoutResponseRecord(RequestConnector, long) - Constructor for class com.ibm.broker.connector.TimeoutResponseRecord
Initializes a new instance of the NBTimeoutResponseRecord" class that causes a pause before readData is called again.

V

validateData(MbElement) - Method in class com.ibm.broker.connector.InputRecord
This is called by the integration node once the message tree has been constructed.
VALIDATEDATA_CONSUMED - Static variable in class com.ibm.broker.connector.InputRecord
 
VALIDATEDATA_OK - Static variable in class com.ibm.broker.connector.InputRecord
 

W

writeActivityLog(String, String[]) - Method in class com.ibm.broker.connector.Connector
Writes an entry to activity log using the context that this connector is being run in.
writeActivityLog(String, String[], Properties) - Method in class com.ibm.broker.connector.Connector
Writes an entry to activity log using the context that this connector is being run in.
writeActivityLog(String, String[]) - Method in class com.ibm.broker.connector.ConnectorFactory
Writes an entry to activity log using the context that this connector is being run in.
writeActivityLog(String, String[], Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
Writes an entry to activity log using the context that this connector is being run in.
writeServiceTraceData(String, String, String) - Static method in class com.ibm.broker.connector.ContainerServices
Writes a piece of data to service trace.
writeServiceTraceEntry(String, String, String) - Static method in class com.ibm.broker.connector.ContainerServices
Writes an entry message to service trace.
writeServiceTraceExit(String, String, String) - Static method in class com.ibm.broker.connector.ContainerServices
Writes an exit message to service trace.
writeSystemLogError(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Writes an error message to the system log.
writeSystemLogInformation(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Writes an information message to the system log.
writeSystemLogWarning(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Writes a warning message to the system log.
writeUserTraceDebug(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Writes a debug level message to the user trace.
writeUserTraceNormal(String, String[]) - Method in class com.ibm.broker.connector.ContainerServices
Writes a normal level message to the user trace.
A B C D E G I L M O P R S T V W 
IBM Integration BusTM
JavaTM Connector API