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

Interface Decorator<E>

All Known Subinterfaces:

CodecControl<E>

All Known Implementing Classes:

AbandonableRequestDecorator, AbandonableResultResponseRequestDecorator, AbandonRequestDecorator, AdDirSyncDecorator, AddRequestDecorator, AddResponseDecorator, AdShowDeletedDecorator, BasicControlDecorator, BindRequestDecorator, BindResponseDecorator, CancelRequestDecorator, CancelResponseDecorator, CascadeDecorator, CertGenerationRequestDecorator, CertGenerationResponseDecorator, CompareRequestDecorator, CompareResponseDecorator, ControlDecorator, DeleteRequestDecorator, DeleteResponseDecorator, EntryChangeDecorator, ExtendedRequestDecorator, ExtendedResponseDecorator, GracefulDisconnectResponseDecorator, GracefulShutdownRequestDecorator, GracefulShutdownResponseDecorator, IntermediateResponseDecorator, LdapResultDecorator, ManageDsaITDecorator, MessageDecorator, ModifyDnRequestDecorator, ModifyDnResponseDecorator, ModifyRequestDecorator, ModifyResponseDecorator, PagedResultsDecorator, PasswordModifyRequestDecorator, PasswordModifyResponseDecorator, PasswordPolicyDecorator, PersistentSearchDecorator, ProxiedAuthzDecorator, RequestDecorator, ResponseDecorator, ResultResponseRequestDecorator, SearchRequestDecorator, SearchResultDoneDecorator, SearchResultEntryDecorator, SearchResultReferenceDecorator, SingleReplyRequestDecorator, SortRequestDecorator, SortResponseDecorator, StartTlsRequestDecorator, StartTlsResponseDecorator, StoredProcedureRequestDecorator, StoredProcedureResponseDecorator, SubentriesDecorator, SyncDoneValueDecorator, SyncInfoValueDecorator, SyncRequestValueDecorator, SyncStateValueDecorator, UnbindRequestDecorator, VirtualListViewRequestDecorator, VirtualListViewResponseDecorator, WhoAmIRequestDecorator, WhoAmIResponseDecorator

public interface Decorator<E>

The codec uses this interface to add additional information to LDAP Model objects during encoding and decoding,

Method Summary

Modifier and Type	Method and Description
int	computeLength() Compute the object length, which is the sum of all inner length.
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the object to a PDU.
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.

Method Detail

getDecorated

E getDecorated()

Gets the object being decorated by this IDecorator.

Returns:

The decorated object

computeLength

int computeLength()

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

Returns:

The object's computed length

encode

java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                    throws EncoderException

Encode the object to a PDU.

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - if the buffer can't be encoded

getCodecService

LdapApiService getCodecService()

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

Returns:

the codec service