com.ibm.di.plugin.pwstore.itim
Class BasePasswordSynchronizerDecorator

java.lang.Object
  extended by com.ibm.di.plugin.pwstore.itim.BasePasswordSynchronizerDecorator
All Implemented Interfaces:
IPasswordSynchronizer, PasswordStore

public final class BasePasswordSynchronizerDecorator
extends java.lang.Object
implements PasswordStore, IPasswordSynchronizer

This is a generic password synchronizer decorator. Its decorates an PasswordStore with password validation functionality.


Constructor Summary
BasePasswordSynchronizerDecorator(IPasswordSynchronizer sync, PasswordPolicyService pps)
          Create the generic decorator by wrapping the concrete impls.
BasePasswordSynchronizerDecorator(PasswordStore sync, PasswordPolicyService pps)
          Create the generic decorator by wrapping the concrete impls.
 
Method Summary
 boolean addPasswordValues(java.lang.String aId, java.util.Vector aPasswordValues)
          Deprecated. 
 boolean deletePasswordValues(java.lang.String aId, java.util.Vector aPasswordValues)
          Deprecated. 
 java.lang.Exception getLastError()
          Enable client to access the exception caught during invocation of object methods, if an error occurred.
 java.lang.String getLastPolicyServiceMsg()
          Get the status message returned from the previous invocation of #addPasswordValues(PasswordChange) or #syncPassword(PasswordChange).
 void initialize(java.lang.Object aObj)
          This method initializes the password store.
 boolean isAvailable(PasswordChange change)
          This method check the password store availability,
 boolean readyToSync(java.lang.String aId)
          Deprecated. 
 boolean readyToSync(java.lang.String aId, java.util.Vector aPasswordValues)
          Deprecated. 
 boolean setExtendedData(PasswordChange change)
          This method sends additional information about a user.
 boolean setExtendedData(java.lang.String id, java.lang.String extendedData)
          Deprecated. 
 boolean store(PasswordChange change)
           Synchronize the users' passwords.
 boolean syncPassword(java.lang.String aId, java.util.Vector aPasswordValues)
          Deprecated. 
 void terminate()
          This method cleans any reserved resources such as files, connections etc.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasePasswordSynchronizerDecorator

public BasePasswordSynchronizerDecorator(IPasswordSynchronizer sync,
                                         PasswordPolicyService pps)
Create the generic decorator by wrapping the concrete impls.

Parameters:
sync - The traditional TDI password synchronizer.
pps - The password policy service provider.

BasePasswordSynchronizerDecorator

public BasePasswordSynchronizerDecorator(PasswordStore sync,
                                         PasswordPolicyService pps)
Create the generic decorator by wrapping the concrete impls.

Parameters:
sync - The traditional TDI password synchronizer.
pps - The password policy service provider.
Method Detail

isAvailable

public boolean isAvailable(PasswordChange change)
Description copied from interface: PasswordStore
This method check the password store availability,

Specified by:
isAvailable in interface PasswordStore
Parameters:
change - object describing the password change
Returns:
true if password store is available; false otherwise
See Also:
PasswordStore.isAvailable(PasswordChange)

store

public boolean store(PasswordChange change)

Synchronize the users' passwords. This method first validates the password against the password policy service provider. If successful the password are then synchronized. Clients should check for errors after executing this method using getLastError().

NB: Although the PasswordPolicyService supports synchronization, this method does not invoke this support. Synchronization is delegated to the decorated PasswordStore only.

Specified by:
store in interface PasswordStore
Parameters:
change - object describing the password change
Returns:
true if the operation is successful; false otherwise
See Also:
PasswordStore#syncPassword(PasswordChange)

setExtendedData

public boolean setExtendedData(PasswordChange change)
Description copied from interface: PasswordStore
This method sends additional information about a user.

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

Specified by:
setExtendedData in interface PasswordStore
Parameters:
change - object describing the password change
Returns:
true if the operation is successful; false otherwise
See Also:
PasswordStore.setExtendedData(PasswordChange)

initialize

public void initialize(java.lang.Object aObj)
                throws java.lang.Exception
Description copied from interface: PasswordStore
This method initializes the password store.

Specified by:
initialize in interface IPasswordSynchronizer
Specified by:
initialize in interface PasswordStore
Parameters:
aObj - object of type PWSyncLog used for logging
Throws:
java.lang.Exception
See Also:
PasswordStore.initialize(java.lang.Object)

terminate

public void terminate()
Description copied from interface: PasswordStore
This method cleans any reserved resources such as files, connections etc.

Specified by:
terminate in interface IPasswordSynchronizer
Specified by:
terminate in interface PasswordStore
See Also:
PasswordStore.terminate()

readyToSync

@Deprecated
public boolean readyToSync(java.lang.String aId)
Deprecated. 

Specified by:
readyToSync in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.readyToSync(java.lang.String)

readyToSync

@Deprecated
public boolean readyToSync(java.lang.String aId,
                                      java.util.Vector aPasswordValues)
Deprecated. 

Specified by:
readyToSync in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.readyToSync(java.lang.String, java.util.Vector)

syncPassword

@Deprecated
public boolean syncPassword(java.lang.String aId,
                                       java.util.Vector aPasswordValues)
Deprecated. 

Specified by:
syncPassword in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.syncPassword(java.lang.String, java.util.Vector)

addPasswordValues

@Deprecated
public boolean addPasswordValues(java.lang.String aId,
                                            java.util.Vector aPasswordValues)
Deprecated. 

Specified by:
addPasswordValues in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.addPasswordValues(java.lang.String, java.util.Vector)

deletePasswordValues

@Deprecated
public boolean deletePasswordValues(java.lang.String aId,
                                               java.util.Vector aPasswordValues)
Deprecated. 

Specified by:
deletePasswordValues in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.deletePasswordValues(java.lang.String, java.util.Vector)

setExtendedData

@Deprecated
public boolean setExtendedData(java.lang.String id,
                                          java.lang.String extendedData)
Deprecated. 

Specified by:
setExtendedData in interface IPasswordSynchronizer
See Also:
IPasswordSynchronizer.setExtendedData(String, String)

getLastError

public java.lang.Exception getLastError()
Enable client to access the exception caught during invocation of object methods, if an error occurred. This method will clear the exception. This method is provided because some of the IPasswordSynchronizer methods do not declare to throw exceptions.

Returns:
The last exception, or null. If null, the client can assume the previous method executed successfully.

getLastPolicyServiceMsg

public java.lang.String getLastPolicyServiceMsg()
Get the status message returned from the previous invocation of #addPasswordValues(PasswordChange) or #syncPassword(PasswordChange).

Returns:
The status message from the service, or null if no status was returned.