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

Interface ControlFactory<C extends Control>

All Known Implementing Classes:

AdDirSyncFactory, AdShowDeletedFactory, CascadeFactory, EntryChangeFactory, ManageDsaITFactory, PagedResultsFactory, PasswordPolicyFactory, PersistentSearchFactory, ProxiedAuthzFactory, SortRequestFactory, SortResponseFactory, SubentriesFactory, SyncDoneValueFactory, SyncInfoValueFactory, SyncRequestValueFactory, SyncStateValueFactory, 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.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
String	getOid()
CodecControl<C>	newCodecControl() Creates and returns a decorated version of the Control.
CodecControl<C>	newCodecControl(C control) Decorates an existing control.

Method Detail

getOid

String getOid()

Returns:

The OID of the Control this factory creates.

newCodecControl

CodecControl<C> newCodecControl()

Creates and returns a decorated version of the Control.

Returns:

The CodecControl decorated version of the Control.

newCodecControl

CodecControl<C> newCodecControl(C control)

Decorates an existing control. Implementors should check to make sure the supplied Control has not already been decorated to prevent needless decorator nesting.

Parameters:

control - The Control to be decorated.

Returns:

The decorator wrapping the Control.