org.apache.directory.api.ldap.codec.api

Class ControlDecorator<E extends Control>

java.lang.Object

org.apache.directory.api.ldap.codec.api.ControlDecorator<E>

Type Parameters:

E -

All Implemented Interfaces:

Asn1Object, CodecControl<E>, Decorator<E>, Control

Direct Known Subclasses:

AdDirSyncDecorator, AdShowDeletedDecorator, BasicControlDecorator, CascadeDecorator, EntryChangeDecorator, ManageDsaITDecorator, PagedResultsDecorator, PasswordPolicyDecorator, PersistentSearchDecorator, ProxiedAuthzDecorator, SortRequestDecorator, SortResponseDecorator, SubentriesDecorator, SyncDoneValueDecorator, SyncInfoValueDecorator, SyncRequestValueDecorator, SyncStateValueDecorator, VirtualListViewRequestDecorator, VirtualListViewResponseDecorator

public abstract class ControlDecorator<E extends Control>
extends java.lang.Object
implements CodecControl<E>, Asn1Object

Decorates Control objects by wrapping them, and enabling them as CodecControls so the codec to store transient information associated with the Control in the decorator while processing.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ControlDecorator(LdapApiService codec, E decoratedControl) Creates a ControlDecorator to codec enable it.

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the object length, which is the sum of all inner length.
boolean	equals(java.lang.Object o)
LdapApiService	getCodecService() Gets the codec service responsible for managing the encoding and decoding of the decorated objects.
E	getDecorated() Gets the object being decorated by this IDecorator.
java.lang.String	getOid() Get the OID
byte[]	getValue() Get the control value
int	hashCode()
boolean	hasValue() Checks to see if a value is set for this CodecControl.
boolean	isCritical() Get the criticality
void	setCritical(boolean criticality) Set the criticality
void	setDecorated(E decorated)
void	setValue(byte[] value) Set the encoded control value
java.lang.String	toString() Return a String representing a Control

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.codec.api.CodecControl

decode

Methods inherited from interface org.apache.directory.api.ldap.codec.api.Decorator

encode

Methods inherited from interface org.apache.directory.api.asn1.Asn1Object

encode

Field Detail

decorated

private E extends Control decorated

The decorated Control

valueLength

protected int valueLength

The encoded value length

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

ControlDecorator

public ControlDecorator(LdapApiService codec,
                        E decoratedControl)

Creates a ControlDecorator to codec enable it.

Parameters:

decoratedControl - The Control to decorate.

Method Detail

getDecorated

public E getDecorated()

Gets the object being decorated by this IDecorator.

Specified by:

getDecorated in interface Decorator<E extends Control>

Returns:

The decorated object

setDecorated

public void setDecorated(E decorated)

getCodecService

public LdapApiService getCodecService()

Gets the codec service responsible for managing the encoding and decoding of the decorated objects.

Specified by:

getCodecService in interface Decorator<E extends Control>

Returns:

the codec service

getOid

public java.lang.String getOid()

Get the OID

Specified by:

getOid in interface Control

Returns:

A string which represent the control oid

hasValue

public boolean hasValue()

Checks to see if a value is set for this CodecControl.

Specified by:

hasValue in interface CodecControl<E extends Control>

Returns:

true, if this control has a value, false otherwise

getValue

public byte[] getValue()

Get the control value

Specified by:

getValue in interface CodecControl<E extends Control>

Returns:

The control value

setValue

public void setValue(byte[] value)

Set the encoded control value

Specified by:

setValue in interface CodecControl<E extends Control>

Parameters:

value - The encoded control value to store

isCritical

public boolean isCritical()

Get the criticality

Specified by:

isCritical in interface Control

Returns:

true if the criticality flag is true.

setCritical

public void setCritical(boolean criticality)

Set the criticality

Specified by:

setCritical in interface Control

Parameters:

criticality - The criticality value

computeLength

public int computeLength()

Compute the object length, which is the sum of all inner length.

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in interface Decorator<E extends Control>

Returns:

The object's computed length

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)

toString

public java.lang.String toString()

Return a String representing a Control

Overrides:

toString in class java.lang.Object