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

Interface ControlFactory<C extends Control>

Type Parameters:

C - The Control to create

All Known Implementing Classes:

AbstractControlFactory, 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 interface ControlFactory<C extends Control>

Implementors of new codec control extensions must implement a factory using this factory interface, Factory implementations for specific controls are then registered with the codec and used by the codec to encode and decode those controls.

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()
Control	newControl()	Creates and returns a version of the Control.

Method Detail

getOid

String getOid()

Returns:

The OID of the Control this factory creates.

newControl

Control newControl()

Creates and returns a version of the Control.

Returns:

The CodecControl decorated version of the Control.

encodeValue

void encodeValue(Asn1Buffer buffer,
                 Control control)

Encode the value part of the control.

Parameters:

buffer - The buffer into which to put the encoded value

control - The control to encode

decodeValue

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

Decode a Control's value. It will feed the 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

decodeValue

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

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

Parameters:

control - The control to feed

controlBytes - The data to decode

Throws:

DecoderException - If the value can't be decoded