com.ibm.di.connector
Interface ChangelogInterface

All Known Implementing Classes:

ADChangelogConnectorv2, DBChangelogConnector, DominoChangeDetectionConnector, IDSChangelogConnector, NetscapeChangelogConnector, ZOSChangelogConnector

public interface ChangelogInterface

The interface object which all ChangelogConnectors should implement.

See Also:

ChangelogConnector

Field Summary

static String	CONN_PARAM_STATE_KEY_PERSISTENCE The name of the parameter which value specifies the method, used for storing the StateKey.
static String	PARAM_MERGE_BOTH_NOT_MERGED Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter.
static String	PARAM_MERGE_CHANGELOG_AND_DATA Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter.
static String	PARAM_MERGE_ONLY_CHANGED_DATA Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter.
static String	PARAM_VAL_AFTER_READ Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter.
static String	PARAM_VAL_END_OF_CYCLE Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter.
static String	PARAM_VAL_MANUAL Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter.
static int	SAVE_STATE_AFTER_READ This constant is usually used to specify that the StateKey should be persisted after each received entry.
static int	SAVE_STATE_END_OF_CYCLE This constant is usually used to specify that the StatKey should be persisted after each AL cycle ends.
static int	SAVE_STATE_MANUAL This constant is usually used to specify that the StatKey persistence is not done automatically by the TDI Server.

Method Summary

Object	getStateKeyObject() Retrieves state key.
int	getStateKeySaveMethod() Retrieves the method for storing StateKey.
void	saveStateKey() Stores the USN values for the next synchronization.

Field Detail

CONN_PARAM_STATE_KEY_PERSISTENCE

static final String CONN_PARAM_STATE_KEY_PERSISTENCE

The name of the parameter which value specifies the method, used for storing the StateKey.

See Also:

Constant Field Values

PARAM_VAL_AFTER_READ

static final String PARAM_VAL_AFTER_READ

Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter. If that parameter have this value then the getStateKeySaveMethod() will return SAVE_STATE_AFTER_READ (0)

See Also:

Constant Field Values

PARAM_VAL_END_OF_CYCLE

static final String PARAM_VAL_END_OF_CYCLE

Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter. If that parameter have this value then the getStateKeySaveMethod() will return SAVE_STATE_END_OF_CYCLE (1)

See Also:

Constant Field Values

PARAM_VAL_MANUAL

static final String PARAM_VAL_MANUAL

Possible String value of the CONN_PARAM_STATE_KEY_PERSISTENCE parameter. If that parameter have this value then the getStateKeySaveMethod() will return SAVE_STATE_MANUAL (2)

See Also:

Constant Field Values

PARAM_MERGE_CHANGELOG_AND_DATA

static final String PARAM_MERGE_CHANGELOG_AND_DATA

Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter. If that parameter have this value then the ChangelogConnector.defaultMerge will have a value of true.

See Also:

Constant Field Values

PARAM_MERGE_ONLY_CHANGED_DATA

static final String PARAM_MERGE_ONLY_CHANGED_DATA

Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter. If that parameter have this value then the ChangelogConnector.onlyChanges will have a value of true.

See Also:

Constant Field Values

PARAM_MERGE_BOTH_NOT_MERGED

static final String PARAM_MERGE_BOTH_NOT_MERGED

Possible String value of the ChangelogConnector.PARAM_MERGE_MODE parameter. If that parameter have this value then the ChangelogConnector.bothSeparated will have a value of true.

See Also:

Constant Field Values

SAVE_STATE_AFTER_READ

static final int SAVE_STATE_AFTER_READ

This constant is usually used to specify that the StateKey should be persisted after each received entry.

See Also:

Constant Field Values

SAVE_STATE_END_OF_CYCLE

static final int SAVE_STATE_END_OF_CYCLE

This constant is usually used to specify that the StatKey should be persisted after each AL cycle ends.

See Also:

Constant Field Values

SAVE_STATE_MANUAL

static final int SAVE_STATE_MANUAL

This constant is usually used to specify that the StatKey persistence is not done automatically by the TDI Server. The user is supposed to call the saveStateKey() method in order to store the StateKey.

See Also:

Constant Field Values

Method Detail

getStateKeySaveMethod

int getStateKeySaveMethod()
                          throws Exception

Retrieves the method for storing StateKey.

Returns:

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

Throws:

Exception - - never

See Also:

SAVE_STATE_AFTER_READ, SAVE_STATE_END_OF_CYCLE, SAVE_STATE_MANUAL

saveStateKey

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 SAVE_STATE_AFTER_READ

Throws:

Exception - - never

getStateKeyObject

Object getStateKeyObject()
                         throws Exception

Retrieves state key.

Returns:

the StateKey, wrapped in some kind of object.

Throws:

Exception - if an error occurs.