org.ldaptive.ext

Class MergeRequest

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.ext.MergeRequest

All Implemented Interfaces:

Message<RequestControl>, Request

public class MergeRequest
extends AbstractRequest

Contains the data required to perform a merge operation.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	deleteEntry Whether to delete the entry.
private java.lang.String[]	excludeAttrs Attribute names to exclude when performing a merge.
private java.lang.String[]	includeAttrs Attribute names to include when performing a merge.
private LdapEntry	ldapEntry Ldap entry to merge.
private java.lang.String[]	searchAttrs Attribute names to include in the search.

Constructor Summary

Constructors

Constructor and Description
MergeRequest() Default constructor.
MergeRequest(LdapEntry entry) Creates a new merge request.
MergeRequest(LdapEntry entry, boolean delete) Creates a new merge request.

Method Summary

Modifier and Type	Method and Description
boolean	getDeleteEntry() Returns whether to delete the entry.
LdapEntry	getEntry() Returns the ldap entry to merge.
java.lang.String[]	getExcludeAttributes() Returns the names of attributes that are excluded when performing a modify.
java.lang.String[]	getIncludeAttributes() Returns the names of attributes that are included when performing a modify.
java.lang.String[]	getSearchAttributes() Returns the names of attributes that are used when searching for the entry.
void	setDeleteEntry(boolean b) Sets whether to delete the entry.
void	setEntry(LdapEntry entry) Sets the ldap entry to merge into the LDAP.
void	setExcludeAttributes(java.lang.String... attrs) Sets the list of attribute names to exclude when performing a modify.
void	setIncludeAttributes(java.lang.String... attrs) Sets the list of attribute names to include when performing modify.
void	setSearchAttributes(java.lang.String... attrs) Sets the list of attribute names that are used when searching for the entry.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

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

Field Detail

ldapEntry

private LdapEntry ldapEntry

Ldap entry to merge.

deleteEntry

private boolean deleteEntry

Whether to delete the entry.

searchAttrs

private java.lang.String[] searchAttrs

Attribute names to include in the search.

includeAttrs

private java.lang.String[] includeAttrs

Attribute names to include when performing a merge.

excludeAttrs

private java.lang.String[] excludeAttrs

Attribute names to exclude when performing a merge.

Constructor Detail

MergeRequest

public MergeRequest()

Default constructor.

MergeRequest

public MergeRequest(LdapEntry entry)

Creates a new merge request.

Parameters:

entry - to merge into the LDAP

MergeRequest

public MergeRequest(LdapEntry entry,
                    boolean delete)

Creates a new merge request.

Parameters:

entry - to merge into the LDAP

delete - whether the supplied entry should be deleted

Method Detail

getEntry

public LdapEntry getEntry()

Returns the ldap entry to merge.

Returns:

ldap entry to merge

setEntry

public void setEntry(LdapEntry entry)

Sets the ldap entry to merge into the LDAP.

Parameters:

entry - to merge

getDeleteEntry

public boolean getDeleteEntry()

Returns whether to delete the entry.

Returns:

whether to delete the entry

setDeleteEntry

public void setDeleteEntry(boolean b)

Sets whether to delete the entry.

Parameters:

b - whether to delete the entry

getSearchAttributes

public java.lang.String[] getSearchAttributes()

Returns the names of attributes that are used when searching for the entry.

Returns:

attribute names to return when searching

setSearchAttributes

public void setSearchAttributes(java.lang.String... attrs)

Sets the list of attribute names that are used when searching for the entry.

Parameters:

attrs - names to return when searching

getIncludeAttributes

public java.lang.String[] getIncludeAttributes()

Returns the names of attributes that are included when performing a modify.

Returns:

attribute names to include

setIncludeAttributes

public void setIncludeAttributes(java.lang.String... attrs)

Sets the list of attribute names to include when performing modify.

Parameters:

attrs - names to include

getExcludeAttributes

public java.lang.String[] getExcludeAttributes()

Returns the names of attributes that are excluded when performing a modify.

Returns:

attribute names to exclude

setExcludeAttributes

public void setExcludeAttributes(java.lang.String... attrs)

Sets the list of attribute names to exclude when performing a modify.

Parameters:

attrs - names to exclude

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object