com.ibm.di.connector
Class ServerNotificationsConnector

java.lang.Object
  extended by com.ibm.di.connector.Connector
      extended by com.ibm.di.connector.ServerNotificationsConnector
All Implemented Interfaces:
ConnectorInterface, VersionInfoInterface

public class ServerNotificationsConnector
extends Connector
implements ConnectorInterface

The Connector listens for local or remote Server API notifications depending on the mode selected by setting a Connector parameter. In remote mode the Connector hooks into remote TDI systems and registers for notifications. In local mode the Connector registers for Server API notifications emitted in the TDI JVM - the notifications can be emitted by the Server API layer. When the Connector receives a notification it stores it into an internal Connector buffer for later retrieval by the standard getNextEntry() Connector method which is called by the AssemblyLine for Connectors in Iterator mode.


Field Summary
 
Fields inherited from class com.ibm.di.connector.Connector
ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER
 
Constructor Summary
ServerNotificationsConnector()
          Constructor for the ServerNotificationListenerConnector object
 
Method Summary
 Entry getNextEntry()
          Gets the next notification object
 String getVersion()
          Version information.
 void initialize(Object aObj)
          Reads connector parameter's values and initialize the Connector.
 void putEntry(Entry entry)
          Emits a custom Server API notification
 void terminate()
          Terminate the connector.
 
Methods inherited from class com.ibm.di.connector.Connector
addFindEntry, allModes, clearFindEntries, debug, debugMode, deleteEntry, findEntry, findEntry, getBoolean, getClassInstance, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getLog, getMaxDuplicateEntries, getModes, getModes, getName, getNextClient, getNextFindEntry, getParam, getParser, getProperty, getPushbackEntry, getRawConnectorConfiguration, getRSInterface, getUI, hasConfigValue, hasParser, initParser, isDeltaSupported, isExceptionFatal, isIOException, logError, logmsg, modEntry, modEntry, pushback, queryOperations, queryReply, querySchema, queryTables, reconnect, reconnect, registerScriptBeans, replyEntry, selectEntries, setConfiguration, setContext, setCurrent, setDebugMode, setLog, setMaxDuplicateEntries, setModes, setModes, setName, setParam, setParser, setProperty, setRSInterface, terminateServer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.di.connector.ConnectorInterface
deleteEntry, findEntry, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getMaxDuplicateEntries, getName, getNextClient, getNextFindEntry, getParam, getPushbackEntry, getRawConnectorConfiguration, isDeltaSupported, isExceptionFatal, isIOException, modEntry, modEntry, pushback, queryOperations, queryReply, querySchema, reconnect, registerScriptBeans, replyEntry, selectEntries, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setName, setParam, setRSInterface, terminateServer
 

Constructor Detail

ServerNotificationsConnector

public ServerNotificationsConnector()
Constructor for the ServerNotificationListenerConnector object

Method Detail

initialize

public void initialize(Object aObj)
                throws Exception
Reads connector parameter's values and initialize the Connector.

Specified by:
initialize in interface ConnectorInterface
Overrides:
initialize in class Connector
Parameters:
aObj - Null, Socket or ConnectorMode class
Throws:
Exception - If invalid Connector parameter values are supplied.

getNextEntry

public Entry getNextEntry()
                   throws Exception
Gets the next notification object

Specified by:
getNextEntry in interface ConnectorInterface
Overrides:
getNextEntry in class Connector
Returns:
The next Entry
Throws:
Exception - If retrieving the next Entry fails.
See Also:
ConnectorInterface.selectEntries()

putEntry

public void putEntry(Entry entry)
              throws Exception
Emits a custom Server API notification

Specified by:
putEntry in interface ConnectorInterface
Overrides:
putEntry in class Connector
Parameters:
entry - The entry that holds the notification data
Throws:
Exception - If emiting notification fails.

terminate

public void terminate()
               throws Exception
Terminate the connector. This function closes all connection and releases all resources used by the connector. This function also calls the parser's closeParser function if a parser is active.

Specified by:
terminate in interface ConnectorInterface
Overrides:
terminate in class Connector
Throws:
Exception - If terminate fails.

getVersion

public String getVersion()
Version information.

Specified by:
getVersion in interface VersionInfoInterface
Returns:
the version information