Package org.apache.directory.api.ldap.codec.osgi

Class DefaultLdapCodecService

java.lang.Object

org.apache.directory.api.ldap.codec.osgi.DefaultLdapCodecService

All Implemented Interfaces:

LdapApiService

Direct Known Subclasses:

StandaloneLdapApiService

public class DefaultLdapCodecService
extends Object
implements LdapApiService

The default LdapApiService implementation.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.api.ldap.codec.api.LdapApiService

DEFAULT_PROTOCOL_CODEC_FACTORY

Constructor Summary

Constructors

Constructor	Description
DefaultLdapCodecService()	Creates a new instance of DefaultLdapCodecService.

Method Summary

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 control)	Creates a model request control from the JNDI request control.
Control	fromJndiResponseControl(Control control)	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 protocolCodecFactory)	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.
void	setExtendedRequestFactories(Map<String,ExtendedOperationFactory> extendedOperationFactories)
void	setExtendedResponseFactories(Map<String,ExtendedOperationFactory> extendedOperationFactories)
void	setIntermediateResponseFactories(Map<String,IntermediateOperationFactory> intermediateResponseFactories)
void	setProtocolCodecFactory(ProtocolCodecFactory protocolCodecFactory)
void	setRequestControlFactories(Map<String,ControlFactory<? extends Control>> requestControlFactories)
void	setResponseControlFactories(Map<String,ControlFactory<? extends Control>> responseControlFactories)
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 control)	Creates a JNDI control from the ldap model's control.
String	toString()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLdapCodecService

public DefaultLdapCodecService()

Creates a new instance of DefaultLdapCodecService.

Method Detail

registerRequestControl

public ControlFactory<?> registerRequestControl(ControlFactory<?> factory)

Registers an request ControlFactory with this service.

Specified by:

registerRequestControl in interface LdapApiService

Parameters:

factory - The control factory

Returns:

The registered control factory

registerResponseControl

public ControlFactory<?> registerResponseControl(ControlFactory<?> factory)

Registers an response ControlFactory with this service.

Specified by:

registerResponseControl in interface LdapApiService

Parameters:

factory - The control factory

Returns:

The registered control factory

unregisterRequestControl

public ControlFactory<?> unregisterRequestControl(String oid)

Unregisters a request ControlFactory with this service.

Specified by:

unregisterRequestControl in interface LdapApiService

Parameters:

oid - The oid of the control the factory is associated with.

Returns:

The unregistered control factory

unregisterResponseControl

public ControlFactory<?> unregisterResponseControl(String oid)

Unregisters a response ControlFactory with this service.

Specified by:

unregisterResponseControl in interface LdapApiService

Parameters:

oid - The oid of the control the factory is associated with.

Returns:

The unregistered control factory

registeredRequestControls

public Iterator<String> registeredRequestControls()

Returns an Iterator over the OID Strings of registered request controls.

Specified by:

registeredRequestControls in interface LdapApiService

Returns:

The registered control OID Strings

registeredResponseControls

public Iterator<String> registeredResponseControls()

Returns an Iterator over the OID Strings of registered response controls.

Specified by:

registeredResponseControls in interface LdapApiService

Returns:

The registered control OID Strings

isControlRegistered

public boolean isControlRegistered(String oid)

Checks if a control has been registered. It will check in both the request and response control maps.

Specified by:

isControlRegistered in interface LdapApiService

Parameters:

oid - The Control OID we are looking for

Returns:

The OID of the control to check for registration

registeredExtendedRequests

public Iterator<String> registeredExtendedRequests()

Returns an Iterator over the OID Strings of registered extended requests.

Specified by:

registeredExtendedRequests in interface LdapApiService

Returns:

The registered extended request OID Strings

registeredExtendedResponses

public Iterator<String> registeredExtendedResponses()

Returns an Iterator over the OID Strings of registered extended responses.

Specified by:

registeredExtendedResponses in interface LdapApiService

Returns:

The registered extended response OID Strings

registerExtendedRequest

public ExtendedOperationFactory registerExtendedRequest(ExtendedOperationFactory factory)

Registers an ExtendedOperationFactory for generating extended request response pairs.

Specified by:

registerExtendedRequest in interface LdapApiService

Parameters:

factory - The extended request factory

Returns:

The registered factory if one existed for the oid

registerExtendedResponse

public ExtendedOperationFactory registerExtendedResponse(ExtendedOperationFactory factory)

Registers an ExtendedOperationFactory for generating extended response response pairs.

Specified by:

registerExtendedResponse in interface LdapApiService

Parameters:

factory - The extended response factory

Returns:

The registered factory if one existed for the oid

registeredIntermediateResponses

public Iterator<String> registeredIntermediateResponses()

Returns an Iterator over the OID Strings of registered intermediate responses.

Specified by:

registeredIntermediateResponses in interface LdapApiService

Returns:

The registered Intermediate response OID Strings

registerIntermediateResponse

public IntermediateOperationFactory registerIntermediateResponse(IntermediateOperationFactory factory)

Registers an IntermediateOperationFactory for generating intermediate response

Specified by:

registerIntermediateResponse in interface LdapApiService

Parameters:

factory - The intermediate response factory

Returns:

The displaced factory if one existed for the oid

getProtocolCodecFactory

public ProtocolCodecFactory getProtocolCodecFactory()

Creates a new LDAP ProtocolCodecFactory.

Specified by:

getProtocolCodecFactory in interface LdapApiService

Returns:

the ProtocolCodecFactory

registerProtocolCodecFactory

public ProtocolCodecFactory registerProtocolCodecFactory(ProtocolCodecFactory protocolCodecFactory)

Registers a ProtocolCodecFactory with this LdapCodecService.

Specified by:

registerProtocolCodecFactory in interface LdapApiService

Parameters:

protocolCodecFactory - The factory being registered.

Returns:

The previously set ProtocolCodecFactory, or null if none had been set earlier.

toJndiControl

public Control toJndiControl(Control control)
                      throws EncoderException

Creates a JNDI control from the ldap model's control.

Specified by:

toJndiControl in interface LdapApiService

Parameters:

control - The model's control.

Returns:

The JNDI control.

Throws:

EncoderException - if there are problems encoding the modelControl.

fromJndiRequestControl

public Control fromJndiRequestControl(Control control)
                               throws DecoderException

Creates a model request control from the JNDI request control.

Specified by:

fromJndiRequestControl in interface LdapApiService

Parameters:

control - The JNDI control.

Returns:

The model request control.

Throws:

DecoderException - if there are problems decoding the value of the JNDI control.

fromJndiResponseControl

public Control fromJndiResponseControl(Control control)
                                throws DecoderException

Creates a model response control from the JNDI response control.

Specified by:

fromJndiResponseControl in interface LdapApiService

Parameters:

control - The JNDI response control.

Returns:

The model control.

Throws:

DecoderException - if there are problems decoding the value of the JNDI control.

unregisterExtendedRequest

public ExtendedOperationFactory unregisterExtendedRequest(String oid)

Unregisters an ExtendedOperationFactory for generating extended request response pairs.

Specified by:

unregisterExtendedRequest in interface LdapApiService

Parameters:

oid - The extended request oid

Returns:

The registered factory if one existed for the oid

unregisterExtendedResponse

public ExtendedOperationFactory unregisterExtendedResponse(String oid)

Unregisters an ExtendedOperationFactory for generating extended responses.

Specified by:

unregisterExtendedResponse in interface LdapApiService

Parameters:

oid - The extended response oid

Returns:

The registered factory if one existed for the oid

unregisterIntermediateResponse

public IntermediateOperationFactory unregisterIntermediateResponse(String oid)

Unregisters an IntermediateOperationFactory for generating intermediate response

Specified by:

unregisterIntermediateResponse in interface LdapApiService

Parameters:

oid - The intermediate response oid

Returns:

The displaced factory if one existed for the oid

toJndi

public ExtendedResponse toJndi(ExtendedResponse modelResponse)
                        throws EncoderException

Creates a JNDI ExtendedResponse from the model ExtendedResponse.

Specified by:

toJndi in interface LdapApiService

Parameters:

modelResponse - The extended response to convert

Returns:

A JNDI extended response

Throws:

EncoderException - If the conversion failed

fromJndi

public ExtendedResponse fromJndi(ExtendedResponse jndiResponse)
                          throws DecoderException

Creates a model ExtendedResponse from the JNDI ExtendedResponse.

Specified by:

fromJndi in interface LdapApiService

Parameters:

jndiResponse - The JNDI ExtendedResponse

Returns:

The model ExtendedResponse

Throws:

DecoderException - if the response value cannot be decoded.

fromJndi

public ExtendedRequest fromJndi(ExtendedRequest jndiRequest)
                         throws DecoderException

Creates a model ExtendedResponse from the JNDI ExtendedRequest.

Specified by:

fromJndi in interface LdapApiService

Parameters:

jndiRequest - The JNDI ExtendedRequest

Returns:

The model ExtendedRequest

Throws:

DecoderException - if the request value cannot be decoded.

toJndi

public ExtendedRequest toJndi(ExtendedRequest modelRequest)
                       throws EncoderException

Creates a JNDI ExtendedRequest from the model ExtendedRequest.

Specified by:

toJndi in interface LdapApiService

Parameters:

modelRequest - The extended request to convert

Returns:

A JNDI extended request

Throws:

EncoderException - If the conversion failed

isExtendedRequestRegistered

public boolean isExtendedRequestRegistered(String oid)

Checks to see if an extended request operation is registered.

Specified by:

isExtendedRequestRegistered in interface LdapApiService

Parameters:

oid - The object identifier for the extended request operation

Returns:

true if registered, false if not

isExtendedResponseRegistered

public boolean isExtendedResponseRegistered(String oid)

Checks to see if an extended response operation is registered.

Specified by:

isExtendedResponseRegistered in interface LdapApiService

Parameters:

oid - The object identifier for the extended response operation

Returns:

true if registered, false if not

isIntermediateResponseRegistered

public boolean isIntermediateResponseRegistered(String oid)

Checks to see if an intermediate response is registered.

Specified by:

isIntermediateResponseRegistered in interface LdapApiService

Parameters:

oid - The object identifier for the intermediate response

Returns:

true if registered, false if not

getRequestControlFactories

public Map<String,ControlFactory<? extends Control>> getRequestControlFactories()

Specified by:

getRequestControlFactories in interface LdapApiService

Returns:

the request controlFactories

getResponseControlFactories

public Map<String,ControlFactory<? extends Control>> getResponseControlFactories()

Specified by:

getResponseControlFactories in interface LdapApiService

Returns:

the response controlFactories

setRequestControlFactories

public void setRequestControlFactories(Map<String,ControlFactory<? extends Control>> requestControlFactories)

Parameters:

requestControlFactories - the request controlFactories to set

setResponseControlFactories

public void setResponseControlFactories(Map<String,ControlFactory<? extends Control>> responseControlFactories)

Parameters:

responseControlFactories - the response controlFactories to set

getExtendedRequestFactories

public Map<String,ExtendedOperationFactory> getExtendedRequestFactories()

Specified by:

getExtendedRequestFactories in interface LdapApiService

Returns:

the extendedRequestFactories

getExtendedResponseFactories

public Map<String,ExtendedOperationFactory> getExtendedResponseFactories()

Specified by:

getExtendedResponseFactories in interface LdapApiService

Returns:

the extendedResponseFactories

getIntermediateResponseFactories

public Map<String,IntermediateOperationFactory> getIntermediateResponseFactories()

Specified by:

getIntermediateResponseFactories in interface LdapApiService

Returns:

the intermediateResponseFactories

setExtendedRequestFactories

public void setExtendedRequestFactories(Map<String,ExtendedOperationFactory> extendedOperationFactories)

Parameters:

extendedOperationFactories - the extendedOperationFactories to set

setExtendedResponseFactories

public void setExtendedResponseFactories(Map<String,ExtendedOperationFactory> extendedOperationFactories)

Parameters:

extendedOperationFactories - the extendedOperationFactories to set

setIntermediateResponseFactories

public void setIntermediateResponseFactories(Map<String,IntermediateOperationFactory> intermediateResponseFactories)

Parameters:

intermediateResponseFactories - the intermediateResponseFactories to set

setProtocolCodecFactory

public void setProtocolCodecFactory(ProtocolCodecFactory protocolCodecFactory)

Parameters:

protocolCodecFactory - the protocolCodecFactory to set

toString

public String toString()

Overrides:

toString in class Object