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

Class CancelFactory

java.lang.Object

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

org.apache.directory.api.ldap.extras.extended.ads_impl.cancel.CancelFactory

All Implemented Interfaces:

ExtendedOperationFactory

public class CancelFactory
extends AbstractExtendedOperationFactory

An ExtendedOperationFactory for creating cancel extended request response pairs.

Author:

Apache Directory Project

Field Summary

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

codec, LOG, oid

Constructor Summary

Constructors

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

Method Summary

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

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

decodeValue, encodeValue, getOid, newResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelFactory

public CancelFactory(LdapApiService codec)

Creates a new instance of CancelFactory.

Parameters:

codec - The codec for this factory.

Method Detail

newRequest

public CancelRequest newRequest()

Returns a new ExtendedRequest with no value

Returns:

the decorator for the extended request type

newRequest

public CancelRequest 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 CancelResponse newResponse()

Creates a new ExtendedResponse, for the ExtendedRequest with no value

Returns:

The new ExtendedResponse.

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

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