All Known Implementing Classes:

DefaultLdapCodecService, StandaloneLdapApiService
```
public interface LdapApiService
```
The service interface for the LDAP codec. It gathers all the supported controls and extended operations.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_PROTOCOL_CODEC_FACTORY
The default codec factory

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ExtendedRequest`	`fromJndi(ExtendedRequest jndiRequest)`	Creates a model ExtendedResponse from the JNDI ExtendedRequest.
`ExtendedResponse`	`fromJndi(ExtendedResponse jndiResponse)`	Creates a model ExtendedResponse from the JNDI ExtendedResponse.
`Control`	`fromJndiRequestControl(Control jndiControl)`	Creates a model request control from the JNDI request control.
`Control`	`fromJndiResponseControl(Control jndiControl)`	Creates a model response control from the JNDI response control.
`Map<String,ExtendedOperationFactory>`	`getExtendedRequestFactories()`
`Map<String,ExtendedOperationFactory>`	`getExtendedResponseFactories()`
`Map<String,IntermediateOperationFactory>`	`getIntermediateResponseFactories()`
`ProtocolCodecFactory`	`getProtocolCodecFactory()`	Creates a new LDAP `ProtocolCodecFactory`.
`Map<String,ControlFactory<? extends Control>>`	`getRequestControlFactories()`
`Map<String,ControlFactory<? extends Control>>`	`getResponseControlFactories()`
`boolean`	`isControlRegistered(String oid)`	Checks if a control has been registered.
`boolean`	`isExtendedRequestRegistered(String oid)`	Checks to see if an extended request operation is registered.
`boolean`	`isExtendedResponseRegistered(String oid)`	Checks to see if an extended response operation is registered.
`boolean`	`isIntermediateResponseRegistered(String oid)`	Checks to see if an intermediate response is registered.
`Iterator<String>`	`registeredExtendedRequests()`	Returns an Iterator over the OID Strings of registered extended requests.
`Iterator<String>`	`registeredExtendedResponses()`	Returns an Iterator over the OID Strings of registered extended responses.
`Iterator<String>`	`registeredIntermediateResponses()`	Returns an Iterator over the OID Strings of registered intermediate responses.
`Iterator<String>`	`registeredRequestControls()`	Returns an Iterator over the OID Strings of registered request controls.
`Iterator<String>`	`registeredResponseControls()`	Returns an Iterator over the OID Strings of registered response controls.
`ExtendedOperationFactory`	`registerExtendedRequest(ExtendedOperationFactory factory)`	Registers an `ExtendedOperationFactory` for generating extended request response pairs.
`ExtendedOperationFactory`	`registerExtendedResponse(ExtendedOperationFactory factory)`	Registers an `ExtendedOperationFactory` for generating extended response response pairs.
`IntermediateOperationFactory`	`registerIntermediateResponse(IntermediateOperationFactory factory)`	Registers an `IntermediateOperationFactory` for generating intermediate response
`ProtocolCodecFactory`	`registerProtocolCodecFactory(ProtocolCodecFactory factory)`	Registers a ProtocolCodecFactory with this LdapCodecService.
`ControlFactory<?>`	`registerRequestControl(ControlFactory<?> factory)`	Registers an request `ControlFactory` with this service.
`ControlFactory<?>`	`registerResponseControl(ControlFactory<?> factory)`	Registers an response `ControlFactory` with this service.
`ExtendedRequest`	`toJndi(ExtendedRequest modelRequest)`	Creates a JNDI `ExtendedRequest` from the model `ExtendedRequest`.
`ExtendedResponse`	`toJndi(ExtendedResponse modelResponse)`	Creates a JNDI `ExtendedResponse` from the model `ExtendedResponse`.
`Control`	`toJndiControl(Control modelControl)`	Creates a JNDI control from the ldap model's control.
`ExtendedOperationFactory`	`unregisterExtendedRequest(String oid)`	Unregisters an `ExtendedOperationFactory` for generating extended request response pairs.
`ExtendedOperationFactory`	`unregisterExtendedResponse(String oid)`	Unregisters an `ExtendedOperationFactory` for generating extended responses.
`IntermediateOperationFactory`	`unregisterIntermediateResponse(String oid)`	Unregisters an `IntermediateOperationFactory` for generating intermediate response
`ControlFactory<?>`	`unregisterRequestControl(String oid)`	Unregisters a request `ControlFactory` with this service.
`ControlFactory<?>`	`unregisterResponseControl(String oid)`	Unregisters a response `ControlFactory` with this service.

- Field Detail
  - DEFAULT_PROTOCOL_CODEC_FACTORY
```
static final String DEFAULT_PROTOCOL_CODEC_FACTORY
```
    The default codec factory
    
    See Also:
    
    Constant Field Values
- Method Detail
  - registeredRequestControls
```
Iterator<String> registeredRequestControls()
```
    Returns an Iterator over the OID Strings of registered request controls.
    
    Returns:
    
    The registered control OID Strings
  - registeredResponseControls
```
Iterator<String> registeredResponseControls()
```
    Returns an Iterator over the OID Strings of registered response controls.
    
    Returns:
    
    The registered control OID Strings
  - isControlRegistered
```
boolean isControlRegistered(String oid)
```
    Checks if a control has been registered. It will check in both the request and response control maps.
    
    Parameters:
    
    oid - The Control OID we are looking for
    
    Returns:
    
    The OID of the control to check for registration
  - registerRequestControl
```
ControlFactory<?> registerRequestControl(ControlFactory<?> factory)
```
    Registers an request ControlFactory with this service.
    
    Parameters:
    
    factory - The control factory
    
    Returns:
    
    The registered control factory
  - registerResponseControl
```
ControlFactory<?> registerResponseControl(ControlFactory<?> factory)
```
    Registers an response ControlFactory with this service.
    
    Parameters:
    
    factory - The control factory
    
    Returns:
    
    The registered control factory
  - unregisterRequestControl
```
ControlFactory<?> unregisterRequestControl(String oid)
```
    Unregisters a request ControlFactory with this service.
    
    Parameters:
    
    oid - The oid of the control the factory is associated with.
    
    Returns:
    
    The unregistered control factory
  - unregisterResponseControl
```
ControlFactory<?> unregisterResponseControl(String oid)
```
    Unregisters a response ControlFactory with this service.
    
    Parameters:
    
    oid - The oid of the control the factory is associated with.
    
    Returns:
    
    The unregistered control factory
  - toJndiControl
```
Control toJndiControl(Control modelControl)
               throws EncoderException
```
    Creates a JNDI control from the ldap model's control.
    
    Parameters:
    
    modelControl - The model's control.
    
    Returns:
    
    The JNDI control.
    
    Throws:
    
    EncoderException - if there are problems encoding the modelControl.
  - fromJndiRequestControl
```
Control fromJndiRequestControl(Control jndiControl)
                        throws DecoderException
```
    Creates a model request control from the JNDI request control.
    
    Parameters:
    
    jndiControl - The JNDI control.
    
    Returns:
    
    The model request control.
    
    Throws:
    
    DecoderException - if there are problems decoding the value of the JNDI control.
  - fromJndiResponseControl
```
Control fromJndiResponseControl(Control jndiControl)
                         throws DecoderException
```
    Creates a model response control from the JNDI response control.
    
    Parameters:
    
    jndiControl - The JNDI response control.
    
    Returns:
    
    The model control.
    
    Throws:
    
    DecoderException - if there are problems decoding the value of the JNDI control.
  - getRequestControlFactories
```
Map<String,ControlFactory<? extends Control>> getRequestControlFactories()
```
    Returns:
    
    the request controlFactories
  - getResponseControlFactories
```
Map<String,ControlFactory<? extends Control>> getResponseControlFactories()
```
    Returns:
    
    the response controlFactories
  - registeredExtendedRequests
```
Iterator<String> registeredExtendedRequests()
```
    Returns an Iterator over the OID Strings of registered extended requests.
    
    Returns:
    
    The registered extended request OID Strings
  - registeredExtendedResponses
```
Iterator<String> registeredExtendedResponses()
```
    Returns an Iterator over the OID Strings of registered extended responses.
    
    Returns:
    
    The registered extended response OID Strings
  - registerExtendedRequest
```
ExtendedOperationFactory registerExtendedRequest(ExtendedOperationFactory factory)
```
    Registers an ExtendedOperationFactory for generating extended request response pairs.
    
    Parameters:
    
    factory - The extended request factory
    
    Returns:
    
    The registered factory if one existed for the oid
  - registerExtendedResponse
```
ExtendedOperationFactory registerExtendedResponse(ExtendedOperationFactory factory)
```
    Registers an ExtendedOperationFactory for generating extended response response pairs.
    
    Parameters:
    
    factory - The extended response factory
    
    Returns:
    
    The registered factory if one existed for the oid
  - unregisterExtendedRequest
```
ExtendedOperationFactory unregisterExtendedRequest(String oid)
```
    Unregisters an ExtendedOperationFactory for generating extended request response pairs.
    
    Parameters:
    
    oid - The extended request oid
    
    Returns:
    
    The registered factory if one existed for the oid
  - unregisterExtendedResponse
```
ExtendedOperationFactory unregisterExtendedResponse(String oid)
```
    Unregisters an ExtendedOperationFactory for generating extended responses.
    
    Parameters:
    
    oid - The extended response oid
    
    Returns:
    
    The registered factory if one existed for the oid
  - isExtendedRequestRegistered
```
boolean isExtendedRequestRegistered(String oid)
```
    Checks to see if an extended request operation is registered.
    
    Parameters:
    
    oid - The object identifier for the extended request operation
    
    Returns:
    
    true if registered, false if not
  - isExtendedResponseRegistered
```
boolean isExtendedResponseRegistered(String oid)
```
    Checks to see if an extended response operation is registered.
    
    Parameters:
    
    oid - The object identifier for the extended response operation
    
    Returns:
    
    true if registered, false if not
  - getExtendedRequestFactories
```
Map<String,ExtendedOperationFactory> getExtendedRequestFactories()
```
    Returns:
    
    the extendedRequestFactories
  - getExtendedResponseFactories
```
Map<String,ExtendedOperationFactory> getExtendedResponseFactories()
```
    Returns:
    
    the extendedResponseFactories
  - registeredIntermediateResponses
```
Iterator<String> registeredIntermediateResponses()
```
    Returns an Iterator over the OID Strings of registered intermediate responses.
    
    Returns:
    
    The registered Intermediate response OID Strings
  - registerIntermediateResponse
```
IntermediateOperationFactory registerIntermediateResponse(IntermediateOperationFactory factory)
```
    Registers an IntermediateOperationFactory for generating intermediate response
    
    Parameters:
    
    factory - The intermediate response factory
    
    Returns:
    
    The displaced factory if one existed for the oid
  - unregisterIntermediateResponse
```
IntermediateOperationFactory unregisterIntermediateResponse(String oid)
```
    Unregisters an IntermediateOperationFactory for generating intermediate response
    
    Parameters:
    
    oid - The intermediate response oid
    
    Returns:
    
    The displaced factory if one existed for the oid
  - isIntermediateResponseRegistered
```
boolean isIntermediateResponseRegistered(String oid)
```
    Checks to see if an intermediate response is registered.
    
    Parameters:
    
    oid - The object identifier for the intermediate response
    
    Returns:
    
    true if registered, false if not
  - getIntermediateResponseFactories
```
Map<String,IntermediateOperationFactory> getIntermediateResponseFactories()
```
    Returns:
    
    the intermediateResponseFactories
  - fromJndi
```
ExtendedResponse fromJndi(ExtendedResponse jndiResponse)
                   throws DecoderException
```
    Creates a model ExtendedResponse from the JNDI ExtendedResponse.
    
    Parameters:
    
    jndiResponse - The JNDI ExtendedResponse
    
    Returns:
    
    The model ExtendedResponse
    
    Throws:
    
    DecoderException - if the response value cannot be decoded.
  - toJndi
```
ExtendedResponse toJndi(ExtendedResponse modelResponse)
                 throws EncoderException
```
    Creates a JNDI ExtendedResponse from the model ExtendedResponse.
    
    Parameters:
    
    modelResponse - The extended response to convert
    
    Returns:
    
    A JNDI extended response
    
    Throws:
    
    EncoderException - If the conversion failed
  - fromJndi
```
ExtendedRequest fromJndi(ExtendedRequest jndiRequest)
                  throws DecoderException
```
    Creates a model ExtendedResponse from the JNDI ExtendedRequest.
    
    Parameters:
    
    jndiRequest - The JNDI ExtendedRequest
    
    Returns:
    
    The model ExtendedRequest
    
    Throws:
    
    DecoderException - if the request value cannot be decoded.
  - toJndi
```
ExtendedRequest toJndi(ExtendedRequest modelRequest)
                throws EncoderException
```
    Creates a JNDI ExtendedRequest from the model ExtendedRequest.
    
    Parameters:
    
    modelRequest - The extended request to convert
    
    Returns:
    
    A JNDI extended request
    
    Throws:
    
    EncoderException - If the conversion failed
  - getProtocolCodecFactory
```
ProtocolCodecFactory getProtocolCodecFactory()
```
    Creates a new LDAP ProtocolCodecFactory.
    
    Returns:
    
    the ProtocolCodecFactory
  - registerProtocolCodecFactory
```
ProtocolCodecFactory registerProtocolCodecFactory(ProtocolCodecFactory factory)
```
    Registers a ProtocolCodecFactory with this LdapCodecService.
    
    Parameters:
    
    factory - The factory being registered.
    
    Returns:
    
    The previously set ProtocolCodecFactory, or null if none had been set earlier.

Interface LdapApiService

Field Summary

Method Summary

Field Detail

DEFAULT_PROTOCOL_CODEC_FACTORY

Method Detail

registeredRequestControls

registeredResponseControls

isControlRegistered

registerRequestControl

registerResponseControl

unregisterRequestControl

unregisterResponseControl

toJndiControl

fromJndiRequestControl

fromJndiResponseControl

getRequestControlFactories

getResponseControlFactories

registeredExtendedRequests

registeredExtendedResponses

registerExtendedRequest

registerExtendedResponse

unregisterExtendedRequest

unregisterExtendedResponse

isExtendedRequestRegistered

isExtendedResponseRegistered

getExtendedRequestFactories

getExtendedResponseFactories

registeredIntermediateResponses

registerIntermediateResponse

unregisterIntermediateResponse

isIntermediateResponseRegistered

getIntermediateResponseFactories

fromJndi

toJndi

fromJndi

toJndi

getProtocolCodecFactory

registerProtocolCodecFactory