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

Class StandaloneLdapApiService

java.lang.Object

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

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

All Implemented Interfaces:

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

public class StandaloneLdapApiService
extends org.apache.directory.api.ldap.codec.osgi.DefaultLdapCodecService

The default LdapApiService implementation. It loads the Controls and ExtendedOperations as defined in the following system parameters :

• Controls :
  • apacheds.controls
  • default.controls
• ExtendedOperations :
  • apacheds.extendedOperations
  • default.extendedOperation.responses
  • extra.extendedOperations

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROLS_LIST The list of controls to load at startup
static String	EXTENDED_OPERATIONS_LIST The list of extended operations to load at startup
private static org.slf4j.Logger	LOG A logger
private static String	OLD_DEFAULT_CONTROLS_LIST The (old) list of default controls to load at startup
private static String	OLD_EXTRA_EXTENDED_OPERATION_LIST The (old) list of extra extended operations 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.
StandaloneLdapApiService(List<String> controls, List<String> extendedOperations) Creates a new instance of StandaloneLdapApiService.

Method Summary

Modifier and Type	Method and Description
private static List<String>	getControlsFromSystemProperties() Parses the system properties to obtain the controls list.
private static List<String>	getExtendedOperationsFromSystemProperties() Parses the system properties to obtain the extended operations.
private void	loadControl(String controlFQCN) Loads a control from its FQCN.
private void	loadControls(List<String> controlsList) Loads a list of controls from their FQCN.
private void	loadExtendedOperation(String extendedOperationFQCN) Loads an of extended operations from its FQCN
private void	loadExtendedOperations(List<String> extendedOperationsList) Loads a list of extended operation from their FQCN

Methods inherited from class org.apache.directory.api.ldap.codec.osgi.DefaultLdapCodecService

decorate, decorate, fromJndi, fromJndi, fromJndiControl, getControlFactories, getExtendedOperationsFactories, getProtocolCodecFactory, isControlRegistered, isExtendedOperationRegistered, newControl, newControl, newExtendedRequest, newExtendedResponse, newMessageContainer, registerControl, registeredControls, registeredExtendedRequests, registerExtendedRequest, registerProtocolCodecFactory, setControlFactories, setExtendedOperationsFactories, setProtocolCodecFactory, toJndi, toJndi, toJndiControl, unregisterControl, unregisterExtendedRequest

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

CONTROLS_LIST

public static final String CONTROLS_LIST

The list of controls to load at startup

See Also:

Constant Field Values

EXTENDED_OPERATIONS_LIST

public static final String EXTENDED_OPERATIONS_LIST

The list of extended operations to load at startup

See Also:

Constant Field Values

OLD_DEFAULT_CONTROLS_LIST

private static final String OLD_DEFAULT_CONTROLS_LIST

The (old) list of default controls to load at startup

See Also:

Constant Field Values

OLD_EXTRA_EXTENDED_OPERATION_LIST

private static final String OLD_EXTRA_EXTENDED_OPERATION_LIST

The (old) list of extra extended operations to load at startup

See Also:

Constant Field Values

Constructor Detail

StandaloneLdapApiService

public StandaloneLdapApiService()
                         throws Exception

Creates a new instance of StandaloneLdapCodecService.

The following pom configuration is 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 - If we had an issue initializing the LDAP service

StandaloneLdapApiService

public StandaloneLdapApiService(List<String> controls,
                                List<String> extendedOperations)
                         throws Exception

Creates a new instance of StandaloneLdapApiService.

Parameters:

controls - The list of controls to store

extendedOperations - The list of extended operations to store

Throws:

Exception - If we had an issue with one of the two lists

Method Detail

getControlsFromSystemProperties

private static List<String> getControlsFromSystemProperties()
                                                     throws Exception

Parses the system properties to obtain the controls list.

Throws:

Exception

getExtendedOperationsFromSystemProperties

private static List<String> getExtendedOperationsFromSystemProperties()
                                                               throws Exception

Parses the system properties to obtain the extended operations. Such extended operations are stored in the apacheds.extendedOperations and default.extendedOperation.requests system properties.

Throws:

Exception

loadControls

private void loadControls(List<String> controlsList)
                   throws Exception

Loads a list of controls from their FQCN.

Throws:

Exception

loadControl

private void loadControl(String controlFQCN)
                  throws Exception

Loads a control from its FQCN.

Throws:

Exception

loadExtendedOperations

private void loadExtendedOperations(List<String> extendedOperationsList)
                             throws Exception

Loads a list of extended operation from their FQCN

Throws:

Exception

loadExtendedOperation

private void loadExtendedOperation(String extendedOperationFQCN)
                            throws Exception

Loads an of extended operations from its FQCN

Throws:

Exception