ExtendedOperationFactory (Apache LDAP API 2.0.0.AM2 API Documentation)

All Known Implementing Classes:

CancelFactory, CertGenerationFactory, EndTransactionFactory, GracefulDisconnectFactory, GracefulShutdownFactory, PasswordModifyFactory, StartTlsFactory, StartTransactionFactory, StoredProcedureFactory, WhoAmIFactory
```
public interface ExtendedOperationFactory
```
The factory interface, defined by the codec API, for creating new requests/responses for extended operations.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`ExtendedResponse`	`newResponse(byte[] encodedValue)`	Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.

- Method Detail
  - getOid
```
String getOid()
```
    Gets the OID of the extended requests this factory generates.
    
    Returns:
    
    the extended request OID
  - newRequest
```
ExtendedRequest newRequest(byte[] value)
```
    Returns a new ExtendedRequestDecorator with the following encoded value.
    
    Parameters:
    
    value - the encoded value
    
    Returns:
    
    the decorator for the extended request type
  - decorate
```
ExtendedRequest decorate(ExtendedRequest modelRequest)
```
    Decorates a non-decorated request.
    
    Parameters:
    
    modelRequest - the non decorated model request
    
    Returns:
    
    the decorated model request
  - newResponse
```
ExtendedResponse newResponse(byte[] encodedValue)
                      throws DecoderException
```
    Creates a new ExtendedResponse, for the ExtendedRequest with a specific encoded value.
    
    Parameters:
    
    encodedValue - The encoded value for the ExtendedResponse instance.
    
    Returns:
    
    The new ExtendedResponse.
    
    Throws:
    
    DecoderException - If we can't decode the response
  - decorate
```
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.
    
    Parameters:
    
    decoratedMessage - the message to be decorated.
    
    Returns:
    
    The decorated message