org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulShutdown

Class GracefulShutdownFactory

java.lang.Object

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

org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulShutdown.GracefulShutdownFactory

All Implemented Interfaces:

ExtendedOperationFactory

public class GracefulShutdownFactory
extends AbstractExtendedOperationFactory

An ExtendedOperationFactory for creating cancel extended request response pairs.

Author:

Apache Directory Project

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
String	getOid() Gets the OID of the extended requests this factory generates.
GracefulShutdownRequest	newRequest() Returns a new ExtendedRequest with no value
GracefulShutdownRequest	newRequest(byte[] encodedValue) Returns a new ExtendedRequest with the following encoded value.
GracefulShutdownResponse	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, newResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

GracefulShutdownFactory

public GracefulShutdownFactory(LdapApiService codec)

Creates a new instance of GracefulShutdownFactory.

Parameters:

codec - The codec for this factory.

Method Detail

getOid

public String getOid()

Gets the OID of the extended requests this factory generates.

Specified by:

getOid in interface ExtendedOperationFactory

Overrides:

getOid in class AbstractExtendedOperationFactory

Returns:

the extended request OID

newRequest

public GracefulShutdownRequest newRequest()

Returns a new ExtendedRequest with no value

Returns:

the decorator for the extended request type

newRequest

public GracefulShutdownRequest 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 GracefulShutdownResponse 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