Package org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI

Class WhoAmIFactory

java.lang.Object

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

org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIFactory

All Implemented Interfaces:

ExtendedOperationFactory

public class WhoAmIFactory
extends AbstractExtendedOperationFactory

An ExtendedOperationFactory for creating WhoAmI extended request response pairs.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.api.AbstractExtendedOperationFactory

codec, oid

Constructor Summary

Constructors

Constructor	Description
WhoAmIFactory(LdapApiService codec)	Creates a new instance of WhoAmIFactory.

Method Summary

Modifier and Type	Method	Description
static WhoAmIResponse	decode(WhoAmIResponse whoAmIResponse, byte[] data)	Decode a PDU which must contain a WhoAmIResponse extended operation.
void	decodeValue(ExtendedResponse extendedResponse, byte[] responseValue)	Decode the value part of the extended response operation.
void	encodeValue(Asn1Buffer buffer, ExtendedResponse extendedResponse)	Encode the value part of the extended response operation.
WhoAmIRequest	newRequest()	Returns a new ExtendedRequest with no value
WhoAmIRequest	newRequest(byte[] value)	Returns a new ExtendedRequest with the following encoded value.
WhoAmIResponse	newResponse()	Creates a new ExtendedResponse, for the ExtendedRequest with no value
WhoAmIResponse	newResponse(byte[] value)	Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.

Methods inherited from class org.apache.directory.api.ldap.codec.api.AbstractExtendedOperationFactory

decodeValue, encodeValue, getOid

Methods inherited from class java.lang.Object

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

Constructor Detail

WhoAmIFactory

public WhoAmIFactory(LdapApiService codec)

Creates a new instance of WhoAmIFactory.

Parameters:

codec - The codec for this factory.

Method Detail

newRequest

public WhoAmIRequest newRequest()

Returns a new ExtendedRequest with no value

Returns:

the decorator for the extended request type

newRequest

public WhoAmIRequest newRequest(byte[] value)
                         throws DecoderException

Returns a new ExtendedRequest with the following encoded value.

Specified by:

newRequest in interface ExtendedOperationFactory

Overrides:

newRequest in class AbstractExtendedOperationFactory

Parameters:

value - the encoded value

Returns:

the decorator for the extended request type

Throws:

DecoderException - If we can't decode the response

newResponse

public WhoAmIResponse newResponse()
                           throws DecoderException

Creates a new ExtendedResponse, for the ExtendedRequest with no value

Returns:

The new ExtendedResponse.

Throws:

DecoderException - If the response cannot be decoded

newResponse

public WhoAmIResponse newResponse(byte[] value)
                           throws DecoderException

Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.

Specified by:

newResponse in interface ExtendedOperationFactory

Overrides:

newResponse in class AbstractExtendedOperationFactory

Parameters:

value - The encoded value for the ExtendedResponse instance.

Returns:

The new ExtendedResponse.

Throws:

DecoderException - If we can't decode the response

encodeValue

public void encodeValue(Asn1Buffer buffer,
                        ExtendedResponse extendedResponse)

Encode the value part of the extended response operation.

Specified by:

encodeValue in interface ExtendedOperationFactory

Overrides:

encodeValue in class AbstractExtendedOperationFactory

Parameters:

buffer - The buffer into which to put the encoded value

extendedResponse - The ExtendedResponse Operation to encode

decode

public static WhoAmIResponse decode(WhoAmIResponse whoAmIResponse,
                                    byte[] data)
                             throws DecoderException

Decode a PDU which must contain a WhoAmIResponse extended operation. Note that the stream of bytes much contain a full PDU, not a partial one.

Parameters:

whoAmIResponse - The WhoAmI extended response that will be feed

data - The bytes to be decoded

Returns:

a WhoAmIRequest object

Throws:

DecoderException - If the decoding failed

decodeValue

public void decodeValue(ExtendedResponse extendedResponse,
                        byte[] responseValue)
                 throws DecoderException

Decode the value part of the extended response operation.

Specified by:

decodeValue in interface ExtendedOperationFactory

Overrides:

decodeValue in class AbstractExtendedOperationFactory

Parameters:

extendedResponse - The ExtendedResponse Operation to feed

responseValue - The response value to decode

Throws:

DecoderException - If the value cannot be decoded