org.apache.directory.api.ldap.extras.extended.ads_impl.storedProcedure
Class StoredProcedureFactory

java.lang.Object
  org.apache.directory.api.ldap.extras.extended.ads_impl.storedProcedure.StoredProcedureFactory

All Implemented Interfaces:

ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

public class StoredProcedureFactory
extends Object
implements ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

An ExtendedRequestFactory for creating cancel extended request response pairs.

Author:

Apache Directory Project

Constructor Summary

StoredProcedureFactory(LdapApiService codec)
Creates a new instance of StoredProcedureFactory.

Method Summary

ExtendedRequestDecorator<StoredProcedureRequest,StoredProcedureResponse>	decorate(ExtendedRequest<?> modelRequest) Decorates a non-decorated request.
ExtendedResponseDecorator<StoredProcedureResponse>	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.
StoredProcedureRequest	newRequest()
StoredProcedureRequest	newRequest(byte[] value) Returns a new ExtendedRequestDecorator with the following encoded value.
StoredProcedureResponse	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

StoredProcedureFactory

public StoredProcedureFactory(LdapApiService codec)

Creates a new instance of StoredProcedureFactory.

Parameters:

codec -

Method Detail

getOid

public String getOid()

Gets the OID of the extended requests this factory generates.

Specified by:

getOid in interface ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

Returns:

the extended request OID

newRequest

public StoredProcedureRequest newRequest()

Specified by:

newRequest in interface ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

Returns:

A new instance of the ExtendedRequestDecorator.

newResponse

public StoredProcedureResponse newResponse(byte[] encodedValue)
                                    throws DecoderException

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

Specified by:

newResponse in interface ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

Parameters:

encodedValue - The encoded value for the ExtendedResponse instance.

Returns:

The new ExtendedResponse.

Throws:

DecoderException

newRequest

public StoredProcedureRequest newRequest(byte[] value)

Returns a new ExtendedRequestDecorator with the following encoded value.

Specified by:

newRequest in interface ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

Parameters:

value - the encoded value

Returns:

the decorator for the extended request type

decorate

public ExtendedRequestDecorator<StoredProcedureRequest,StoredProcedureResponse> decorate(ExtendedRequest<?> modelRequest)

Decorates a non-decorated request.

Specified by:

decorate in interface ExtendedRequestFactory<StoredProcedureRequest,StoredProcedureResponse>

Parameters:

modelRequest - the non decorated model request

Returns:

the decorated model request

decorate

public ExtendedResponseDecorator<StoredProcedureResponse> 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<StoredProcedureRequest,StoredProcedureResponse>

Parameters:

decoratedMessage - the message to be decorated.

Returns:

The decorated message