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

Class EndTransactionFactory

java.lang.Object

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

org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.EndTransactionFactory

All Implemented Interfaces:

ExtendedOperationFactory

public class EndTransactionFactory
extends AbstractExtendedOperationFactory

An ExtendedOperationFactory for creating EndTransaction extended request response pairs.

Author:

Apache Directory Project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	decodeValue(ExtendedRequest extendedRequest, byte[] requestValue)	Decode the value part of the extended request operation.
void	decodeValue(ExtendedResponse extendedResponse, byte[] requestValue)	Decode the value part of the extended response operation.
void	encodeValue(Asn1Buffer buffer, ExtendedRequest extendedRequest)	Encode the value part of the extended request operation.
void	encodeValue(Asn1Buffer buffer, ExtendedResponse extendedResponse)	Encode the value part of the extended response operation.
EndTransactionRequest	newRequest()	Returns a new ExtendedRequest with no value
EndTransactionRequest	newRequest(byte[] encodedValue)	Returns a new ExtendedRequest with the following encoded value.
EndTransactionResponse	newResponse()	Creates a new ExtendedResponse, for the ExtendedRequest with no value
EndTransactionResponse	newResponse(byte[] encodedValue)	Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.

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

getOid

Methods inherited from class java.lang.Object

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

Constructor Detail

EndTransactionFactory

public EndTransactionFactory(LdapApiService codec)

Creates a new instance of EndTransactionFactory.

Parameters:

codec - The codec for this factory.

Method Detail

newRequest

public EndTransactionRequest newRequest()

Returns a new ExtendedRequest with no value

Returns:

the decorator for the extended request type

newRequest

public EndTransactionRequest newRequest(byte[] encodedValue)
                                 throws DecoderException

Returns a new ExtendedRequest with the following encoded value.

Specified by:

newRequest in interface ExtendedOperationFactory

Overrides:

newRequest in class AbstractExtendedOperationFactory

Parameters:

encodedValue - the encoded value

Returns:

the decorator for the extended request type

Throws:

DecoderException - If we can't decode the response

newResponse

public EndTransactionResponse newResponse()

Creates a new ExtendedResponse, for the ExtendedRequest with no value

Returns:

The new ExtendedResponse.

newResponse

public EndTransactionResponse newResponse(byte[] encodedValue)
                                   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:

encodedValue - The encoded value for the ExtendedResponse instance.

Returns:

The new ExtendedResponse.

Throws:

DecoderException - If we can't decode the response

decodeValue

public void decodeValue(ExtendedRequest extendedRequest,
                        byte[] requestValue)
                 throws DecoderException

Decode the value part of the extended request operation.

Specified by:

decodeValue in interface ExtendedOperationFactory

Overrides:

decodeValue in class AbstractExtendedOperationFactory

Parameters:

extendedRequest - The ExtendedRequest Operation to feed

requestValue - The request value to decode

Throws:

DecoderException - If the value cannot be decoded

decodeValue

public void decodeValue(ExtendedResponse extendedResponse,
                        byte[] requestValue)
                 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

requestValue - The response value to decode

Throws:

DecoderException - If the value cannot be decoded

encodeValue

public void encodeValue(Asn1Buffer buffer,
                        ExtendedRequest extendedRequest)

Encode the value part of the extended request operation.

Specified by:

encodeValue in interface ExtendedOperationFactory

Overrides:

encodeValue in class AbstractExtendedOperationFactory

Parameters:

buffer - The buffer into which to put the encoded value

extendedRequest - The ExtendedRequest Operation to encode

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