public interface Connector
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
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
|
void |
initialise(java.lang.String name,
java.util.Properties properties,
ConnectorCallback callback,
ConnectorServices services)
Initialise the connector.
|
void |
terminate()
Reset the connector to an uninitialised state.
|
static final java.lang.String COPYRIGHT
java.lang.String getName()
java.util.Properties getProperties()
java.util.logging.Logger getLogger()
ConnectorCallback getCallback()
ConnectorServices getConnectorServices()
void initialise(java.lang.String name, java.util.Properties properties, ConnectorCallback callback, ConnectorServices services) throws ConnectorException
name
- the name of the connectorproperties
- properties used to configure the connectorcallback
- the host application's callback interfaceservices
- application servicesConnectorException
void terminate() throws ConnectorException
ConnectorException