Package org.opends.server.controls

Class SubentriesControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.SubentriesControl

public class SubentriesControl
extends Control

This class implements Subentries Control as defined in RFC 3672. It makes it possible to control the visibility of entries and subentries which are within scope of specific operation.

Field Summary

Fields

Modifier and Type	Field	Description
static ControlDecoder<SubentriesControl>	DECODER	The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor	Description
SubentriesControl(boolean isCritical, boolean visibility)	Creates a new instance of the Subentries Control with the provided information.

Method Summary

Modifier and Type	Method	Description
boolean	getVisibility()	Retrieves the visibility for this Subentries Control.
void	toString(StringBuilder buffer)	Appends a string representation of this Subentries Control to the provided buffer.
protected void	writeValue(ASN1Writer writer)	Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

DECODER

public static final ControlDecoder<SubentriesControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

SubentriesControl

public SubentriesControl(boolean isCritical,
                         boolean visibility)

Creates a new instance of the Subentries Control with the provided information.

Parameters:

isCritical - Indicates whether support for this control should be considered a critical part of the server processing.

visibility - The visibility flag from the control value.

Method Detail

writeValue

protected void writeValue(ASN1Writer writer)
                   throws IOException

Writes this control's value to an ASN.1 writer. The value must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 writer to use.

Throws:

IOException - If a problem occurs while writing to the stream.

getVisibility

public boolean getVisibility()

Retrieves the visibility for this Subentries Control.

Returns:

The visibility for this Subentries Control.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this Subentries Control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.