com.ibm.di.plugin.pwstore
Interface PasswordStore

All Known Implementing Classes:

BasePasswordStore, BasePasswordSynchronizerDecorator, JMSPasswordStore, JMSPasswordStoreITIMDecorator, LDAPPasswordStore, LDAPPasswordStoreITIMDecorator, LogPasswordStore, LogPasswordStoreITIMDecorator, PasswordStoreAdapter

public interface PasswordStore

This interface should be implemented by all password stores. It replaces the deprecated IPasswordSynchronizer interface.

Note: User password stores must not implement this interface directly. Instead they must extend from the BasePasswordStore class in order to stay forward compatible.

See Also:

IPasswordSynchronizer

Method Summary

void	initialize(java.lang.Object aObj) This method initializes the password store.
boolean	isAvailable(PasswordChange change) This method check the password store availability,
boolean	setExtendedData(PasswordChange change) This method sends additional information about a user.
boolean	store(PasswordChange change) This method stores password change in the password store.
void	terminate() This method cleans any reserved resources such as files, connections etc.

Method Detail

isAvailable

boolean isAvailable(PasswordChange change)

This method check the password store availability,

Parameters:

change - object describing the password change

Returns:

true if password store is available; false otherwise

store

boolean store(PasswordChange change)

This method stores password change in the password store.

Parameters:

change - object describing the password change

Returns:

true if the operation is successful; false otherwise

setExtendedData

boolean setExtendedData(PasswordChange change)

This method sends additional information about a user.

Currently only the Windows Password Synchronizer plug-in sends extended data.

Parameters:

change - object describing the password change

Returns:

true if the operation is successful; false otherwise

initialize

void initialize(java.lang.Object aObj)
                throws java.lang.Exception

This method initializes the password store.

Parameters:

aObj - object of type PWSyncLog used for logging

Throws:

java.lang.Exception

terminate

void terminate()

This method cleans any reserved resources such as files, connections etc.