Package org.ldaptive.ext

Class MergeOperation

java.lang.Object

org.ldaptive.ext.MergeOperation

public class MergeOperation
extends Object

The merge operation performs the LDAP operations necessary to synchronize the data in an LdapEntry with it's corresponding entry in the LDAP. The following logic is executed:

• if the entry does not exist in the LDAP, execute an add
• if the request is for a delete, execute a delete
• if the entry exists in the LDAP, execute a modify

LdapEntry.computeModifications(LdapEntry, LdapEntry) is used to determine the list of attribute modifications that are necessary to perform the merge. Either MergeRequest.getIncludeAttributes() or MergeRequest.getExcludeAttributes() will be used, but not both.

Field Summary

Fields

Modifier and Type	Field	Description
private ConnectionFactory	connectionFactory	Connection factory.
private Logger	logger	Logger for this class.
private ResultPredicate	throwCondition	Function to test results.

Constructor Summary

Constructors

Constructor	Description
MergeOperation()	Default constructor.
MergeOperation(ConnectionFactory factory)	Creates a new merge operation.

Method Summary

Modifier and Type	Method	Description
protected Result	add(Connection conn, MergeRequest request, LdapEntry entry)	Executes an AddOperation for the supplied entry.
protected Result	delete(Connection conn, MergeRequest request, LdapEntry entry)	Executes a DeleteOperation for the supplied entry.
Result	execute(MergeRequest request)	Executes a merge request.
ConnectionFactory	getConnectionFactory()
ResultPredicate	getThrowCondition()
protected Result	modify(Connection conn, MergeRequest request, LdapEntry source, LdapEntry target)	Retrieves the attribute modifications from LdapEntry.computeModifications(LdapEntry, LdapEntry) and executes a ModifyOperation with those results.
void	setConnectionFactory(ConnectionFactory factory)
void	setThrowCondition(ResultPredicate function)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final Logger logger

Logger for this class.

connectionFactory

private ConnectionFactory connectionFactory

Connection factory.

throwCondition

private ResultPredicate throwCondition

Function to test results.

Constructor Detail

MergeOperation

public MergeOperation()

Default constructor.

MergeOperation

public MergeOperation(ConnectionFactory factory)

Creates a new merge operation.

Parameters:

factory - connection factory

Method Detail

getConnectionFactory

public ConnectionFactory getConnectionFactory()

setConnectionFactory

public void setConnectionFactory(ConnectionFactory factory)

getThrowCondition

public ResultPredicate getThrowCondition()

setThrowCondition

public void setThrowCondition(ResultPredicate function)

execute

public Result execute(MergeRequest request)
               throws LdapException

Executes a merge request. See OperationHandle.execute().

Parameters:

request - merge request

Returns:

merge result

Throws:

LdapException - if the connection cannot be opened

modify

protected Result modify(Connection conn,
                        MergeRequest request,
                        LdapEntry source,
                        LdapEntry target)
                 throws LdapException

Retrieves the attribute modifications from LdapEntry.computeModifications(LdapEntry, LdapEntry) and executes a ModifyOperation with those results. If no modifications are necessary, no operation is performed.

Parameters:

conn - connection to perform operation on

request - merge request

source - ldap entry to merge into the LDAP

target - ldap entry that exists in the LDAP

Returns:

response of the modify operation or an empty response if no operation is performed

Throws:

LdapException - if an error occurs executing the modify operation

add

protected Result add(Connection conn,
                     MergeRequest request,
                     LdapEntry entry)
              throws LdapException

Executes an AddOperation for the supplied entry.

Parameters:

conn - connection to perform operation on

request - merge request

entry - to add to the LDAP

Returns:

response of the add operation

Throws:

LdapException - if an error occurs executing the add operation

delete

protected Result delete(Connection conn,
                        MergeRequest request,
                        LdapEntry entry)
                 throws LdapException

Executes a DeleteOperation for the supplied entry.

Parameters:

conn - connection to perform operation on

request - merge request

entry - to delete from the LDAP

Returns:

response of the delete operation

Throws:

LdapException - if an error occurs executing the deleting operation