LdapConfiguration (Archiva :: Modules 2.2.10 API)

java.lang.Object
- org.apache.archiva.configuration.LdapConfiguration

All Implemented Interfaces:

Serializable
```
public class LdapConfiguration
extends Object
implements Serializable
```
The LDAP configuration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`authenticationMethod` The LDAP authenticationMethod.
`private String`	`baseDn` The LDAP base dn.
`private String`	`baseGroupsDn` The LDAP base dn for groups (if empty baseDn is used).
`private boolean`	`bindAuthenticatorEnabled` The LDAP authenticator enabled.
`private String`	`bindDn` The LDAP bind dn.
`private String`	`contextFactory` contextFactory to use.
`private Map`	`extraProperties` Field extraProperties.
`private String`	`hostName` The LDAP host.
`private String`	`password` The LDAP password.
`private int`	`port` The LDAP port.
`private boolean`	`ssl` ssl LDAP connection.
`private boolean`	`useRoleNameAsGroup` Will use role name as LDAP group.
`private boolean`	`writable` LDAP writable.

Constructor Summary

Constructors
Constructor and Description

LdapConfiguration()

Constructors
Constructor and Description
`LdapConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtraProperty(Object key, String value)` Method addExtraProperty.
`String`	`getAuthenticationMethod()` Get the LDAP authenticationMethod.
`String`	`getBaseDn()` Get the LDAP base dn.
`String`	`getBaseGroupsDn()` Get the LDAP base dn for groups (if empty baseDn is used).
`String`	`getBindDn()` Get the LDAP bind dn.
`String`	`getContextFactory()` Get contextFactory to use.
`Map`	`getExtraProperties()` Method getExtraProperties.
`String`	`getHostName()` Get the LDAP host.
`String`	`getPassword()` Get the LDAP password.
`int`	`getPort()` Get the LDAP port.
`boolean`	`isBindAuthenticatorEnabled()` Get the LDAP authenticator enabled.
`boolean`	`isSsl()` Get ssl LDAP connection.
`boolean`	`isUseRoleNameAsGroup()` Get will use role name as LDAP group.
`boolean`	`isWritable()` Get lDAP writable.
`void`	`setAuthenticationMethod(String authenticationMethod)` Set the LDAP authenticationMethod.
`void`	`setBaseDn(String baseDn)` Set the LDAP base dn.
`void`	`setBaseGroupsDn(String baseGroupsDn)` Set the LDAP base dn for groups (if empty baseDn is used).
`void`	`setBindAuthenticatorEnabled(boolean bindAuthenticatorEnabled)` Set the LDAP authenticator enabled.
`void`	`setBindDn(String bindDn)` Set the LDAP bind dn.
`void`	`setContextFactory(String contextFactory)` Set contextFactory to use.
`void`	`setExtraProperties(Map extraProperties)` Set additional properties to use for ldap connection.
`void`	`setHostName(String hostName)` Set the LDAP host.
`void`	`setPassword(String password)` Set the LDAP password.
`void`	`setPort(int port)` Set the LDAP port.
`void`	`setSsl(boolean ssl)` Set ssl LDAP connection.
`void`	`setUseRoleNameAsGroup(boolean useRoleNameAsGroup)` Set will use role name as LDAP group.
`void`	`setWritable(boolean writable)` Set lDAP writable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - hostName
```
private String hostName
```
    The LDAP host.
  - port
```
private int port
```
    The LDAP port.
  - ssl
```
private boolean ssl
```
    ssl LDAP connection.
  - baseDn
```
private String baseDn
```
    The LDAP base dn.
  - baseGroupsDn
```
private String baseGroupsDn
```
    The LDAP base dn for groups (if empty baseDn is used).
  - contextFactory
```
private String contextFactory
```
    contextFactory to use.
  - bindDn
```
private String bindDn
```
    The LDAP bind dn.
  - password
```
private String password
```
    The LDAP password.
  - authenticationMethod
```
private String authenticationMethod
```
    The LDAP authenticationMethod.
  - bindAuthenticatorEnabled
```
private boolean bindAuthenticatorEnabled
```
    The LDAP authenticator enabled.
  - writable
```
private boolean writable
```
    LDAP writable.
  - useRoleNameAsGroup
```
private boolean useRoleNameAsGroup
```
    Will use role name as LDAP group.
  - extraProperties
```
private Map extraProperties
```
    Field extraProperties.
- Constructor Detail
  - LdapConfiguration
```
public LdapConfiguration()
```
- Method Detail
  - addExtraProperty
```
public void addExtraProperty(Object key,
                             String value)
```
    Method addExtraProperty.
    
    Parameters:
    
    key -
    
    value -
  - getAuthenticationMethod
```
public String getAuthenticationMethod()
```
    Get the LDAP authenticationMethod.
    
    Returns:
    
    String
  - getBaseDn
```
public String getBaseDn()
```
    Get the LDAP base dn.
    
    Returns:
    
    String
  - getBaseGroupsDn
```
public String getBaseGroupsDn()
```
    Get the LDAP base dn for groups (if empty baseDn is used).
    
    Returns:
    
    String
  - getBindDn
```
public String getBindDn()
```
    Get the LDAP bind dn.
    
    Returns:
    
    String
  - getContextFactory
```
public String getContextFactory()
```
    Get contextFactory to use.
    
    Returns:
    
    String
  - getExtraProperties
```
public Map getExtraProperties()
```
    Method getExtraProperties.
    
    Returns:
    
    Map
  - getHostName
```
public String getHostName()
```
    Get the LDAP host.
    
    Returns:
    
    String
  - getPassword
```
public String getPassword()
```
    Get the LDAP password.
    
    Returns:
    
    String
  - getPort
```
public int getPort()
```
    Get the LDAP port.
    
    Returns:
    
    int
  - isBindAuthenticatorEnabled
```
public boolean isBindAuthenticatorEnabled()
```
    Get the LDAP authenticator enabled.
    
    Returns:
    
    boolean
  - isSsl
```
public boolean isSsl()
```
    Get ssl LDAP connection.
    
    Returns:
    
    boolean
  - isUseRoleNameAsGroup
```
public boolean isUseRoleNameAsGroup()
```
    Get will use role name as LDAP group.
    
    Returns:
    
    boolean
  - isWritable
```
public boolean isWritable()
```
    Get lDAP writable.
    
    Returns:
    
    boolean
  - setAuthenticationMethod
```
public void setAuthenticationMethod(String authenticationMethod)
```
    Set the LDAP authenticationMethod.
    
    Parameters:
    
    authenticationMethod -
  - setBaseDn
```
public void setBaseDn(String baseDn)
```
    Set the LDAP base dn.
    
    Parameters:
    
    baseDn -
  - setBaseGroupsDn
```
public void setBaseGroupsDn(String baseGroupsDn)
```
    Set the LDAP base dn for groups (if empty baseDn is used).
    
    Parameters:
    
    baseGroupsDn -
  - setBindAuthenticatorEnabled
```
public void setBindAuthenticatorEnabled(boolean bindAuthenticatorEnabled)
```
    Set the LDAP authenticator enabled.
    
    Parameters:
    
    bindAuthenticatorEnabled -
  - setBindDn
```
public void setBindDn(String bindDn)
```
    Set the LDAP bind dn.
    
    Parameters:
    
    bindDn -
  - setContextFactory
```
public void setContextFactory(String contextFactory)
```
    Set contextFactory to use.
    
    Parameters:
    
    contextFactory -
  - setExtraProperties
```
public void setExtraProperties(Map extraProperties)
```
    Set additional properties to use for ldap connection.
    
    Parameters:
    
    extraProperties -
  - setHostName
```
public void setHostName(String hostName)
```
    Set the LDAP host.
    
    Parameters:
    
    hostName -
  - setPassword
```
public void setPassword(String password)
```
    Set the LDAP password.
    
    Parameters:
    
    password -
  - setPort
```
public void setPort(int port)
```
    Set the LDAP port.
    
    Parameters:
    
    port -
  - setSsl
```
public void setSsl(boolean ssl)
```
    Set ssl LDAP connection.
    
    Parameters:
    
    ssl -
  - setUseRoleNameAsGroup
```
public void setUseRoleNameAsGroup(boolean useRoleNameAsGroup)
```
    Set will use role name as LDAP group.
    
    Parameters:
    
    useRoleNameAsGroup -
  - setWritable
```
public void setWritable(boolean writable)
```
    Set lDAP writable.
    
    Parameters:
    
    writable -

Class LdapConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hostName

port

ssl

baseDn

baseGroupsDn

contextFactory

bindDn

password

authenticationMethod

bindAuthenticatorEnabled

writable

useRoleNameAsGroup

extraProperties

Constructor Detail

LdapConfiguration

Method Detail

addExtraProperty

getAuthenticationMethod

getBaseDn

getBaseGroupsDn

getBindDn

getContextFactory

getExtraProperties

getHostName

getPassword

getPort

isBindAuthenticatorEnabled

isSsl

isUseRoleNameAsGroup

isWritable

setAuthenticationMethod

setBaseDn

setBaseGroupsDn

setBindAuthenticatorEnabled

setBindDn

setContextFactory

setExtraProperties

setHostName

setPassword

setPort

setSsl

setUseRoleNameAsGroup

setWritable