org.apache.directory.api.ldap.codec.standalone

Class StandaloneLdapApiService

java.lang.Object

org.apache.directory.api.ldap.codec.standalone.StandaloneLdapApiService

All Implemented Interfaces:

org.apache.directory.api.ldap.codec.api.LdapApiService

public class StandaloneLdapApiService
extends Object
implements org.apache.directory.api.ldap.codec.api.LdapApiService

The default LdapApiService implementation.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTROLS_LIST The list of default controls to load at startup
static String	DEFAULT_EXTENDED_OPERATION_REQUESTS_LIST The list of default extended operation requests to load at startup
static String	DEFAULT_EXTENDED_OPERATION_RESPONSES_LIST The list of default extended operation responses to load at startup
static String	EXTRA_CONTROLS_LIST The list of extra controls to load at startup
static String	EXTRA_EXTENDED_OPERATION_LIST The list of extra controls to load at startup

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

DEFAULT_PROTOCOL_CODEC_FACTORY

Constructor Summary

Constructors

Constructor and Description
StandaloneLdapApiService() Creates a new instance of StandaloneLdapCodecService.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<?,?>	decorate(org.apache.directory.api.ldap.model.message.ExtendedRequest<?> decoratedMessage)
org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator<?>	decorate(org.apache.directory.api.ldap.model.message.ExtendedResponse decoratedMessage)
org.apache.directory.api.ldap.model.message.ExtendedRequest<?>	fromJndi(ExtendedRequest jndiRequest)
org.apache.directory.api.ldap.model.message.ExtendedResponse	fromJndi(ExtendedResponse jndiResponse)
org.apache.directory.api.ldap.model.message.Control	fromJndiControl(Control control)
org.apache.mina.filter.codec.ProtocolCodecFactory	getProtocolCodecFactory()
boolean	isControlRegistered(String oid)
boolean	isExtendedOperationRegistered(String oid)
org.apache.directory.api.ldap.codec.api.CodecControl<? extends org.apache.directory.api.ldap.model.message.Control>	newControl(org.apache.directory.api.ldap.model.message.Control control)
org.apache.directory.api.ldap.codec.api.CodecControl<? extends org.apache.directory.api.ldap.model.message.Control>	newControl(String oid)
org.apache.directory.api.ldap.model.message.ExtendedRequest<?>	newExtendedRequest(String oid, byte[] value)
<E extends org.apache.directory.api.ldap.model.message.ExtendedResponse> E	newExtendedResponse(String responseName, int messageId, byte[] serializedResponse)
org.apache.directory.api.asn1.ber.Asn1Container	newMessageContainer()
org.apache.directory.api.ldap.codec.api.ControlFactory<?,?>	registerControl(org.apache.directory.api.ldap.codec.api.ControlFactory<?,?> factory)
Iterator<String>	registeredControls()
Iterator<String>	registeredExtendedRequests()
Iterator<String>	registeredUnsolicitedResponses()
org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?>	registerExtendedRequest(org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?> factory)
org.apache.mina.filter.codec.ProtocolCodecFactory	registerProtocolCodecFactory(org.apache.mina.filter.codec.ProtocolCodecFactory protocolCodecFactory)
org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?>	registerUnsolicitedResponse(org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?> factory)
ExtendedRequest	toJndi(org.apache.directory.api.ldap.model.message.ExtendedRequest<?> modelRequest)
ExtendedResponse	toJndi(org.apache.directory.api.ldap.model.message.ExtendedResponse modelResponse)
Control	toJndiControl(org.apache.directory.api.ldap.model.message.Control control)
org.apache.directory.api.ldap.codec.api.ControlFactory<?,?>	unregisterControl(String oid)
org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?>	unregisterExtendedRequest(String oid)
org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?>	unregisterUnsolicitedResponse(String oid)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTROLS_LIST

public static final String DEFAULT_CONTROLS_LIST

The list of default controls to load at startup

See Also:

Constant Field Values

EXTRA_CONTROLS_LIST

public static final String EXTRA_CONTROLS_LIST

The list of extra controls to load at startup

See Also:

Constant Field Values

DEFAULT_EXTENDED_OPERATION_REQUESTS_LIST

public static final String DEFAULT_EXTENDED_OPERATION_REQUESTS_LIST

The list of default extended operation requests to load at startup

See Also:

Constant Field Values

DEFAULT_EXTENDED_OPERATION_RESPONSES_LIST

public static final String DEFAULT_EXTENDED_OPERATION_RESPONSES_LIST

The list of default extended operation responses to load at startup

See Also:

Constant Field Values

EXTRA_EXTENDED_OPERATION_LIST

public static final String EXTRA_EXTENDED_OPERATION_LIST

The list of extra controls to load at startup

See Also:

Constant Field Values

Constructor Detail

StandaloneLdapApiService

public StandaloneLdapApiService()
                         throws Exception

Creates a new instance of StandaloneLdapCodecService. Optionally checks for system property #PLUGIN_DIRECTORY_PROPERTY. Intended for use by unit test running tools like Maven's surefire:

   <properties>
     <codec.plugin.directory>${project.build.directory}/pluginDirectory</codec.plugin.directory>
   </properties>
 
   <build>
     <plugins>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
         <groupId>org.apache.maven.plugins</groupId>
         <configuration>
           <systemPropertyVariables>
             <workingDirectory>${basedir}/target</workingDirectory>
             <felix.cache.rootdir>
               ${project.build.directory}
             </felix.cache.rootdir>
             <felix.cache.locking>
               true
             </felix.cache.locking>
             <org.osgi.framework.storage.clean>
               onFirstInit
             </org.osgi.framework.storage.clean>
             <org.osgi.framework.storage>
               osgi-cache
             </org.osgi.framework.storage>
             <codec.plugin.directory>
               ${codec.plugin.directory}
             </codec.plugin.directory>
           </systemPropertyVariables>
         </configuration>
       </plugin>
       
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>
         <executions>
           <execution>
             <id>copy</id>
             <phase>compile</phase>
             <goals>
               <goal>copy</goal>
             </goals>
             <configuration>
               <artifactItems>
                 <artifactItem>
                   <groupId>${project.groupId}</groupId>
                   <artifactId>api-ldap-extras-codec</artifactId>
                   <version>${project.version}</version>
                   <outputDirectory>${codec.plugin.directory}</outputDirectory>
                 </artifactItem>
               </artifactItems>
             </configuration>
           </execution>
         </executions>
       </plugin>
     </plugins>
   </build>
 

Throws:

Exception

Method Detail

registerControl

public org.apache.directory.api.ldap.codec.api.ControlFactory<?,?> registerControl(org.apache.directory.api.ldap.codec.api.ControlFactory<?,?> factory)

Specified by:

registerControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

unregisterControl

public org.apache.directory.api.ldap.codec.api.ControlFactory<?,?> unregisterControl(String oid)

Specified by:

unregisterControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registeredControls

public Iterator<String> registeredControls()

Specified by:

registeredControls in interface org.apache.directory.api.ldap.codec.api.LdapApiService

isControlRegistered

public boolean isControlRegistered(String oid)

Specified by:

isControlRegistered in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registeredExtendedRequests

public Iterator<String> registeredExtendedRequests()

Specified by:

registeredExtendedRequests in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registerExtendedRequest

public org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?> registerExtendedRequest(org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?> factory)

Specified by:

registerExtendedRequest in interface org.apache.directory.api.ldap.codec.api.LdapApiService

getProtocolCodecFactory

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

Specified by:

getProtocolCodecFactory in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registerProtocolCodecFactory

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

Specified by:

registerProtocolCodecFactory in interface org.apache.directory.api.ldap.codec.api.LdapApiService

newControl

public org.apache.directory.api.ldap.codec.api.CodecControl<? extends org.apache.directory.api.ldap.model.message.Control> newControl(String oid)

Specified by:

newControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

newControl

public org.apache.directory.api.ldap.codec.api.CodecControl<? extends org.apache.directory.api.ldap.model.message.Control> newControl(org.apache.directory.api.ldap.model.message.Control control)

Specified by:

newControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

toJndiControl

public Control toJndiControl(org.apache.directory.api.ldap.model.message.Control control)
                      throws org.apache.directory.api.asn1.EncoderException

Specified by:

toJndiControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.EncoderException

fromJndiControl

public org.apache.directory.api.ldap.model.message.Control fromJndiControl(Control control)
                                                                    throws org.apache.directory.api.asn1.DecoderException

Specified by:

fromJndiControl in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.DecoderException

newMessageContainer

public org.apache.directory.api.asn1.ber.Asn1Container newMessageContainer()

Specified by:

newMessageContainer in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registeredUnsolicitedResponses

public Iterator<String> registeredUnsolicitedResponses()

Specified by:

registeredUnsolicitedResponses in interface org.apache.directory.api.ldap.codec.api.LdapApiService

registerUnsolicitedResponse

public org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?> registerUnsolicitedResponse(org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?> factory)

Specified by:

registerUnsolicitedResponse in interface org.apache.directory.api.ldap.codec.api.LdapApiService

toJndi

public ExtendedResponse toJndi(org.apache.directory.api.ldap.model.message.ExtendedResponse modelResponse)
                        throws org.apache.directory.api.asn1.EncoderException

Specified by:

toJndi in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.EncoderException

fromJndi

public org.apache.directory.api.ldap.model.message.ExtendedResponse fromJndi(ExtendedResponse jndiResponse)
                                                                      throws org.apache.directory.api.asn1.DecoderException

Specified by:

fromJndi in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.DecoderException

unregisterExtendedRequest

public org.apache.directory.api.ldap.codec.api.ExtendedRequestFactory<?,?> unregisterExtendedRequest(String oid)

Specified by:

unregisterExtendedRequest in interface org.apache.directory.api.ldap.codec.api.LdapApiService

unregisterUnsolicitedResponse

public org.apache.directory.api.ldap.codec.api.UnsolicitedResponseFactory<?> unregisterUnsolicitedResponse(String oid)

Specified by:

unregisterUnsolicitedResponse in interface org.apache.directory.api.ldap.codec.api.LdapApiService

fromJndi

public org.apache.directory.api.ldap.model.message.ExtendedRequest<?> fromJndi(ExtendedRequest jndiRequest)
                                                                        throws org.apache.directory.api.asn1.DecoderException

Specified by:

fromJndi in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.DecoderException

toJndi

public ExtendedRequest toJndi(org.apache.directory.api.ldap.model.message.ExtendedRequest<?> modelRequest)
                       throws org.apache.directory.api.asn1.EncoderException

Specified by:

toJndi in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.EncoderException

newExtendedResponse

public <E extends org.apache.directory.api.ldap.model.message.ExtendedResponse> E newExtendedResponse(String responseName,
                                                                                             int messageId,
                                                                                             byte[] serializedResponse)
                                                                                           throws org.apache.directory.api.asn1.DecoderException

Specified by:

newExtendedResponse in interface org.apache.directory.api.ldap.codec.api.LdapApiService

Throws:

org.apache.directory.api.asn1.DecoderException

newExtendedRequest

public org.apache.directory.api.ldap.model.message.ExtendedRequest<?> newExtendedRequest(String oid,
                                                                                byte[] value)

Specified by:

newExtendedRequest in interface org.apache.directory.api.ldap.codec.api.LdapApiService

decorate

public org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<?,?> decorate(org.apache.directory.api.ldap.model.message.ExtendedRequest<?> decoratedMessage)

Specified by:

decorate in interface org.apache.directory.api.ldap.codec.api.LdapApiService

decorate

public org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator<?> decorate(org.apache.directory.api.ldap.model.message.ExtendedResponse decoratedMessage)

Specified by:

decorate in interface org.apache.directory.api.ldap.codec.api.LdapApiService

isExtendedOperationRegistered

public boolean isExtendedOperationRegistered(String oid)

Specified by:

isExtendedOperationRegistered in interface org.apache.directory.api.ldap.codec.api.LdapApiService