org.apache.directory.api.dsmlv2

Class DsmlControl<C extends Control>

java.lang.Object

org.apache.directory.api.dsmlv2.DsmlControl<C>

Type Parameters:

C - The decorated Control

All Implemented Interfaces:

DsmlDecorator<C>, Control

public class DsmlControl<C extends Control>
extends java.lang.Object
implements Control, DsmlDecorator<C>

A DSML decorator for a Control.

Field Summary

Fields

Modifier and Type	Field and Description
private LdapApiService	codec The codec service responsible for encoding decoding this object
private C	decorated The decorated Control
protected byte[]	value The encoded value of the control.

Constructor Summary

Constructors

Constructor and Description
DsmlControl(LdapApiService codec, C decorated) Creates a new instance of DsmlControl

Method Summary

Modifier and Type	Method and Description
LdapApiService	getCodecService()
C	getDecorated() Gets the Message this DsmlDecorator decorates.
java.lang.String	getOid()
byte[]	getValue() Gets 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) Sets 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

decorated

private C extends Control decorated

The decorated Control

value

protected byte[] value

The encoded value of the control.

codec

private LdapApiService codec

The codec service responsible for encoding decoding this object

Constructor Detail

DsmlControl

public DsmlControl(LdapApiService codec,
                   C decorated)

Creates a new instance of DsmlControl

Parameters:

codec - The Codec used to encode/decode the Control

decorated - The decorated control

Method Detail

getCodecService

public LdapApiService getCodecService()

Returns:

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

Gets the control value

Returns:

The control value

setValue

public void setValue(byte[] value)

Sets the encoded control value

Parameters:

value - The encoded control value to store

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 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<C extends Control>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getDecorated

public C getDecorated()

Gets the Message this DsmlDecorator decorates.

Specified by:

getDecorated in interface DsmlDecorator<C extends Control>

Returns:

The decorated Message instance