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

Class AbstractControlFactory<C extends Control>

java.lang.Object

org.apache.directory.api.ldap.codec.api.AbstractControlFactory<C>

Type Parameters:

C - The Control type

All Implemented Interfaces:

ControlFactory<C>

Direct Known Subclasses:

AdDirSyncRequestFactory, AdDirSyncResponseFactory, AdPolicyHintsFactory, AdShowDeletedFactory, CascadeFactory, ChangeNotificationsFactory, EntryChangeFactory, ManageDsaITFactory, OpaqueControlFactory, PagedResultsFactory, PasswordExpiredResponseFactory, PasswordPolicyRequestFactory, PasswordPolicyResponseFactory, PermissiveModifyFactory, PersistentSearchFactory, ProxiedAuthzFactory, RelaxControlFactory, SortRequestFactory, SortResponseFactory, SubentriesFactory, SyncDoneValueFactory, SyncRequestValueFactory, SyncStateValueFactory, TransactionSpecificationFactory, TreeDeleteFactory, VirtualListViewRequestFactory, VirtualListViewResponseFactory

public abstract class AbstractControlFactory<C extends Control>
extends Object
implements ControlFactory<C>

A factory that encode the Control value

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method	Description
void	decodeValue(ControlContainer container, Control control, byte[] controlBytes)	Decode a Control's value.
void	decodeValue(Control control, byte[] controlBytes)	Decode a Control's value.
void	encodeValue(Asn1Buffer buffer, Control control)	Encode the value part of the control.
String	getOid()

Methods inherited from class java.lang.Object

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

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

newControl

Method Detail

getOid

public String getOid()

Specified by:

getOid in interface ControlFactory<C extends Control>

Returns:

The OID of the Control this factory creates.

encodeValue

public void encodeValue(Asn1Buffer buffer,
                        Control control)

Encode the value part of the control.

Specified by:

encodeValue in interface ControlFactory<C extends Control>

Parameters:

buffer - The buffer into which to put the encoded value

control - The control to encode

decodeValue

public void decodeValue(Control control,
                        byte[] controlBytes)
                 throws DecoderException

Decode a Control's value. It will feed the Control.

Specified by:

decodeValue in interface ControlFactory<C extends Control>

Parameters:

control - The control to feed

controlBytes - The data to decode

Throws:

DecoderException - If the value can't be decoded

decodeValue

public void decodeValue(ControlContainer container,
                        Control control,
                        byte[] controlBytes)
                 throws DecoderException

Decode a Control's value. It will feed the Control.

Specified by:

decodeValue in interface ControlFactory<C extends Control>

Parameters:

container - The Asn1Container containing the control to feed

control - The control to feed

controlBytes - The data to decode

Throws:

DecoderException - If the value can't be decoded