Package org.springframework.security.ldap.server

Class ApacheDSContainer

java.lang.Object
org.springframework.security.ldap.server.ApacheDSContainer
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, EmbeddedLdapServerContainer
@Deprecated(since="5.2", forRemoval=true) public class ApacheDSContainer extends Object implements EmbeddedLdapServerContainer, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.context.Lifecycle, org.springframework.context.ApplicationContextAware
Deprecated, for removal: This API element is subject to removal in a future version.
For removal in 7.0. Use UnboundIdContainer instead because ApacheDS 1.x is no longer supported with no GA version to replace it.
Provides lifecycle services for the embedded apacheDS server defined by the supplied configuration. Used by LdapServerBeanDefinitionParser. An instance will be stored in the application context for each embedded server instance. It will start the server when the context is initialized and shut it down when it is closed. It is intended for temporary embedded use and will not retain changes across start/stop boundaries. The working directory is deleted on shutdown.

If used repeatedly in a single JVM process with the same configuration (for example, when repeatedly loading an application context during testing), it's important that the application context is closed to allow the bean to be disposed of and the server shutdown prior to attempting to start it again.

This class is intended for testing and internal security namespace use, only, and is not considered part of the framework's public API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ApacheDSContainer(String root, String ldifs)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterPropertiesSet()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    destroy()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getLocalPort()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the port that is resolved by TcpTransport.
    int
    getPort()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the embedded LDAP server port.
    org.apache.directory.server.core.DefaultDirectoryService
    getService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isRunning()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setCertificatePassord(String certificatePassord)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Will set the certificate password on the underlying LdapServer.
    void
    setKeyStoreFile(File keyStoreFile)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The keyStore must not be null and must be a valid file.
    void
    setLdapOverSslEnabled(boolean ldapOverSslEnabled)
    Deprecated, for removal: This API element is subject to removal in a future version.
    If set to true will enable LDAP over SSL (LDAPs).
    void
    setPort(int port)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The embedded LDAP server port to connect to.
    void
    setWorkingDirectory(File workingDir)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    start()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    stop()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ApacheDSContainer

      public ApacheDSContainer(String root, String ldifs) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • destroy

      public void destroy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException

    • setWorkingDirectory

      public void setWorkingDirectory(File workingDir)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setPort

      public void setPort(int port)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: EmbeddedLdapServerContainer
      The embedded LDAP server port to connect to. Supplying 0 as the port indicates that a random available port should be selected.
      Specified by:
      setPort in interface EmbeddedLdapServerContainer
      Parameters:
      port - the port to connect to

    • getPort

      public int getPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: EmbeddedLdapServerContainer
      Returns the embedded LDAP server port.
      Specified by:
      getPort in interface EmbeddedLdapServerContainer
      Returns:
      the embedded LDAP server port

    • getLocalPort

      public int getLocalPort()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the port that is resolved by TcpTransport.
      Returns:
      the port that is resolved by TcpTransport

    • setLdapOverSslEnabled

      public void setLdapOverSslEnabled(boolean ldapOverSslEnabled)
      Deprecated, for removal: This API element is subject to removal in a future version.
      If set to true will enable LDAP over SSL (LDAPs). If set to true setCertificatePassord(String) must be set as well.
      Parameters:
      ldapOverSslEnabled - If not set, will default to false

    • setKeyStoreFile

      public void setKeyStoreFile(File keyStoreFile)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The keyStore must not be null and must be a valid file. Will set the keyStore file on the underlying LdapServer.
      Parameters:
      keyStoreFile - Mandatory if LDAPs is enabled

    • setCertificatePassord

      public void setCertificatePassord(String certificatePassord)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Will set the certificate password on the underlying LdapServer.
      Parameters:
      certificatePassord - May be null

    • getService

      public org.apache.directory.server.core.DefaultDirectoryService getService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • start

      public void start()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      start in interface org.springframework.context.Lifecycle

    • stop

      public void stop()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      stop in interface org.springframework.context.Lifecycle

    • isRunning

      public boolean isRunning()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle