com.jalios.ldap
Class LDAPConfiguration

java.lang.Object
  com.jalios.ldap.LDAPConfiguration

public class LDAPConfiguration
extends Object

Field Summary

protected boolean	enabled
protected String	groupFilter
protected String	groupObjectClass
protected String	groupSuffix
protected String	hostname
protected boolean	isSSL
protected boolean	isUsingPosixGroup
static String	LDAP_ENABLED
static String	LDAP_SERVER_GROUP_FILTER
static String	LDAP_SERVER_GROUP_OBJECTCLASS
static String	LDAP_SERVER_GROUP_SUFFIX
static String	LDAP_SERVER_HOSTNAME
static String	LDAP_SERVER_LOGIN
static String	LDAP_SERVER_PASSWORD
static String	LDAP_SERVER_PORT
static String	LDAP_SERVER_SIZE_LIMIT
static String	LDAP_SERVER_SSL
static String	LDAP_SERVER_SUFFIX
static String	LDAP_SERVER_TIME_LIMIT
static String	LDAP_SERVER_USER_FILTER
static String	LDAP_SERVER_USER_OBJECTCLASS
static String	LDAP_SERVER_VERSION
static String	LDAP_SYNCHRONIZE
static String	LDAP_SYNCHRONIZE_GROUPS
protected String	login
protected String	password
protected int	port
static String	REVISION
protected int	sizeLimit
protected String	suffix
protected boolean	synchronize
protected boolean	synchronizeGroups
protected int	timeLimit
protected String	userFilter
protected String	userObjectClass
protected int	version

Constructor Summary

LDAPConfiguration(JProperties props)

Method Summary

String	getGroupFilter()
String	getGroupObjectClass()
String	getGroupSuffix()
String	getHostname()
String	getLogin()
String	getPassword()
int	getPort()
int	getSizeLimit()
String	getSuffix()
boolean	getSynchronize()
boolean	getSynchronizeGroups()
int	getTimeLimit()
String	getUserFilter()
String	getUserObjectClass()
int	getVersion()
boolean	isEnabled()
boolean	isSSL()
boolean	isUsingPosixGroup()
protected void	readProperties(JProperties prop)
void	setGroupFilter(String groupFilter)
void	setGroupObjectClass(String groupObjectClass)
void	setLogin(String login)
void	setPassword(String password)
void	setUserFilter(String userFilter)
void	setUserObjectClass(String userObjectClass)

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

LDAP_ENABLED

public static final String LDAP_ENABLED

See Also:

Constant Field Values

LDAP_SYNCHRONIZE

public static final String LDAP_SYNCHRONIZE

See Also:

Constant Field Values

LDAP_SYNCHRONIZE_GROUPS

public static final String LDAP_SYNCHRONIZE_GROUPS

See Also:

Constant Field Values

LDAP_SERVER_SSL

public static final String LDAP_SERVER_SSL

See Also:

Constant Field Values

LDAP_SERVER_HOSTNAME

public static final String LDAP_SERVER_HOSTNAME

See Also:

Constant Field Values

LDAP_SERVER_LOGIN

public static final String LDAP_SERVER_LOGIN

See Also:

Constant Field Values

LDAP_SERVER_PORT

public static final String LDAP_SERVER_PORT

See Also:

Constant Field Values

LDAP_SERVER_SIZE_LIMIT

public static final String LDAP_SERVER_SIZE_LIMIT

See Also:

Constant Field Values

LDAP_SERVER_TIME_LIMIT

public static final String LDAP_SERVER_TIME_LIMIT

See Also:

Constant Field Values

LDAP_SERVER_VERSION

public static final String LDAP_SERVER_VERSION

See Also:

Constant Field Values

LDAP_SERVER_PASSWORD

public static final String LDAP_SERVER_PASSWORD

See Also:

Constant Field Values

LDAP_SERVER_SUFFIX

public static final String LDAP_SERVER_SUFFIX

See Also:

Constant Field Values

LDAP_SERVER_USER_FILTER

public static final String LDAP_SERVER_USER_FILTER

See Also:

Constant Field Values

LDAP_SERVER_USER_OBJECTCLASS

public static final String LDAP_SERVER_USER_OBJECTCLASS

See Also:

Constant Field Values

LDAP_SERVER_GROUP_SUFFIX

public static final String LDAP_SERVER_GROUP_SUFFIX

See Also:

Constant Field Values

LDAP_SERVER_GROUP_FILTER

public static final String LDAP_SERVER_GROUP_FILTER

See Also:

Constant Field Values

LDAP_SERVER_GROUP_OBJECTCLASS

public static final String LDAP_SERVER_GROUP_OBJECTCLASS

See Also:

Constant Field Values

enabled

protected boolean enabled

synchronize

protected boolean synchronize

synchronizeGroups

protected boolean synchronizeGroups

hostname

protected String hostname

login

protected String login

password

protected String password

port

protected int port

sizeLimit

protected int sizeLimit

timeLimit

protected int timeLimit

version

protected int version

isSSL

protected boolean isSSL

suffix

protected String suffix

userFilter

protected String userFilter

userObjectClass

protected String userObjectClass

groupSuffix

protected String groupSuffix

groupFilter

protected String groupFilter

groupObjectClass

protected String groupObjectClass

isUsingPosixGroup

protected boolean isUsingPosixGroup

Constructor Detail

LDAPConfiguration

public LDAPConfiguration(JProperties props)

Method Detail

readProperties

protected void readProperties(JProperties prop)

isEnabled

public boolean isEnabled()

Returns:

true if LDAP is enabled for this configuration.

getSynchronize

public boolean getSynchronize()

Returns:

true if the user being retrieve from ldap should be synchronized in JCMS.

getSynchronizeGroups

public boolean getSynchronizeGroups()

Returns:

true if the LDAP groups of the user being retrieve from LDAP should be synchronized in JCMS.

isSSL

public boolean isSSL()

Returns:

true if SSL in enabled for this configuration

getHostname

public String getHostname()

Returns:

the hostname of the LDAP Server for this configuration

getLogin

public String getLogin()

Returns:

the DN that should be used to connect/bind/authenticated to the LDAP server.

getPassword

public String getPassword()

Returns:

the password that should be used to connect/bind/authenticated to the LDAP server.

setPassword

public void setPassword(String password)

setLogin

public void setLogin(String login)

getPort

public int getPort()

Returns:

the port number that should be used to connect to the LDAP server.

getSizeLimit

public int getSizeLimit()

Returns:

the size limit value that should be used during connection to the LDAP server, it defines the maximum number of result that can be retrieved during a search.

getTimeLimit

public int getTimeLimit()

Returns:

the time limit value that should be used during connection to the LDAP server, it defines the maximum number of milliseconds to wait for an operation to complete.

getVersion

public int getVersion()

Returns:

the protocol version to use to connect to the LDAP server.

getSuffix

public String getSuffix()

Returns:

the base DN that should be used when searching users in the LDAP.

getUserFilter

public String getUserFilter()

Returns:

a String that should be processed by the method MessageFormat.format(java.lang.String, java.lang.Object[]) and used to search for users in the LDAP.

setUserFilter

public void setUserFilter(String userFilter)

getUserObjectClass

public String getUserObjectClass()

Returns:

the objectClass value which defines that a LDAPEntry is a user.

Since:

jcms-5.7

setUserObjectClass

public void setUserObjectClass(String userObjectClass)

getGroupSuffix

public String getGroupSuffix()

Returns:

the base DN that should be used when searching groups in the LDAP.

Since:

jcms-5.7

getGroupFilter

public String getGroupFilter()

Returns:

a String that should be processed by the method MessageFormat.format(java.lang.String, java.lang.Object[]) and used to search for groups in the LDAP.

Since:

jcms-5.7

setGroupFilter

public void setGroupFilter(String groupFilter)

getGroupObjectClass

public String getGroupObjectClass()

Returns:

the objectClass value which defines that a LDAPEntry is a group.

Since:

jcms-5.7

setGroupObjectClass

public void setGroupObjectClass(String groupObjectClass)

isUsingPosixGroup

public boolean isUsingPosixGroup()

Returns:

true if the settings of this LDAPConfiguration define that the group being used is a posixGroup (groupObjectClass is "posixGroup" and groupFilter contains "memberUid").

Since:

jcms-5.7