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

java.lang.Object
  org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulShutdown.GracefulShutdownFactory

All Implemented Interfaces:

ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

public class GracefulShutdownFactory
extends Object
implements ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

An ExtendedRequestFactory for creating cancel extended request response pairs.

Author:

Apache Directory Project

Constructor Summary

GracefulShutdownFactory(LdapApiService codec)

Method Summary

ExtendedRequestDecorator<GracefulShutdownRequest,GracefulShutdownResponse>	decorate(ExtendedRequest<?> modelRequest) Decorates a non-decorated request.
ExtendedResponseDecorator<GracefulShutdownResponse>	decorate(ExtendedResponse decoratedMessage) Decorates an ExtendedResponse which may or may not be of the expected type.
String	getOid() Gets the OID of the extended requests this factory generates.
GracefulShutdownRequest	newRequest()
GracefulShutdownRequest	newRequest(byte[] value) Returns a new ExtendedRequestDecorator with the following encoded value.
GracefulShutdownResponse	newResponse(byte[] encodedValue) Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GracefulShutdownFactory

public GracefulShutdownFactory(LdapApiService codec)

Method Detail

getOid

public String getOid()

Gets the OID of the extended requests this factory generates.

Specified by:

getOid in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Returns:

the extended request OID

newRequest

public GracefulShutdownRequest newRequest()

Specified by:

newRequest in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Returns:

A new instance of the ExtendedRequestDecorator.

newResponse

public GracefulShutdownResponse newResponse(byte[] encodedValue)
                                     throws DecoderException

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

Specified by:

newResponse in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Parameters:

encodedValue - The encoded value for the ExtendedResponse instance.

Returns:

The new ExtendedResponse.

Throws:

DecoderException

newRequest

public GracefulShutdownRequest newRequest(byte[] value)

Returns a new ExtendedRequestDecorator with the following encoded value.

Specified by:

newRequest in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Parameters:

value - the encoded value

Returns:

the decorator for the extended request type

decorate

public ExtendedRequestDecorator<GracefulShutdownRequest,GracefulShutdownResponse> decorate(ExtendedRequest<?> modelRequest)

Decorates a non-decorated request.

Specified by:

decorate in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Parameters:

modelRequest - the non decorated model request

Returns:

the decorated model request

decorate

public ExtendedResponseDecorator<GracefulShutdownResponse> decorate(ExtendedResponse decoratedMessage)

Decorates an ExtendedResponse which may or may not be of the expected type. The factory implementor must check and handle appropriately.

Specified by:

decorate in interface ExtendedRequestFactory<GracefulShutdownRequest,GracefulShutdownResponse>

Parameters:

decoratedMessage - the message to be decorated.

Returns:

The decorated message