org.codehaus.plexus.redback.common.ldap.connection
Class LdapConnectionConfiguration

java.lang.Object
  org.codehaus.plexus.redback.common.ldap.connection.LdapConnectionConfiguration

public class LdapConnectionConfiguration
extends java.lang.Object

This class contains the configuration for a ldap connection.

Properties of a ldap connection:

• Hostname - String, required.
• Port - int, not required. If 0 then the default value is used by the ldap driver.
• Base DN - String, required.
• Context factory - String, required.
• Bind DN - String, not required.
• Password - String, not required.

Note that both the bind dn and password must be set if any are set.

Version:

$Id: LdapConnectionConfiguration.java,v 1.3 2006/02/06 15:15:54 trygvis Exp $

Author:

trygvis

Constructor Summary

LdapConnectionConfiguration()

LdapConnectionConfiguration(java.lang.String hostname, int port, javax.naming.ldap.LdapName baseDn, java.lang.String contextFactory)

LdapConnectionConfiguration(java.lang.String hostname, int port, javax.naming.ldap.LdapName baseDn, java.lang.String contextFactory, javax.naming.ldap.LdapName bindDn, java.lang.String password, java.lang.String authenticationMethod, java.util.Properties extraProperties)

LdapConnectionConfiguration(java.lang.String hostname, int port, java.lang.String baseDn, java.lang.String contextFactory, java.lang.String bindDn, java.lang.String password, java.lang.String authenticationMethod, java.util.Properties extraProperties)

Method Summary

void	check()
java.lang.String	getAuthenticationMethod()
javax.naming.ldap.LdapName	getBaseDn()
javax.naming.ldap.LdapName	getBindDn()
java.lang.String	getContextFactory()
java.util.Properties	getExtraProperties()
java.lang.String	getHostname()
java.util.List<java.lang.Class>	getObjectFactories()
java.lang.String	getPassword()
int	getPort()
java.util.List<java.lang.Class>	getStateFactories()
void	setAuthenticationMethod(java.lang.String authenticationMethod)
void	setBaseDn(javax.naming.ldap.LdapName baseDn)
void	setBaseDn(java.lang.String baseDn)
void	setBindDn(javax.naming.ldap.LdapName bindDn)
void	setBindDn(java.lang.String bindDn)
void	setContextFactory(java.lang.String contextFactory)
void	setExtraProperties(java.util.Properties extraProperties)
void	setHostname(java.lang.String hostname)
void	setObjectFactories(java.util.List<java.lang.Class> objectFactories)
void	setPassword(java.lang.String password)
void	setPort(int port)
void	setStateFactories(java.util.List<java.lang.Class> stateFactories)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapConnectionConfiguration

public LdapConnectionConfiguration()

LdapConnectionConfiguration

public LdapConnectionConfiguration(java.lang.String hostname,
                                   int port,
                                   javax.naming.ldap.LdapName baseDn,
                                   java.lang.String contextFactory,
                                   javax.naming.ldap.LdapName bindDn,
                                   java.lang.String password,
                                   java.lang.String authenticationMethod,
                                   java.util.Properties extraProperties)
                            throws LdapException

Throws:

LdapException

LdapConnectionConfiguration

public LdapConnectionConfiguration(java.lang.String hostname,
                                   int port,
                                   java.lang.String baseDn,
                                   java.lang.String contextFactory,
                                   java.lang.String bindDn,
                                   java.lang.String password,
                                   java.lang.String authenticationMethod,
                                   java.util.Properties extraProperties)
                            throws javax.naming.InvalidNameException,
                                   LdapException

Throws:

javax.naming.InvalidNameException

LdapException

LdapConnectionConfiguration

public LdapConnectionConfiguration(java.lang.String hostname,
                                   int port,
                                   javax.naming.ldap.LdapName baseDn,
                                   java.lang.String contextFactory)
                            throws LdapException

Throws:

LdapException

Method Detail

getHostname

public java.lang.String getHostname()

setHostname

public void setHostname(java.lang.String hostname)

getPort

public int getPort()

setPort

public void setPort(int port)

getBaseDn

public javax.naming.ldap.LdapName getBaseDn()

setBaseDn

public void setBaseDn(javax.naming.ldap.LdapName baseDn)

setBaseDn

public void setBaseDn(java.lang.String baseDn)
               throws javax.naming.InvalidNameException

Throws:

javax.naming.InvalidNameException

getContextFactory

public java.lang.String getContextFactory()

setContextFactory

public void setContextFactory(java.lang.String contextFactory)

getBindDn

public javax.naming.ldap.LdapName getBindDn()

setBindDn

public void setBindDn(javax.naming.ldap.LdapName bindDn)

setBindDn

public void setBindDn(java.lang.String bindDn)
               throws javax.naming.InvalidNameException

Throws:

javax.naming.InvalidNameException

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getAuthenticationMethod

public java.lang.String getAuthenticationMethod()

setAuthenticationMethod

public void setAuthenticationMethod(java.lang.String authenticationMethod)

getObjectFactories

public java.util.List<java.lang.Class> getObjectFactories()

setObjectFactories

public void setObjectFactories(java.util.List<java.lang.Class> objectFactories)

getStateFactories

public java.util.List<java.lang.Class> getStateFactories()

setStateFactories

public void setStateFactories(java.util.List<java.lang.Class> stateFactories)

getExtraProperties

public java.util.Properties getExtraProperties()

setExtraProperties

public void setExtraProperties(java.util.Properties extraProperties)

check

public void check()
           throws LdapException

Throws:

LdapException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object