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

Class LdifControl

java.lang.Object

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, Control

public class LdifControl
extends java.lang.Object
implements Control, java.io.Externalizable

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getOid()
byte[]	getValue()
int	hashCode()
boolean	hasValue()
boolean	isCritical() Tells if the control is critical or not.
void	readExternal(java.io.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)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

oid

private java.lang.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(java.lang.String oid)

Create a new Control

Parameters:

oid - OID of the created control

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOid

public java.lang.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()

setValue

public void setValue(byte[] value)

hasValue

public boolean hasValue()

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)