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 java.lang.Object
implements LdapApiService

The default LdapApiService implementation.

Version:

$Rev$, $Date$

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,ControlFactory<? extends Control>>	controlFactories The map of registered ControlFactory's
private java.util.Map<java.lang.String,ExtendedOperationFactory>	extendedOperationsFactories The map of registered ExtendedOperationFactory's by request OID
private static org.slf4j.Logger	LOG A logger
private org.apache.mina.filter.codec.ProtocolCodecFactory	protocolCodecFactory The registered ProtocolCodecFactory

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

DEFAULT_PROTOCOL_CODEC_FACTORY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ExtendedRequestDecorator<?>	decorate(ExtendedRequest decoratedMessage)
ExtendedResponseDecorator<?>	decorate(ExtendedResponse decoratedMessage)
ExtendedRequest	fromJndi(javax.naming.ldap.ExtendedRequest jndiRequest) Creates a model ExtendedResponse from the JNDI ExtendedResponse.
ExtendedResponse	fromJndi(javax.naming.ldap.ExtendedResponse jndiResponse) Creates a model ExtendedResponse from the JNDI ExtendedResponse.
Control	fromJndiControl(javax.naming.ldap.Control control) Creates a model control from the JNDI control.
java.util.Map<java.lang.String,ControlFactory<? extends Control>>	getControlFactories()
java.util.Map<java.lang.String,ExtendedOperationFactory>	getExtendedOperationsFactories()
org.apache.mina.filter.codec.ProtocolCodecFactory	getProtocolCodecFactory() Creates a new LDAP ProtocolCodecFactory.
boolean	isControlRegistered(java.lang.String oid) Checks if a control has been registered.
boolean	isExtendedOperationRegistered(java.lang.String oid) Checks to see if an extended operation, either a standard request response, pair or just an unsolicited response is registered.
private void	loadStockControls() Loads the Controls implement out of the box in the codec.
CodecControl<? extends Control>	newControl(Control control) Creates a new codec control decorator for the provided control.
CodecControl<? extends Control>	newControl(java.lang.String oid) Creates a new codec control decorator of the specified type.
ExtendedRequest	newExtendedRequest(java.lang.String oid, byte[] value) Creates a new ExtendedRequest instance.
<E extends ExtendedResponse> E	newExtendedResponse(java.lang.String responseName, int messageId, byte[] serializedResponse) Create an instance of a ExtendedResponse, knowing its OID.
Asn1Container	newMessageContainer() Creates a new MessageContainer.
ControlFactory<?>	registerControl(ControlFactory<?> factory) Registers an ControlFactory with this service.
java.util.Iterator<java.lang.String>	registeredControls() Returns an Iterator over the OID Strings of registered controls.
java.util.Iterator<java.lang.String>	registeredExtendedRequests() Returns an Iterator over the OID Strings of registered extended requests.
ExtendedOperationFactory	registerExtendedRequest(ExtendedOperationFactory factory) Registers an ExtendedOperationFactory for generating extended request response pairs.
org.apache.mina.filter.codec.ProtocolCodecFactory	registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory) Registers a ProtocolCodecFactory with this LdapCodecService.
void	setControlFactories(java.util.Map<java.lang.String,ControlFactory<? extends Control>> controlFactories)
void	setExtendedOperationsFactories(java.util.Map<java.lang.String,ExtendedOperationFactory> extendedOperationsFactories)
void	setProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)
javax.naming.ldap.ExtendedRequest	toJndi(ExtendedRequest modelRequest) Creates a JNDI ExtendedResponse from the model ExtendedResponse.
javax.naming.ldap.ExtendedResponse	toJndi(ExtendedResponse modelResponse) Creates a JNDI ExtendedResponse from the model ExtendedResponse.
javax.naming.ldap.Control	toJndiControl(Control control) Creates a JNDI control from the ldap model's control.
ControlFactory<?>	unregisterControl(java.lang.String oid) Unregisters an ControlFactory with this service.
ExtendedOperationFactory	unregisterExtendedRequest(java.lang.String oid) Unregisters an ExtendedOperationFactory for generating extended request response pairs.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

A logger

controlFactories

private java.util.Map<java.lang.String,ControlFactory<? extends Control>> controlFactories

The map of registered ControlFactory's

extendedOperationsFactories

private java.util.Map<java.lang.String,ExtendedOperationFactory> extendedOperationsFactories

The map of registered ExtendedOperationFactory's by request OID

protocolCodecFactory

private org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory

The registered ProtocolCodecFactory

Constructor Detail

DefaultLdapCodecService

public DefaultLdapCodecService()

Creates a new instance of DefaultLdapCodecService.

Method Detail

loadStockControls

private void loadStockControls()

Loads the Controls implement out of the box in the codec.

registerControl

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

Registers an ControlFactory with this service.

Specified by:

registerControl in interface LdapApiService

Parameters:

factory - The control factory

unregisterControl

public ControlFactory<?> unregisterControl(java.lang.String oid)

Unregisters an ControlFactory with this service.

Specified by:

unregisterControl in interface LdapApiService

Parameters:

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

registeredControls

public java.util.Iterator<java.lang.String> registeredControls()

Returns an Iterator over the OID Strings of registered controls.

Specified by:

registeredControls in interface LdapApiService

Returns:

The registered control OID Strings

isControlRegistered

public boolean isControlRegistered(java.lang.String oid)

Checks if a control has been registered.

Specified by:

isControlRegistered in interface LdapApiService

Returns:

The OID of the control to check for registration

registeredExtendedRequests

public java.util.Iterator<java.lang.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

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 displaced factory if one existed for the oid

getProtocolCodecFactory

public org.apache.mina.filter.codec.ProtocolCodecFactory getProtocolCodecFactory()

Creates a new LDAP ProtocolCodecFactory.

Specified by:

getProtocolCodecFactory in interface LdapApiService

Returns:

the ProtocolCodecFactory

registerProtocolCodecFactory

public org.apache.mina.filter.codec.ProtocolCodecFactory registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)

Description copied from interface: LdapApiService

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.

newControl

public CodecControl<? extends Control> newControl(java.lang.String oid)

Creates a new codec control decorator of the specified type.

Specified by:

newControl in interface LdapApiService

Parameters:

oid - The OID of the new control to create.

Returns:

The newly created codec control.

newControl

public CodecControl<? extends Control> newControl(Control control)

Creates a new codec control decorator for the provided control.

Specified by:

newControl in interface LdapApiService

Parameters:

control - The control the codec control is generated for.

Returns:

The newly created codec control.

toJndiControl

public javax.naming.ldap.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.

fromJndiControl

public Control fromJndiControl(javax.naming.ldap.Control control)
                        throws DecoderException

Creates a model control from the JNDI control.

Specified by:

fromJndiControl in interface LdapApiService

Parameters:

control - The JNDI control.

Returns:

The model control.

Throws:

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

newMessageContainer

public Asn1Container newMessageContainer()

Creates a new MessageContainer.

Specified by:

newMessageContainer in interface LdapApiService

Returns:

The newly created LDAP MessageContainer instance.

unregisterExtendedRequest

public ExtendedOperationFactory unregisterExtendedRequest(java.lang.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 displaced factory if one existed for the oid

toJndi

public javax.naming.ldap.ExtendedResponse toJndi(ExtendedResponse modelResponse)
                                          throws EncoderException

Creates a JNDI ExtendedResponse from the model ExtendedResponse.

Specified by:

toJndi in interface LdapApiService

Returns:

Throws:

EncoderException

fromJndi

public ExtendedResponse fromJndi(javax.naming.ldap.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(javax.naming.ldap.ExtendedRequest jndiRequest)
                         throws DecoderException

Creates a model ExtendedResponse from the JNDI ExtendedResponse.

Specified by:

fromJndi in interface LdapApiService

Returns:

The model ExtendedResponse

Throws:

DecoderException - if the response value cannot be decoded.

toJndi

public javax.naming.ldap.ExtendedRequest toJndi(ExtendedRequest modelRequest)
                                         throws EncoderException

Creates a JNDI ExtendedResponse from the model ExtendedResponse.

Specified by:

toJndi in interface LdapApiService

Returns:

Throws:

EncoderException

newExtendedResponse

public <E extends ExtendedResponse> E newExtendedResponse(java.lang.String responseName,
                                                          int messageId,
                                                          byte[] serializedResponse)
                                                   throws DecoderException

Create an instance of a ExtendedResponse, knowing its OID. Inject the payload into it.

Specified by:

newExtendedResponse in interface LdapApiService

Parameters:

responseName - The extendedRespose OID

messageId - The original message ID

serializedResponse - The serialized response payload

Returns:

The extendedResponse instance

Throws:

DecoderException

newExtendedRequest

public ExtendedRequest newExtendedRequest(java.lang.String oid,
                                          byte[] value)

Creates a new ExtendedRequest instance.

Specified by:

newExtendedRequest in interface LdapApiService

Parameters:

oid - the extended request's object identifier

value - the encoded value of the extended request

Returns:

The new extended request

decorate

public ExtendedRequestDecorator<?> decorate(ExtendedRequest decoratedMessage)

Specified by:

decorate in interface LdapApiService

decorate

public ExtendedResponseDecorator<?> decorate(ExtendedResponse decoratedMessage)

Specified by:

decorate in interface LdapApiService

isExtendedOperationRegistered

public boolean isExtendedOperationRegistered(java.lang.String oid)

Checks to see if an extended operation, either a standard request response, pair or just an unsolicited response is registered.

Specified by:

isExtendedOperationRegistered in interface LdapApiService

Parameters:

oid - The object identifier for the extended operation

Returns:

true if registered, false if not

getControlFactories

public java.util.Map<java.lang.String,ControlFactory<? extends Control>> getControlFactories()

Returns:

the controlFactories

setControlFactories

public void setControlFactories(java.util.Map<java.lang.String,ControlFactory<? extends Control>> controlFactories)

Parameters:

controlFactories - the controlFactories to set

getExtendedOperationsFactories

public java.util.Map<java.lang.String,ExtendedOperationFactory> getExtendedOperationsFactories()

Returns:

the extendedOperationsFactories

setExtendedOperationsFactories

public void setExtendedOperationsFactories(java.util.Map<java.lang.String,ExtendedOperationFactory> extendedOperationsFactories)

Parameters:

extendedOperationsFactories - the extendedOperationsFactories to set

setProtocolCodecFactory

public void setProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)

Parameters:

protocolCodecFactory - the protocolCodecFactory to set