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

Class GracefulDisconnectFactory

java.lang.Object

org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect.GracefulDisconnectFactory

All Implemented Interfaces:

ExtendedOperationFactory

public class GracefulDisconnectFactory
extends Object
implements ExtendedOperationFactory

An ExtendedOperationFactory for creating cancel extended request response pairs.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
GracefulDisconnectFactory(LdapApiService codec)

Method Summary

Modifier and Type	Method and Description
ExtendedRequestDecorator<ExtendedRequest>	decorate(ExtendedRequest modelRequest) Decorates a non-decorated request.
ExtendedResponse	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.
ExtendedRequest	newRequest(byte[] value) Returns a new ExtendedRequestDecorator with the following encoded value.
GracefulDisconnectResponse	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

GracefulDisconnectFactory

public GracefulDisconnectFactory(LdapApiService codec)

Method Detail

decorate

public ExtendedRequestDecorator<ExtendedRequest> decorate(ExtendedRequest modelRequest)

Decorates a non-decorated request.

Specified by:

decorate in interface ExtendedOperationFactory

Parameters:

modelRequest - the non decorated model request

Returns:

the decorated model request

decorate

public ExtendedResponse 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 ExtendedOperationFactory

Parameters:

decoratedMessage - the message to be decorated.

Returns:

The decorated message

getOid

public String getOid()

Gets the OID of the extended requests this factory generates.

Specified by:

getOid in interface ExtendedOperationFactory

Returns:

the extended request OID

newRequest

public ExtendedRequest newRequest(byte[] value)

Returns a new ExtendedRequestDecorator with the following encoded value.

Specified by:

newRequest in interface ExtendedOperationFactory

Parameters:

value - the encoded value

Returns:

the decorator for the extended request type

newResponse

public GracefulDisconnectResponse newResponse(byte[] encodedValue)
                                       throws DecoderException

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

Specified by:

newResponse in interface ExtendedOperationFactory

Parameters:

encodedValue - The encoded value for the ExtendedResponse instance.

Returns:

The new ExtendedResponse.

Throws:

DecoderException