org.apache.directory.shared.dsmlv2

Class DsmlControl<E extends Control>

java.lang.Object

org.apache.directory.shared.dsmlv2.DsmlControl<E>

All Implemented Interfaces:

DsmlDecorator<E>, Control

public class DsmlControl<E extends Control>
extends Object
implements Control, DsmlDecorator<E>

A DSML decorator for a Control.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	value The encoded value of the control.

Constructor Summary

Constructors

Constructor and Description
DsmlControl(LdapApiService codec, E decorated)

Method Summary

Methods

Modifier and Type	Method and Description
LdapApiService	getCodecService() Gets the LDAP codec service.
E	getDecorated() Gets the Message this DsmlDecorator decorates.
String	getOid()
byte[]	getValue() Get the control value
boolean	hasValue() Checks to see if this DSML control decorator has a value.
boolean	isCritical() Tells if the control is critical or not.
void	setCritical(boolean isCritical) 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) Set the encoded control value
org.dom4j.Element	toDsml(org.dom4j.Element root) Converts the request/reponse to its XML representation in the DSMLv2 format

Methods inherited from class java.lang.Object

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

Field Detail

value

protected byte[] value

The encoded value of the control.

Constructor Detail

DsmlControl

public DsmlControl(LdapApiService codec,
           E decorated)

Method Detail

getCodecService

public LdapApiService getCodecService()

Gets the LDAP codec service.

hasValue

public boolean hasValue()

Checks to see if this DSML control decorator has a value.

Returns:

true if the DSML control has a value, false otherwise.

getValue

public byte[] getValue()

Get the control value

Returns:

The control value

setValue

public void setValue(byte[] value)

Set the encoded control value

Parameters:

value - The encoded control value to store

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 isCritical)

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:

isCritical - true if the control is critical false otherwise.

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)

Converts the request/reponse to its XML representation in the DSMLv2 format

Specified by:

toDsml in interface DsmlDecorator<E extends Control>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getDecorated

public E getDecorated()

Gets the Message this DsmlDecorator decorates.

Specified by:

getDecorated in interface DsmlDecorator<E extends Control>

Returns:

The decorated Message instance