Package org.silverpeas.core.admin.domain.driver.ldapdriver

Class LDAPCredentialsEncryptionIterator

java.lang.Object

org.silverpeas.core.admin.domain.driver.ldapdriver.LDAPCredentialsEncryptionIterator

All Implemented Interfaces:

Iterator<Map<String,String>>, EncryptionContentIterator

public class LDAPCredentialsEncryptionIterator
extends Object
implements EncryptionContentIterator

An iterator on all the LDAP domains to encrypt or to renew encryption of the credentials used to access the remote LDAP service.

Author:

mmoquillon

Constructor Summary

Constructors

Constructor	Description
LDAPCredentialsEncryptionIterator()

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()	Is there another content in this iteration?
void	init()	Initialize contents to iterate.
Map<String,String>	next()	Gets the next content in the iteration.
void	onError(Map<String,String> content, CryptoException ex)	An error occurred while processing the last content returned by this iterator.
void	update(Map<String,String> updatedContent)	Updates the last content returned by this iterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

LDAPCredentialsEncryptionIterator

public LDAPCredentialsEncryptionIterator()

Method Detail

init

public void init()

Description copied from interface: EncryptionContentIterator

Initialize contents to iterate. It prepares iterator for the encryption operations. It will be invoked by content encryption service before any iteration.

Specified by:

init in interface EncryptionContentIterator

next

public Map<String,String> next()

Description copied from interface: EncryptionContentIterator

Gets the next content in the iteration.

Specified by:

next in interface EncryptionContentIterator

Specified by:

next in interface Iterator<Map<String,String>>

Returns:

the next content to update in the form of a Map object in which each entry represents a field or a property of the content.

hasNext

public boolean hasNext()

Description copied from interface: EncryptionContentIterator

Is there another content in this iteration?

This method is called by the encryption service each time before asking the next content to encrypt or to decrypt with the EncryptionContentIterator.next() method.

Specified by:

hasNext in interface EncryptionContentIterator

Specified by:

hasNext in interface Iterator<Map<String,String>>

Returns:

true if there is another content in the iteration. False otherwise.

update

public void update(Map<String,String> updatedContent)

Description copied from interface: EncryptionContentIterator

Updates the last content returned by this iterator.

Specified by:

update in interface EncryptionContentIterator

Parameters:

updatedContent - the content updated by the encryption service in the form of a Map object in which each entry represents a field or a property of the content.

onError

public void onError(Map<String,String> content,
                    CryptoException ex)

Description copied from interface: EncryptionContentIterator

An error occurred while processing the last content returned by this iterator.

This method is invoked by the encryption service when an error occurs while processing the last content returned by the iterator.

Specified by:

onError in interface EncryptionContentIterator

Parameters:

content - the content with which the error occurred.

ex - the exception raised at the error.