Package org.opends.server.controls

Class SearchBaseDnBackendOnlyControl

java.lang.Object

org.opends.server.controls.SearchBaseDnBackendOnlyControl

All Implemented Interfaces:

Control

public final class SearchBaseDnBackendOnlyControl
extends Object
implements Control

Tell the operation router to not run a search into subordinate backends.

It is meant to be used by the replication code when gathering information for the replicated domain, since subordinate backends are supposed to have the corresponding replication domain configured. This avoids problems when the replica sends newer updates to the replication server, where changes in subordinate backends should not be stored in the changelog of the parent, since the replication code runs WHOLE_SUBTREE searches.

This control is never critical.

Field Summary

Fields

Modifier and Type	Field	Description
static final ControlDecoder<SearchBaseDnBackendOnlyControl>	DECODER	Decoder from bytestring.
static final String	OID	The OID of this control in the ForgeRock OID branch.
static final SearchBaseDnBackendOnlyControl	SEARCH_BASE_DN_BACKEND_ONLY_CONTROL	A singleton for the control.

Constructor Summary

Constructors

Constructor	Description
SearchBaseDnBackendOnlyControl()

Method Summary

Modifier and Type	Method	Description
String	getAlias()	Returns the control "friendly name" alias for the control.
String	getOid()	Returns the numeric OID associated with this control.
ByteString	getValue()	Returns the value, if any, associated with this control.
boolean	hasValue()	Returns true if this control has a value.
boolean	isCritical()	Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

Methods inherited from class java.lang.Object

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

Field Details

OID

public static final String OID

The OID of this control in the ForgeRock OID branch.

See Also:

• Constant Field Values

SEARCH_BASE_DN_BACKEND_ONLY_CONTROL

public static final SearchBaseDnBackendOnlyControl SEARCH_BASE_DN_BACKEND_ONLY_CONTROL

A singleton for the control.

DECODER

public static final ControlDecoder<SearchBaseDnBackendOnlyControl> DECODER

Decoder from bytestring. The control does not specify a value.

Constructor Details

SearchBaseDnBackendOnlyControl

public SearchBaseDnBackendOnlyControl()

Method Details

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

The numeric OID associated with this control.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

getAlias

public String getAlias()

Description copied from interface: Control

Returns the control "friendly name" alias for the control.

Specified by:

getAlias in interface Control

Returns:

"Friendly name" alias for the control.