com.ibm.di.connector
Class ZOSChangelogConnector

java.lang.Object
  com.ibm.di.connector.Connector
      com.ibm.di.connector.LDAPConnector
          com.ibm.di.connector.ChangelogConnector
              com.ibm.di.connector.ZOSChangelogConnector

All Implemented Interfaces:

ChangelogInterface, ConnectorInterface, VersionInfoInterface

public class ZOSChangelogConnector
extends ChangelogConnector
implements ConnectorInterface, ChangelogInterface

The IDSChangelogConnector provides a way to to detect changes in a zOS Directory Server. The Connector connects to the underline directory through the JNDI interface and gets the changes done on a specific context. The Connector regularly saves current state into the System Store to avoid duplications when retrieving Entries.

Field Summary

static String	ATTRIBUTE_CHANGENUMBER Attribute name: "changenumber"
static String	ATTRIBUTE_CPR Attribute name: "changeNumber"
static String	PARAM_LDAP_SEARCH_BASE Parameter Name: "ldapSearchBase"
static String	PARAM_SLEEP_INTERVAL Parameter Name: "nsSleepInterval"
static String	PARAM_START_AT Parameter Name: "nsChangenumber"
static String	PARAM_STORE_PARAM_NAME Parameter Name: "iteratorStateKey"
static String	PARAM_TIMEOUT Parameter Name: "nsTimeout"

Fields inherited from class com.ibm.di.connector.ChangelogConnector

bothSeparated, defaultMerge, onlyChanges, PARAM_MERGE_MODE

Fields inherited from class com.ibm.di.connector.Connector

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Fields inherited from interface com.ibm.di.connector.ChangelogInterface

CONN_PARAM_STATE_KEY_PERSISTENCE, PARAM_MERGE_BOTH_NOT_MERGED, PARAM_MERGE_CHANGELOG_AND_DATA, PARAM_MERGE_ONLY_CHANGED_DATA, PARAM_VAL_AFTER_READ, PARAM_VAL_END_OF_CYCLE, PARAM_VAL_MANUAL, SAVE_STATE_AFTER_READ, SAVE_STATE_END_OF_CYCLE, SAVE_STATE_MANUAL

Constructor Summary

ZOSChangelogConnector()
Constructs this object and sets it supported mode.

Method Summary

Entry	getNextEntry() This method will get the next change if the number of changes is smaller than the actual changes, that were done on the zOS Directory Server.
Object	getStateKeyObject() Retrieves state key.
int	getStateKeySaveMethod() Retrieves the method for storing StateKey.
String	getVersion() Version information.
void	initialize(Object aObject) Initializes the connector.
protected Entry	parseEntry(Entry aEntry) Method for parsing and merging Changelog Entry attributes and changed attributes from the actual Directory Entry.
void	reconnect(Object o) Reconnect to the underlying data source
void	saveStateKey() Stores the USN values for the next synchronization.
void	selectEntries() Prepares the connector for iterating over changed objects.

Methods inherited from class com.ibm.di.connector.ChangelogConnector

querySchema

Methods inherited from class com.ibm.di.connector.LDAPConnector

addAttributeValue, at2entry, callErrorHookOnAttributeInUseException, compare, deleteEntry, entry2at, findEntry, flagSet, getAttributeSyntax, getCallErrorHook, getCurrentEntry, getLdapContext, getServerControls, getServerInfo, isDeltaSupported, isExceptionFatal, mapAttributeSyntax, modEntry, modEntry, moveEntry, putEntry, queryNamingContexts, queryObjectClassAttributes, rebind, rebind, removeAllAttributeValues, removeAttributeValue, replaceAttributeValue, setADPassword, setsubtreeDeleteSupported, showServerInfo, supportsControl, supportsExtension, supportsPagedResults, supportsPersistantSearch, supportsSorting, supportsVirtualListView, terminate

Methods inherited from class com.ibm.di.connector.Connector

addFindEntry, allModes, clearFindEntries, debug, debugMode, findEntry, getBoolean, getClassInstance, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getLog, getMaxDuplicateEntries, getModes, getModes, getName, getNextClient, getNextFindEntry, getParam, getParser, getProperty, getPushbackEntry, getRawConnectorConfiguration, getRSInterface, getUI, hasConfigValue, hasParser, initParser, isIOException, logError, logmsg, pushback, queryOperations, queryReply, queryTables, reconnect, registerScriptBeans, replyEntry, 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, putEntry, queryOperations, queryReply, querySchema, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setName, setParam, setRSInterface, terminate, terminateServer

Field Detail

PARAM_LDAP_SEARCH_BASE

public static final String PARAM_LDAP_SEARCH_BASE

Parameter Name: "ldapSearchBase"

See Also:

Constant Field Values

PARAM_STORE_PARAM_NAME

public static final String PARAM_STORE_PARAM_NAME

Parameter Name: "iteratorStateKey"

See Also:

Constant Field Values

PARAM_START_AT

public static final String PARAM_START_AT

Parameter Name: "nsChangenumber"

See Also:

Constant Field Values

PARAM_SLEEP_INTERVAL

public static final String PARAM_SLEEP_INTERVAL

Parameter Name: "nsSleepInterval"

See Also:

Constant Field Values

PARAM_TIMEOUT

public static final String PARAM_TIMEOUT

Parameter Name: "nsTimeout"

See Also:

Constant Field Values

ATTRIBUTE_CPR

public static final String ATTRIBUTE_CPR

Attribute name: "changeNumber"

See Also:

Constant Field Values

ATTRIBUTE_CHANGENUMBER

public static final String ATTRIBUTE_CHANGENUMBER

Attribute name: "changenumber"

See Also:

Constant Field Values

Constructor Detail

ZOSChangelogConnector

public ZOSChangelogConnector()

Constructs this object and sets it supported mode.

Method Detail

initialize

public void initialize(Object aObject)
                throws Exception

Initializes the connector. All the configuration properties are considered and applied before a connection is made. After everything is set the connection is established.

Specified by:

initialize in interface ConnectorInterface

Overrides:

initialize in class ChangelogConnector

Parameters:

aObject - ignored.

Throws:

Exception - if an error occurs.

selectEntries

public void selectEntries()
                   throws Exception

Prepares the connector for iterating over changed objects.

Specified by:

selectEntries in interface ConnectorInterface

Overrides:

selectEntries in class LDAPConnector

Throws:

Exception - if an error occurs.

getNextEntry

public Entry getNextEntry()
                   throws Exception

This method will get the next change if the number of changes is smaller than the actual changes, that were done on the zOS Directory Server. If no more changes are available this method will sleep as much as the user have defined and when it wakes up it will check if any change was made.

Specified by:

getNextEntry in interface ConnectorInterface

Overrides:

getNextEntry in class LDAPConnector

Returns:

the changes as an Entry object

Throws:

Exception - if an error occurs.

See Also:

ConnectorInterface.selectEntries()

getStateKeySaveMethod

public int getStateKeySaveMethod()
                          throws Exception

Retrieves the method for storing StateKey.

Specified by:

getStateKeySaveMethod in interface ChangelogInterface

Returns:

the identifier of the method used for storing the StateKey in the TDI Store.

Throws:

Exception - - never

See Also:

ChangelogInterface.SAVE_STATE_AFTER_READ, ChangelogInterface.SAVE_STATE_END_OF_CYCLE, ChangelogInterface.SAVE_STATE_MANUAL

saveStateKey

public void saveStateKey()
                  throws Exception

Stores the USN values for the next synchronization. This method will skip the storing of the StateKey if the StateKey save method is set to ChangelogInterface.SAVE_STATE_AFTER_READ

Specified by:

saveStateKey in interface ChangelogInterface

Throws:

Exception - - never

getStateKeyObject

public Object getStateKeyObject()
                         throws Exception

Retrieves state key.

Specified by:

getStateKeyObject in interface ChangelogInterface

Returns:

the change number wrapped as a Long object.

Throws:

Exception - - never

getVersion

public String getVersion()

Version information.

Specified by:

getVersion in interface VersionInfoInterface

Overrides:

getVersion in class ChangelogConnector

Returns:

the version information.

reconnect

public void reconnect(Object o)
               throws Exception

Reconnect to the underlying data source

Specified by:

reconnect in interface ConnectorInterface

Overrides:

reconnect in class Connector

Parameters:

o - User provided parameter, which is sent to initialize()

Throws:

Exception - if an error occurs.

See Also:

ConnectorInterface.initialize(Object)

parseEntry

protected Entry parseEntry(Entry aEntry)
                    throws Exception

Method for parsing and merging Changelog Entry attributes and changed attributes from the actual Directory Entry.

Note: The 'changes' attribute is optional for RACF LDAP changelog entries. Also the 'newrdn' attribute is missing for 'add' operations. Therefore there is no need to parse entries if both attributes are missing.

Overrides:

parseEntry in class ChangelogConnector

Parameters:

aEntry - the actual Directory Entry.

Returns:

the result of the parsing and merging operations entry.

Throws:

Exception - if an error occurs.