public abstract class AbstractOutputConnector extends java.lang.Object implements OutputConnector
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
Constructor and Description |
---|
AbstractOutputConnector() |
Modifier and Type | Method and Description |
---|---|
ConnectorCallback |
getCallback()
Returns a callback object that the connector can use to feed data and results back to the
host application.
|
ConnectorServices |
getConnectorServices()
Services provided by the host application for use by the connector
|
java.util.logging.Logger |
getLogger()
Returns a java.util.Logger which uses the connector's name, to enable the connector to log
to the host application's logging mechanism
|
java.lang.String |
getName()
Returns the name allocated by the runtime to this connector when it was initialsed.
|
java.util.Properties |
getProperties()
Returns the properties object passed to connector when it was initialised
|
java.lang.String |
getProperty(java.lang.String name)
Utility method to return a property of a particular name
|
void |
initialise(java.lang.String name,
java.util.Properties properties,
ConnectorCallback callback,
ConnectorServices services)
Initialise the connector.
|
protected void |
onInitialise()
Method called after initialisation state has been saved.
|
void |
terminate()
Reset the connector to an uninitialised state.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createOutputInteraction
getCallback, getConnectorServices, getLogger, getName, getProperties, initialise, terminate
public static final java.lang.String COPYRIGHT
public java.lang.String getName()
Connector
getName
in interface Connector
Connector.getName()
public java.util.Properties getProperties()
Connector
getProperties
in interface Connector
Connector.getProperties()
public java.lang.String getProperty(java.lang.String name)
name
- property namepublic ConnectorServices getConnectorServices()
Connector
getConnectorServices
in interface Connector
Connector.getConnectorServices()
public ConnectorCallback getCallback()
Connector
getCallback
in interface Connector
Connector.getCallback()
public java.util.logging.Logger getLogger()
Connector
getLogger
in interface Connector
Connector.getLogger()
public void initialise(java.lang.String name, java.util.Properties properties, ConnectorCallback callback, ConnectorServices services) throws ConnectorException
Connector
initialise
in interface Connector
name
- the name of the connectorproperties
- properties used to configure the connectorcallback
- the host application's callback interfaceservices
- application servicesConnectorException
Connector.initialise(java.lang.String, java.util.Properties, com.ibm.connectors.ConnectorCallback, com.ibm.connectors.ConnectorServices)
protected void onInitialise() throws java.lang.Exception
java.lang.Exception
public void terminate() throws ConnectorException
Connector
terminate
in interface Connector
ConnectorException
Connector.terminate()