WebSphere Message BrokerTM
JavaTM Connector API
A B C D E G I L M O 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.

B

buildInputRecord() - Method in class com.ibm.broker.connector.Event
This is called by broker when the record representing the Event is required.
buildProperties() - Method in class com.ibm.broker.connector.Event
This is called by broker when the additional information on found in the record is required.
ByteArrayInputRecord - Class in com.ibm.broker.connector
ByteArrayInputRecord allows a record to be created that is based on a byte array.
ByteArrayInputRecord() - Constructor for class com.ibm.broker.connector.ByteArrayInputRecord
 

C

changeAdminObject(String, Properties, String, String) - Method in interface com.ibm.broker.connector.AdminInterface
This is called by broker 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 broker if the processing of the event completes with out error.
ConnectorFactory - Class in com.ibm.broker.connector
ConnectorFactory is the base class which must be extended to implement a connector which can run in WebSphere Message Broker.
ConnectorFactory() - Constructor for class com.ibm.broker.connector.ConnectorFactory
 
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.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.InputRecord
 
copyright - Static variable in class com.ibm.broker.connector.OutputConnector
 
copyright - Static variable in class com.ibm.broker.connector.OutputInteraction
 
createEventInputConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by broker when a connector to receive data from the system is required.
createOutputConnector(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by broker when a connector to send data to the system is required.
createOutputInteraction() - Method in class com.ibm.broker.connector.OutputConnector
This is called by broker to create an OutputInteraction to send data to the system.

D

deliverEvents(Event[]) - Method in class com.ibm.broker.connector.EventInputConnector
Used to deliver Events to be processed by message broker.

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 broker 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
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.
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.
getDataLocation() - Method in class com.ibm.broker.connector.OutputRecord
Call this to get a MbElement that represents the record
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 broker 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.
getName() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns a provider name.
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.
getProperties() - Method in class com.ibm.broker.connector.ConnectorFactory
Returns a properties for this connector factory.
getUTF8Data() - Method in class com.ibm.broker.connector.OutputRecord
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

initialize(String, Properties) - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by broker when an execution group is started up.
initialize() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the broker when the OutputInteraction is constructed.
InputRecord - Class in com.ibm.broker.connector
 
InputRecord() - Constructor for class com.ibm.broker.connector.InputRecord
 
isStarted() - Method in class com.ibm.broker.connector.EventInputConnector
isStarted reports the running state of the connector.

L

listAdminObjectProperties(String, String) - Method in interface com.ibm.broker.connector.AdminInterface
This is called by broker 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 broker 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 broker to get a name to use this administered object.
logEvent() - Method in class com.ibm.broker.connector.Event
This is called by the broker after send to allow the connector writer to do there own logging.
logNoEvent() - Method in class com.ibm.broker.connector.EventInputConnector
This is called by the broker when no events have been received for a while.
logSend() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the broker 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 broker if the processing of the event 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
 

S

send(Properties, OutputRecord) - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the broker to send data to the system.
sentDestination() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the broker 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 broker when the first usage of the provider is about to happen.
start() - Method in class com.ibm.broker.connector.EventInputConnector
Start is called when the node using the connector is ready to start receiving events.
stop() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by broker when the last connector using the provider is destroyed.
stop() - Method in class com.ibm.broker.connector.EventInputConnector
Stop is called when the node using the connector no longer wants to receive events.

T

terminate() - Method in class com.ibm.broker.connector.ConnectorFactory
This is called by broker when the execution group is about to stop.
terminate() - Method in class com.ibm.broker.connector.OutputInteraction
This is called by the broker 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.

V

validateData(MbElement) - Method in class com.ibm.broker.connector.InputRecord
This is called by broker 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.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 S T V W 
WebSphere Message BrokerTM
JavaTM Connector API