org.opends.server.types

Class Control

java.lang.Object

org.opends.server.types.Control

Direct Known Subclasses:

AccountUsableRequestControl, AccountUsableResponseControl, AuthorizationIdentityResponseControl, ChangeNumberControlPlugin.ChangeNumberControl, EntryChangelogNotificationControl, EntryChangeNotificationControl, ExternalChangelogRequestControl, GetEffectiveRightsRequestControl, LDAPAssertionRequestControl, LDAPControl, LDAPPostReadRequestControl, LDAPPostReadResponseControl, LDAPPreReadRequestControl, LDAPPreReadResponseControl, MatchedValuesControl, PagedResultsControl, PasswordExpiredControl, PasswordExpiringControl, PasswordPolicyRequestControl, PasswordPolicyResponseControl, PersistentSearchControl, ProxiedAuthV1Control, ProxiedAuthV2Control, ReplicationRepairRequestControl, ServerSideSortRequestControl, ServerSideSortResponseControl, SubentriesControl, SubtreeDeleteControl, TransactionIdControl, VLVRequestControl, VLVResponseControl

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=true,
           mayInvoke=true)
public abstract class Control
extends Object

This class defines a data structure that holds information about a control that can be included in a request or response.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Control(String oid, boolean isCritical) Creates a new control with no value.

Method Summary

Modifier and Type	Method and Description
String	getOID() Retrieves the OID for this control.
boolean	isCritical() Indicates whether this control should be considered critical in processing the request.
String	toString() Retrieves a string representation of this control.
void	toString(StringBuilder buffer) Appends a string representation of this control to the provided buffer.
void	write(org.forgerock.opendj.io.ASN1Writer writer) Writes this control to an ASN.1 writer.
protected abstract void	writeValue(org.forgerock.opendj.io.ASN1Writer writer) Writes this control's value to an ASN.1 writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Control

protected Control(String oid,
                  boolean isCritical)

Creates a new control with no value.

Parameters:

oid - The OID for this control.

isCritical - Indicates whether this control should be considered critical in processing the request.

Method Detail

getOID

public final String getOID()

Retrieves the OID for this control.

Returns:

The OID for this control.

isCritical

public final boolean isCritical()

Indicates whether this control should be considered critical in processing the request.

Returns:

true if this code should be considered critical, or false if not.

toString

public final String toString()

Retrieves a string representation of this control.

Overrides:

toString in class Object

Returns:

A string representation of this control.

write

public final void write(org.forgerock.opendj.io.ASN1Writer writer)
                 throws IOException

Writes this control to an ASN.1 writer.

Parameters:

writer - The ASN.1 writer to use.

Throws:

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

writeValue

protected abstract void writeValue(org.forgerock.opendj.io.ASN1Writer writer)
                            throws IOException

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

Parameters:

writer - The ASN.1 writer to use.

Throws:

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

toString

public void toString(StringBuilder buffer)

Appends a string representation of this control to the provided buffer.

Parameters:

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