Package org.ldaptive.control

Class GenericControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.AbstractResponseControl

org.ldaptive.control.GenericControl

All Implemented Interfaces:

Control, RequestControl, ResponseControl, Freezable

public class GenericControl
extends AbstractResponseControl
implements RequestControl

LDAP control defined as:

   Control ::= SEQUENCE {
     controlType             LDAPOID,
     criticality             BOOLEAN DEFAULT FALSE,
     controlValue            OCTET STRING OPTIONAL }
 

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HASH_CODE_SEED	hash code seed.
private byte[]	value	control value.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	Description
GenericControl(String oid, boolean critical, byte[] encoded)	Creates a new generic control.
GenericControl(String oid, boolean critical, DERBuffer encoded)	Creates a new generic control.
GenericControl(String oid, byte[] encoded)	Creates a new generic control.
GenericControl(String oid, DERBuffer encoded)	Creates a new generic control.

Method Summary

Modifier and Type	Method	Description
void	decode(DERBuffer encoded)	Initializes this response control with the supplied BER encoded data.
byte[]	encode()	Provides the BER encoding of this control.
boolean	equals(Object o)
int	hashCode()	Returns the hash code for this object.
boolean	hasValue()	Returns whether the control has a value associated with it.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractResponseControl

assertMutable, freeze, freezeAndAssertMutable, isFrozen

Methods inherited from class org.ldaptive.control.AbstractControl

getCriticality, getOID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.control.Control

getCriticality, getOID

Field Details

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

• Constant Field Values

value

private byte[] value

control value.

Constructor Details

GenericControl

public GenericControl(String oid,
 byte[] encoded)

Creates a new generic control.

Parameters:

oid - control OID

encoded - control value

GenericControl

public GenericControl(String oid,
 DERBuffer encoded)

Creates a new generic control.

Parameters:

oid - control OID

encoded - control value

GenericControl

public GenericControl(String oid,
 boolean critical,
 byte[] encoded)

Creates a new generic control.

Parameters:

oid - control OID

critical - whether this control is critical

encoded - control value

GenericControl

public GenericControl(String oid,
 boolean critical,
 DERBuffer encoded)

Creates a new generic control.

Parameters:

oid - control OID

critical - whether this control is critical

encoded - control value

Method Details

hasValue

public boolean hasValue()

Description copied from interface: RequestControl

Returns whether the control has a value associated with it.

Specified by:

hasValue in interface RequestControl

Returns:

whether the control has a value

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractControl

hashCode

public int hashCode()

Description copied from class: AbstractControl

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractControl

encode

public byte[] encode()

Description copied from interface: RequestControl

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control

decode

public void decode(DERBuffer encoded)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

encoded - BER encoded response control