org.apache.directory.api.ldap.model.ldif

Class LdifControl

java.lang.Object

org.apache.directory.api.ldap.model.ldif.LdifControl

All Implemented Interfaces:

Externalizable, Serializable, Control

public class LdifControl
extends Object
implements Control, Externalizable

The LdifControl class stores a control defined for an entry found in a LDIF file.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	criticality The criticality (default value is false)
private String	oid The control type
protected byte[]	value Optional control value

Constructor Summary

Constructors

Constructor and Description
LdifControl() Create a new Control
LdifControl(String oid) Create a new Control

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getOid()
byte[]	getValue() Get back the control value
int	hashCode()
boolean	hasValue()
boolean	isCritical() Tells if the control is critical or not.
void	readExternal(ObjectInput in)
void	setCritical(boolean criticality) Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message.
void	setValue(byte[] value) Store the control value
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

oid

private String oid

The control type

criticality

private boolean criticality

The criticality (default value is false)

value

protected byte[] value

Optional control value

Constructor Detail

LdifControl

public LdifControl()

Create a new Control

LdifControl

public LdifControl(String oid)

Create a new Control

Parameters:

oid - OID of the created control

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getOid

public String getOid()

Specified by:

getOid in interface Control

Returns:

The Control's OID

isCritical

public boolean isCritical()

Tells if the control is critical or not.

Specified by:

isCritical in interface Control

Returns:

true if the control is critical, false otherwise

setCritical

public void setCritical(boolean criticality)

Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message. The default for this value should be false.

Specified by:

setCritical in interface Control

Parameters:

criticality - true if the control is critical false otherwise.

getValue

public byte[] getValue()

Get back the control value

Returns:

The control's value

setValue

public void setValue(byte[] value)

Store the control value

Parameters:

value - The value to store

hasValue

public boolean hasValue()

Returns:

TRUE if the control has a value

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(Object)