org.apache.turbine.services.security.ldap
Class LDAPSecurityConstants

java.lang.Object
  org.apache.turbine.services.security.ldap.LDAPSecurityConstants

public class LDAPSecurityConstants
extends java.lang.Object

This is a static class for defining the default ldap confiquration keys used by core Turbine components.

Version:

$Id: LDAPSecurityConstants.java 534527 2007-05-02 16:10:59Z tv $

Author:

Jason van Zyl, Humberto Hernandez

Field Summary

static java.lang.String	LDAP_ADMIN_PASSWORD_KEY Property key
static java.lang.String	LDAP_ADMIN_USERNAME_KEY Property key
static java.lang.String	LDAP_AUTH_DEFAULT Property default value
static java.lang.String	LDAP_AUTH_KEY Property key
static java.lang.String	LDAP_BASE_SEARCH_KEY Property key
static java.lang.String	LDAP_HOST_DEFAULT Property default value
static java.lang.String	LDAP_HOST_KEY Property key
static java.lang.String	LDAP_PORT_DEFAULT Property default value
static java.lang.String	LDAP_PORT_KEY Property key
static java.lang.String	LDAP_PROVIDER_DEFAULT Property default value
static java.lang.String	LDAP_PROVIDER_KEY Property key
static java.lang.String	LDAP_USER_EMAIL_DEFAULT Property default value
static java.lang.String	LDAP_USER_EMAIL_KEY Property key
static java.lang.String	LDAP_USER_FIRSTNAME_DEFAULT Property default value
static java.lang.String	LDAP_USER_FIRSTNAME_KEY Property key
static java.lang.String	LDAP_USER_LASTNAME_DEFAULT Property default value
static java.lang.String	LDAP_USER_LASTNAME_KEY Property key
static java.lang.String	LDAP_USER_PASSWORD_DEFAULT Property default value
static java.lang.String	LDAP_USER_PASSWORD_KEY Property key
static java.lang.String	LDAP_USER_USERID_DEFAULT Property default value
static java.lang.String	LDAP_USER_USERID_KEY Property key
static java.lang.String	LDAP_USER_USERNAME_DEFAULT Property default value
static java.lang.String	LDAP_USER_USERNAME_KEY Property key

Constructor Summary

LDAPSecurityConstants()

Method Summary

static java.lang.String	getAdminPassword() Get the value of the property for the administration password.
static java.lang.String	getAdminUsername() Get the value of the property for the administration username.
static java.lang.String	getBaseSearch() Get value of the property for the Base Search.
static java.lang.String	getEmailAttribute() Get the value of the E-Mail Attribute.
static java.lang.String	getFirstNameAttribute() Get the value of the Firstname Attribute.
static java.lang.String	getLastNameAttribute() Get the value of the Lastname Attribute.
static java.lang.String	getLDAPAuthentication() Get the value of the property for the Authentication mechanism.
static java.lang.String	getLDAPHost() Get the value of the property for the LDAP Host.
static java.lang.String	getLDAPPort() Get the value of the property for the LDAP Port.
static java.lang.String	getLDAPProvider() Get the value of the property for the LDAP Provider.
static java.lang.String	getNameAttribute() Get the value of the Username Attribute.
static java.lang.String	getPasswordAttribute() Get the value of the Password Attribute.
static java.util.Properties	getProperties() Get all the properties for the security service.
static java.lang.String	getProperty(java.lang.String key) Get a property from the LDAP security service.
static java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Get a property from the LDAP security service.
static java.lang.String	getUserIdAttribute() Get the value of the User id Attribute.
static java.lang.String	getUserNameAttribute() Deprecated. Use getNameAttribute()

Methods inherited from class java.lang.Object

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

Field Detail

LDAP_ADMIN_USERNAME_KEY

public static final java.lang.String LDAP_ADMIN_USERNAME_KEY

Property key

See Also:

Constant Field Values

LDAP_ADMIN_PASSWORD_KEY

public static final java.lang.String LDAP_ADMIN_PASSWORD_KEY

Property key

See Also:

Constant Field Values

LDAP_HOST_KEY

public static final java.lang.String LDAP_HOST_KEY

Property key

See Also:

Constant Field Values

LDAP_HOST_DEFAULT

public static final java.lang.String LDAP_HOST_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_PORT_KEY

public static final java.lang.String LDAP_PORT_KEY

Property key

See Also:

Constant Field Values

LDAP_PORT_DEFAULT

public static final java.lang.String LDAP_PORT_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_PROVIDER_KEY

public static final java.lang.String LDAP_PROVIDER_KEY

Property key

See Also:

Constant Field Values

LDAP_PROVIDER_DEFAULT

public static final java.lang.String LDAP_PROVIDER_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_BASE_SEARCH_KEY

public static final java.lang.String LDAP_BASE_SEARCH_KEY

Property key

See Also:

Constant Field Values

LDAP_AUTH_KEY

public static final java.lang.String LDAP_AUTH_KEY

Property key

See Also:

Constant Field Values

LDAP_AUTH_DEFAULT

public static final java.lang.String LDAP_AUTH_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_USERID_KEY

public static final java.lang.String LDAP_USER_USERID_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_USERID_DEFAULT

public static final java.lang.String LDAP_USER_USERID_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_USERNAME_KEY

public static final java.lang.String LDAP_USER_USERNAME_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_USERNAME_DEFAULT

public static final java.lang.String LDAP_USER_USERNAME_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_FIRSTNAME_KEY

public static final java.lang.String LDAP_USER_FIRSTNAME_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_FIRSTNAME_DEFAULT

public static final java.lang.String LDAP_USER_FIRSTNAME_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_LASTNAME_KEY

public static final java.lang.String LDAP_USER_LASTNAME_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_LASTNAME_DEFAULT

public static final java.lang.String LDAP_USER_LASTNAME_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_EMAIL_KEY

public static final java.lang.String LDAP_USER_EMAIL_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_EMAIL_DEFAULT

public static final java.lang.String LDAP_USER_EMAIL_DEFAULT

Property default value

See Also:

Constant Field Values

LDAP_USER_PASSWORD_KEY

public static final java.lang.String LDAP_USER_PASSWORD_KEY

Property key

See Also:

Constant Field Values

LDAP_USER_PASSWORD_DEFAULT

public static final java.lang.String LDAP_USER_PASSWORD_DEFAULT

Property default value

See Also:

Constant Field Values

Constructor Detail

LDAPSecurityConstants

public LDAPSecurityConstants()

Method Detail

getProperties

public static java.util.Properties getProperties()

Get all the properties for the security service.

Returns:

all the properties of the security service.

getProperty

public static java.lang.String getProperty(java.lang.String key)

Get a property from the LDAP security service.

Parameters:

key - The key to access the value of the property.

Returns:

The value of the property.

getProperty

public static java.lang.String getProperty(java.lang.String key,
                                           java.lang.String defaultValue)

Get a property from the LDAP security service.

Parameters:

key - The key to access the value of the property.

defaultValue - The value that the property takes when it doesn't exist.

Returns:

The value of the property.

getAdminUsername

public static java.lang.String getAdminUsername()

Get the value of the property for the administration username.

Returns:

the value of the property.

getAdminPassword

public static java.lang.String getAdminPassword()

Get the value of the property for the administration password.

Returns:

the value of the property.

getLDAPHost

public static java.lang.String getLDAPHost()

Get the value of the property for the LDAP Host.

Returns:

the value of the property.

getLDAPPort

public static java.lang.String getLDAPPort()

Get the value of the property for the LDAP Port.

Returns:

the value of the property.

getLDAPProvider

public static java.lang.String getLDAPProvider()

Get the value of the property for the LDAP Provider.

Returns:

the value of the property.

getBaseSearch

public static java.lang.String getBaseSearch()

Get value of the property for the Base Search.

Returns:

the value of the property.

getLDAPAuthentication

public static java.lang.String getLDAPAuthentication()

Get the value of the property for the Authentication mechanism. Valid values are: none, simple,

Returns:

the value of the property.

getUserIdAttribute

public static java.lang.String getUserIdAttribute()

Get the value of the User id Attribute.

Returns:

the value of the property.

getNameAttribute

public static java.lang.String getNameAttribute()

Get the value of the Username Attribute.

Returns:

the value of the property.

getUserNameAttribute

public static java.lang.String getUserNameAttribute()

Deprecated. Use getNameAttribute()

Get the value of the Username Attribute.

Returns:

the value of the property.

getFirstNameAttribute

public static java.lang.String getFirstNameAttribute()

Get the value of the Firstname Attribute.

Returns:

the value of the property.

getLastNameAttribute

public static java.lang.String getLastNameAttribute()

Get the value of the Lastname Attribute.

Returns:

the value of the property.

getPasswordAttribute

public static java.lang.String getPasswordAttribute()

Get the value of the Password Attribute.

Returns:

the value of the property.

getEmailAttribute

public static java.lang.String getEmailAttribute()

Get the value of the E-Mail Attribute.

Returns:

the value of the property.