IBM TM
CommonTM Connector API
A B C D F G I L N O P R S T _ 

A

AbstractConnectorFactory - Class in com.ibm.connectors
An abstract class for connector factories.
AbstractConnectorFactory() - Constructor for class com.ibm.connectors.AbstractConnectorFactory
 
AbstractInputConnector - Class in com.ibm.connectors
Provides an empty InputConnector implementation for extenders to fill in with provider-specific code.
AbstractInputConnector() - Constructor for class com.ibm.connectors.AbstractInputConnector
 
AbstractInputConnectorFilter - Class in com.ibm.connectors
 
AbstractInputConnectorFilter(InputConnector, ConnectorCallback) - Constructor for class com.ibm.connectors.AbstractInputConnectorFilter
 
AbstractOutputConnector - Class in com.ibm.connectors
Provides an empty OutputConnector implementation for extenders to fill in with provider-specific code.
AbstractOutputConnector() - Constructor for class com.ibm.connectors.AbstractOutputConnector
 
AbstractOutputInteraction - Class in com.ibm.connectors
Provides an empty OutputInteraction implementation for extenders to fill in with provider-specific code.
AbstractOutputInteraction() - Constructor for class com.ibm.connectors.AbstractOutputInteraction
 
AbstractPollingInputConnector - Class in com.ibm.connectors
Provides an empty PollingInputConnector implementation for extenders to fill in with provider-specific code.
AbstractPollingInputConnector() - Constructor for class com.ibm.connectors.AbstractPollingInputConnector
 
AbstractRequestConnector - Class in com.ibm.connectors
Provides an empty RequestConnector implementation for extenders to fill in with provider-specific code.
AbstractRequestConnector() - Constructor for class com.ibm.connectors.AbstractRequestConnector
 
AbstractRequestInteraction - Class in com.ibm.connectors
Provides an empty RequestInteraction implementation for extenders to fill in with provider-specific code.
AbstractRequestInteraction() - Constructor for class com.ibm.connectors.AbstractRequestInteraction
 
asyncFailure(long, Exception) - Method in interface com.ibm.connectors.ConnectorCallback
Notify host application of any async failures.
asyncFailure(long, Exception) - Method in class com.ibm.connectors.container.BaseDelegate
 
asyncFailure(long, Exception) - Method in class com.ibm.connectors.container.NativeOutputDelegate
 
asyncFailure(long, Exception) - Method in class com.ibm.connectors.container.NativeRequestDelegate
 
asyncFailure(long, Exception) - Method in class com.ibm.connectors.container.OutputDelegate
 
asyncFailure(long, Exception) - Method in class com.ibm.connectors.container.RequestDelegate
 
asyncRequest(Properties, Object) - Method in class com.ibm.connectors.container.RequestDelegate
 
asyncRequest(Properties, Object, ConnectorCallback) - Method in interface com.ibm.connectors.RequestInteraction
Send a request message asynchronously using the provided configuration properties which may augment or override the properties set on the connector.
asyncRequestSuccess(long, Object) - Method in interface com.ibm.connectors.ConnectorCallback
Notify host application of async service response
asyncRequestSuccess(long, Object) - Method in class com.ibm.connectors.container.BaseDelegate
 
asyncRequestSuccess(long, Object) - Method in class com.ibm.connectors.container.NativeRequestDelegate
 
asyncRequestSuccess(long, Object) - Method in class com.ibm.connectors.container.RequestDelegate
 
asyncSend(Properties, Object) - Method in class com.ibm.connectors.container.OutputDelegate
 
asyncSend(Properties, Object, ConnectorCallback) - Method in interface com.ibm.connectors.OutputInteraction
Send an output message asynchronously using the provided configuration properties which may augment or override the properties set on the connector.
asyncSendSuccess(long) - Method in interface com.ibm.connectors.ConnectorCallback
Notify host application of async output send status
asyncSendSuccess(long) - Method in class com.ibm.connectors.container.BaseDelegate
 
asyncSendSuccess(long) - Method in class com.ibm.connectors.container.NativeOutputDelegate
 
asyncSendSuccess(long) - Method in class com.ibm.connectors.container.OutputDelegate
 

B

BaseDelegate - Class in com.ibm.connectors.container
 
BaseDelegate(ContainerServices) - Constructor for class com.ibm.connectors.container.BaseDelegate
 

C

ClassContext - Class in com.ibm.connectors.container
 
close() - Method in class com.ibm.connectors.container.ClassContext
 
close() - Method in class com.ibm.connectors.container.NativeLogHandler
 
com.ibm.connectors - package com.ibm.connectors
 
com.ibm.connectors.container - package com.ibm.connectors.container
 
Connector - Interface in com.ibm.connectors
Base interface of all connectors.
ConnectorCallback - Interface in com.ibm.connectors
Interface that connectors can use to call back to the host application.
ConnectorException - Exception in com.ibm.connectors
An Exception class to help encapsulate and identify exceptions that occur within connectors
ConnectorException() - Constructor for exception com.ibm.connectors.ConnectorException
 
ConnectorException(String, Throwable, boolean, boolean) - Constructor for exception com.ibm.connectors.ConnectorException
 
ConnectorException(String, Throwable) - Constructor for exception com.ibm.connectors.ConnectorException
 
ConnectorException(String) - Constructor for exception com.ibm.connectors.ConnectorException
 
ConnectorException(Throwable) - Constructor for exception com.ibm.connectors.ConnectorException
 
ConnectorFactory - Interface in com.ibm.connectors
Base interface for factory objects that can create connectors for a particular provider.
ConnectorLogger - Interface in com.ibm.connectors
An interface available via the ConnectorServices object which can be used by connectors to obtain a java.util.Logger that will log to the host applications logging environment.
ConnectorRegistry - Interface in com.ibm.connectors.container
 
ConnectorServices - Interface in com.ibm.connectors
This class provides access to the host application that connectors can optionally use to reference services within the host, in particular logging and security.
ContainerServices - Class in com.ibm.connectors.container
 
ContainerServices() - Constructor for class com.ibm.connectors.container.ContainerServices
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractConnectorFactory
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractInputConnector
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractInputConnectorFilter
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractOutputConnector
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractOutputInteraction
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractPollingInputConnector
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractRequestConnector
 
COPYRIGHT - Static variable in class com.ibm.connectors.AbstractRequestInteraction
 
COPYRIGHT - Static variable in interface com.ibm.connectors.Connector
 
COPYRIGHT - Static variable in interface com.ibm.connectors.ConnectorCallback
 
COPYRIGHT - Static variable in exception com.ibm.connectors.ConnectorException
 
COPYRIGHT - Static variable in interface com.ibm.connectors.ConnectorFactory
 
COPYRIGHT - Static variable in interface com.ibm.connectors.ConnectorLogger
 
COPYRIGHT - Static variable in interface com.ibm.connectors.ConnectorServices
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.BaseDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.ClassContext
 
COPYRIGHT - Static variable in interface com.ibm.connectors.container.ConnectorRegistry
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.ContainerServices
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.InputDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeConnectorRegistry
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeHelper
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeInputDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeLogHandler
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeOutputDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.NativeRequestDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.OutputDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.RequestDelegate
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.SimpleConnectorLogger
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.SimpleConnectorRegistry
 
COPYRIGHT - Static variable in class com.ibm.connectors.container.SimpleContainerServices
 
COPYRIGHT - Static variable in interface com.ibm.connectors.InputConnector
 
COPYRIGHT - Static variable in interface com.ibm.connectors.OutputInteraction
 
COPYRIGHT - Static variable in interface com.ibm.connectors.PollingInputConnector
 
COPYRIGHT - Static variable in interface com.ibm.connectors.RequestConnector
 
COPYRIGHT - Static variable in interface com.ibm.connectors.RequestInteraction
 
COPYRIGHT - Static variable in interface com.ibm.connectors.SecurityDirector
 
createConnector(String, String) - Method in class com.ibm.connectors.container.BaseDelegate
 
createConnectorInternal(ConnectorFactory, String) - Method in class com.ibm.connectors.container.BaseDelegate
 
createConnectorInternal(ConnectorFactory, String) - Method in class com.ibm.connectors.container.InputDelegate
 
createConnectorInternal(ConnectorFactory, String) - Method in class com.ibm.connectors.container.OutputDelegate
 
createConnectorInternal(ConnectorFactory, String) - Method in class com.ibm.connectors.container.RequestDelegate
 
createInputConnector(String) - Method in interface com.ibm.connectors.ConnectorFactory
Create an event input connector for this provider
createInteraction() - Method in class com.ibm.connectors.container.RequestDelegate
 
createNativeInstance(String) - Static method in class com.ibm.connectors.container.ContainerServices
connectorRegistry.className connectorRegistry.init connectorLogger.className securityDirector.className
createOutputConnector(String) - Method in interface com.ibm.connectors.ConnectorFactory
Create an event output connector for this provider
createOutputInteraction() - Method in interface com.ibm.connectors.OutputConnector
Create an OutputInteraction to perform the output.
createRequestConnector(String) - Method in interface com.ibm.connectors.ConnectorFactory
Create a request connector for this provider
createRequestInteraction() - Method in interface com.ibm.connectors.RequestConnector
Create an RequestInteraction to perform the request/response operation.

D

deserialiseProperties(byte[]) - Static method in class com.ibm.connectors.container.NativeHelper
 

F

FilePathConnectorRegistry - Class in com.ibm.connectors.container
Loads connector jars or folders from a list of paths fed at creation time.
FilePathConnectorRegistry(String, Logger) - Constructor for class com.ibm.connectors.container.FilePathConnectorRegistry
 
filterInboundData(Object, Properties) - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
flush() - Method in class com.ibm.connectors.container.NativeLogHandler
 

G

getCallback() - Method in interface com.ibm.connectors.Connector
Returns a callback object that the connector can use to feed data and results back to the host application.
getConnector() - Method in class com.ibm.connectors.AbstractOutputInteraction
 
getConnector() - Method in class com.ibm.connectors.AbstractRequestInteraction
 
getConnector() - Method in class com.ibm.connectors.container.BaseDelegate
 
getConnectorServices() - Method in class com.ibm.connectors.AbstractConnectorFactory
 
getConnectorServices() - Method in interface com.ibm.connectors.Connector
Services provided by the host application for use by the connector
getConnectorServices() - Method in interface com.ibm.connectors.ConnectorFactory
Application services
getInfo() - Method in interface com.ibm.connectors.ConnectorFactory
Freeform info about the factory.
getInputConnector() - Method in class com.ibm.connectors.container.InputDelegate
 
getJavaLogger(String) - Method in interface com.ibm.connectors.ConnectorLogger
 
getJavaLogger(String) - Method in class com.ibm.connectors.container.SimpleConnectorLogger
 
getLog() - Method in class com.ibm.connectors.container.FilePathConnectorRegistry
 
getLogFactory() - Method in interface com.ibm.connectors.ConnectorServices
 
getLogFactory() - Method in class com.ibm.connectors.container.SimpleContainerServices
 
getLogger() - Method in class com.ibm.connectors.AbstractConnectorFactory
 
getLogger() - Method in interface com.ibm.connectors.Connector
Returns a java.util.Logger which uses the connector's name, to enable the connector to log to the host application's logging mechanism
getName() - Method in interface com.ibm.connectors.Connector
Returns the name allocated by the runtime to this connector when it was initialsed.
getOutputConnector() - Method in class com.ibm.connectors.container.OutputDelegate
 
getProperties() - Method in class com.ibm.connectors.AbstractConnectorFactory
 
getProperties() - Method in interface com.ibm.connectors.Connector
Returns the properties object passed to connector when it was initialised
getProperties() - Method in interface com.ibm.connectors.ConnectorFactory
The metadata properties used to configure the factory
getProviderName() - Method in class com.ibm.connectors.AbstractConnectorFactory
 
getProviderName() - Method in interface com.ibm.connectors.ConnectorFactory
The identifying name of the provider
getRegistry() - Method in class com.ibm.connectors.container.ContainerServices
 
getRegistry() - Method in class com.ibm.connectors.container.SimpleContainerServices
 
getRequestConnector() - Method in class com.ibm.connectors.container.RequestDelegate
 
getSecurity() - Method in interface com.ibm.connectors.ConnectorServices
 
getSecurity() - Method in class com.ibm.connectors.container.SimpleContainerServices
 
getServices() - Method in class com.ibm.connectors.container.BaseDelegate
 

I

initialise(String, Properties, ConnectorServices) - Method in class com.ibm.connectors.AbstractConnectorFactory
 
initialise(OutputConnector) - Method in class com.ibm.connectors.AbstractOutputInteraction
 
initialise(RequestConnector) - Method in class com.ibm.connectors.AbstractRequestInteraction
 
initialise(String, Properties, ConnectorCallback, ConnectorServices) - Method in interface com.ibm.connectors.Connector
Initialise the connector.
initialise(String, Properties, ConnectorServices) - Method in interface com.ibm.connectors.ConnectorFactory
Initialise the provider with properties obtained from the factory metadata via the ConnectorRegistry.
initialise(String) - Method in interface com.ibm.connectors.container.ConnectorRegistry
 
initialise(String) - Method in class com.ibm.connectors.container.FilePathConnectorRegistry
 
initialise(String) - Method in class com.ibm.connectors.container.SimpleConnectorRegistry
 
initialise(OutputConnector) - Method in interface com.ibm.connectors.OutputInteraction
Initialise the interaction by passing in the owning connector
initialise(RequestConnector) - Method in interface com.ibm.connectors.RequestInteraction
Initialise the interaction by passing in the owning connector
initialiseConnector(String, Properties) - Method in class com.ibm.connectors.container.BaseDelegate
 
InputConnector - Interface in com.ibm.connectors
The interface for connectors intended to listen for incoming events or data.
InputDelegate - Class in com.ibm.connectors.container
 
InputDelegate(ContainerServices) - Constructor for class com.ibm.connectors.container.InputDelegate
 
isStarted() - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
isStarted() - Method in interface com.ibm.connectors.InputConnector
 

L

loadConnectorProperties(InputStream, List<URL>) - Method in class com.ibm.connectors.container.FilePathConnectorRegistry
 
lookupFactory(String, ContainerServices) - Method in interface com.ibm.connectors.container.ConnectorRegistry
 
lookupFactory(String, ContainerServices) - Method in class com.ibm.connectors.container.SimpleConnectorRegistry
 

N

NATIVE_INSTANCE - Static variable in class com.ibm.connectors.container.ContainerServices
 
NativeConnectorRegistry - Class in com.ibm.connectors.container
 
NativeConnectorRegistry(String, ConnectorLogger) - Constructor for class com.ibm.connectors.container.NativeConnectorRegistry
 
nativeDelegate - Variable in class com.ibm.connectors.container.NativeInputDelegate
 
nativeDelegate - Variable in class com.ibm.connectors.container.NativeOutputDelegate
 
nativeDelegate - Variable in class com.ibm.connectors.container.NativeRequestDelegate
 
NativeHelper - Class in com.ibm.connectors.container
 
NativeHelper() - Constructor for class com.ibm.connectors.container.NativeHelper
 
NativeInputDelegate - Class in com.ibm.connectors.container
 
NativeInputDelegate(long) - Constructor for class com.ibm.connectors.container.NativeInputDelegate
 
NativeLogHandler - Class in com.ibm.connectors.container
 
NativeLogHandler() - Constructor for class com.ibm.connectors.container.NativeLogHandler
 
NativeOutputDelegate - Class in com.ibm.connectors.container
 
NativeOutputDelegate(long) - Constructor for class com.ibm.connectors.container.NativeOutputDelegate
 
NativeRequestDelegate - Class in com.ibm.connectors.container
 
NativeRequestDelegate(long) - Constructor for class com.ibm.connectors.container.NativeRequestDelegate
 
nativeSend(Properties, Object) - Method in class com.ibm.connectors.container.NativeOutputDelegate
 

O

onInitialise() - Method in class com.ibm.connectors.AbstractConnectorFactory
This method is called after all initialisation state has been saved.
onInitialise() - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
onInitialise() - Method in class com.ibm.connectors.AbstractOutputInteraction
Method called after initialisation state has been saved.
onInitialise() - Method in class com.ibm.connectors.AbstractRequestInteraction
Method called after initialisation state has been saved.
OutputConnector - Interface in com.ibm.connectors
Base interface for all output-only connectors.
OutputDelegate - Class in com.ibm.connectors.container
 
OutputDelegate(ContainerServices) - Constructor for class com.ibm.connectors.container.OutputDelegate
 
OutputInteraction - Interface in com.ibm.connectors
Base interface for objects that send an output message to a remote system but doesn't expect a response.

P

poll(long) - Method in interface com.ibm.connectors.PollingInputConnector
Poll the input source for input events
PollingInputConnector - Interface in com.ibm.connectors
This interface extends InputConnector to trigger calls to processInboundData() in response to a call to poll the input source.
processInboundData(Object, Properties) - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
processInboundData(Object, Properties) - Method in interface com.ibm.connectors.ConnectorCallback
Notify host application of inbound data
processInboundData(Object, Properties) - Method in class com.ibm.connectors.container.BaseDelegate
 
processInboundData(Object, Properties) - Method in class com.ibm.connectors.container.InputDelegate
 
processInboundData(Object, Properties) - Method in class com.ibm.connectors.container.NativeInputDelegate
 
publish(LogRecord) - Method in class com.ibm.connectors.container.NativeLogHandler
 

R

refresh() - Method in class com.ibm.connectors.container.FilePathConnectorRegistry
 
registerFactory(String, String, Properties, URL[]) - Method in class com.ibm.connectors.container.NativeConnectorRegistry
 
registerFactory(String, String, Properties, URL[]) - Method in class com.ibm.connectors.container.SimpleConnectorRegistry
 
registerFactory(String, String, Properties) - Method in class com.ibm.connectors.container.SimpleConnectorRegistry
 
request(Properties, Object) - Method in class com.ibm.connectors.container.NativeRequestDelegate
 
request(Properties, Object) - Method in class com.ibm.connectors.container.RequestDelegate
 
request(Properties, Object) - Method in interface com.ibm.connectors.RequestInteraction
Send a request message using the provided configuration properties which may augment or override the properties set on the connector.
RequestConnector - Interface in com.ibm.connectors
Base interface for all request/response connectors.
RequestDelegate - Class in com.ibm.connectors.container
 
RequestDelegate(ContainerServices) - Constructor for class com.ibm.connectors.container.RequestDelegate
 
RequestInteraction - Interface in com.ibm.connectors
Base interface for objects that send a request message to a remote system expecting a response message in return.

S

searchPath(Path) - Method in class com.ibm.connectors.container.FilePathConnectorRegistry
 
SecurityDirector - Interface in com.ibm.connectors
Interface to allow connectors access to the host application's security checking mechanisms.
send(Properties, Object) - Method in class com.ibm.connectors.container.OutputDelegate
 
send(Properties, Object) - Method in interface com.ibm.connectors.OutputInteraction
Send an output message using the provided configuration properties which may augment or override the properties set on the connector.
serialiseProperties(Properties) - Static method in class com.ibm.connectors.container.NativeHelper
 
SimpleConnectorLogger - Class in com.ibm.connectors.container
 
SimpleConnectorLogger() - Constructor for class com.ibm.connectors.container.SimpleConnectorLogger
 
SimpleConnectorRegistry - Class in com.ibm.connectors.container
 
SimpleConnectorRegistry() - Constructor for class com.ibm.connectors.container.SimpleConnectorRegistry
 
SimpleContainerServices - Class in com.ibm.connectors.container
 
SimpleContainerServices(ConnectorRegistry, SecurityDirector, ConnectorLogger) - Constructor for class com.ibm.connectors.container.SimpleContainerServices
 
start() - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
start() - Method in interface com.ibm.connectors.InputConnector
Lifecycle method to put the input connector into a listening state
startInputConnector() - Method in class com.ibm.connectors.container.InputDelegate
 
startInputConnector() - Method in class com.ibm.connectors.container.NativeInputDelegate
 
stop() - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
stop() - Method in interface com.ibm.connectors.InputConnector
Lifecycle method to put the input connector into a not-listening state
stopInputConnector() - Method in class com.ibm.connectors.container.InputDelegate
 
stopInputConnector() - Method in class com.ibm.connectors.container.NativeInputDelegate
 
switchTo(Object) - Static method in class com.ibm.connectors.container.ClassContext
 
switchToClassLoader(ClassLoader) - Static method in class com.ibm.connectors.container.ClassContext
 

T

terminate() - Method in class com.ibm.connectors.AbstractConnectorFactory
 
terminate() - Method in class com.ibm.connectors.AbstractInputConnectorFilter
 
terminate() - Method in class com.ibm.connectors.AbstractOutputInteraction
 
terminate() - Method in class com.ibm.connectors.AbstractRequestInteraction
 
terminate() - Method in interface com.ibm.connectors.Connector
Reset the connector to an uninitialised state.
terminate() - Method in interface com.ibm.connectors.ConnectorFactory
Clear any shared resources
terminate() - Method in interface com.ibm.connectors.container.ConnectorRegistry
 
terminate() - Method in class com.ibm.connectors.container.SimpleConnectorRegistry
 
terminate() - Method in interface com.ibm.connectors.OutputInteraction
Called to allow the interaction to close any resources it may have created.
terminate() - Method in interface com.ibm.connectors.RequestInteraction
Called to allow the interaction to close any resources it may have created.
terminateConnector() - Method in class com.ibm.connectors.container.BaseDelegate
 

_

_asyncFailure(long, long, Exception) - Method in class com.ibm.connectors.container.NativeOutputDelegate
 
_asyncFailure(long, long, Exception) - Method in class com.ibm.connectors.container.NativeRequestDelegate
 
_asyncRequestSuccess(long, long, byte[]) - Method in class com.ibm.connectors.container.NativeRequestDelegate
 
_asyncSendSuccess(long, long) - Method in class com.ibm.connectors.container.NativeOutputDelegate
 
_processInboundData(long, byte[], byte[]) - Method in class com.ibm.connectors.container.NativeInputDelegate
 
A B C D F G I L N O P R S T _ 
IBM TM
CommonTM Connector API