org.apache.jetspeed.security.spi.impl.ldap
Class LdapBindingConfig

java.lang.Object
  org.apache.jetspeed.security.spi.impl.ldap.LdapBindingConfig

public class LdapBindingConfig
extends Object

Holds the configuration for ldap binding.

Author:

David Le Strat

Field Summary

private LdapContext	context
private String	defaultSearchBase
private String[]	groupAttributes
private String	groupFilter
private String	groupFilterBase
private String	groupIdAttribute
private String	groupMembershipAttributes
private String	groupMembershipForRoleAttributes
private String[]	groupObjectClasses
private String	groupObjectRequiredAttributeClasses
private String	groupUidAttribute
private String	initialContextFactory
private String[]	knownAttributes
private String	ldapScheme
private String	ldapSecurityLevel
private String	ldapSecurityProtocol
private String	ldapServerName
private String	ldapServerPort
private String	ldapSocketFactory
private static org.apache.commons.logging.Log	logger The logger.
private String	memberShipSearchScope
private org.apache.commons.configuration.PropertiesConfiguration	props
private String[]	roleAttributes
private String	roleFilter
private String	roleFilterBase
private String	roleGroupMembershipForRoleAttributes
private String	roleIdAttribute
private String	roleMembershipAttributes
private String[]	roleObjectClasses
private String	roleObjectRequiredAttributeClasses
private String	roleUidAttribute
private String	rootContext
private String	rootDn
private String	rootPassword
private String	uidAttribute
private String[]	userAttributes
private String	userFilter
private String	userFilterBase
private String	userGroupMembershipAttributes
private String	userIdAttribute
private String[]	userObjectClasses
private String	userPasswordAttribute
private String	userRoleMembershipAttributes
private String	userUidAttribute

Constructor Summary

LdapBindingConfig()

LdapBindingConfig(String ldapType)
Default constructor.

LdapBindingConfig(String factory, String name, String port, String context, String dn, String password, String roleFilter, String groupFilter, String userFilter, String roleMembershipAttributes, String userRoleMembershipAttributes, String groupMembershipAttributes, String userGroupMembershipAttributes, String groupMembershipForRoleAttributes, String roleGroupMembershipForRoleAttributes, String defaultSearchBase, String roleFilterBase, String groupFilterBase, String userFilterBase, String roleObjectClasses, String groupObjectClasses, String userObjectClasses, String roleIdAttribute, String groupIdAttribute, String userIdAttribute, String uidAttribute, String memberShipSearchScope, String roleUidAttribute, String groupUidAttribute, String userUidAttribute, String roleObjectRequiredAttributeClasses, String groupObjectRequiredAttributeClasses, String userAttributes, String roleAttributes, String groupAttributes, String userPasswordAttribute, String knownAttributes)

Method Summary

(package private) LdapContext	getContext()
String	getDefaultSearchBase()
String[]	getGroupAttributes()
String	getGroupFilter()
String	getGroupFilterBase()
String	getGroupIdAttribute()
String	getGroupMembershipAttributes()
String	getGroupMembershipForRoleAttributes()
String[]	getGroupObjectClasses()
String	getGroupObjectRequiredAttributeClasses()
String	getGroupUidAttribute()
String	getInitialContextFactory()
String[]	getKnownAttributes()
String	getLdapScheme()
String	getLdapSecurityLevel()
String	getLdapSecurityProtocol()
String	getLdapServerName()
String	getLdapServerPort()
String	getLdapSocketFactory()
String	getMemberShipSearchScope()
String[]	getRoleAttributes()
String	getRoleFilter()
String	getRoleFilterBase()
String	getRoleGroupMembershipForRoleAttributes()
String	getRoleIdAttribute()
String	getRoleMembershipAttributes()
String[]	getRoleObjectClasses()
String	getRoleObjectRequiredAttributeClasses()
String	getRoleUidAttribute()
String	getRootContext()
String	getRootDn()
String	getRootPassword()
String	getUidAttribute()
String[]	getUserAttributes()
String	getUserFilter()
String	getUserFilterBase()
String	getUserGroupMembershipAttributes()
String	getUserIdAttribute()
String[]	getUserObjectClasses()
String	getUserPasswordAttribute()
String	getUserRoleMembershipAttributes()
String	getUserUidAttribute()
(package private) void	setContext(LdapContext context)
void	setDefaultSearchBase(String defaultSearchBase)
void	setGroupAttributes(String[] groupAttributes)
void	setGroupFilter(String groupFilter)
void	setGroupFilterBase(String groupFilterBase)
void	setGroupIdAttribute(String groupIdAttribute)
void	setGroupMembershipAttributes(String groupMembershipAttributes)
void	setGroupMembershipForRoleAttributes(String groupMembershipForRoleAttributes)
void	setGroupObjectClasses(String[] groupObjectClasses)
void	setGroupObjectRequiredAttributeClasses(String groupObjectRequiredAttributeClasses)
void	setGroupUidAttribute(String groupUidAttribute)
void	setInitialContextFactory(String initialContextFactory)
void	setKnownAttributes(String[] knownAttributes)
void	setLdapScheme(String ldapScheme)
void	setLdapSecurityLevel(String ldapSecurityLevel)
void	setLdapSecurityProtocol(String ldapSecurityProtocol)
void	setLdapServerName(String ldapServerName)
void	setLdapServerPort(String ldapServerPort)
void	setLdapSocketFactory(String ldapSocketFactory)
void	setMemberShipSearchScope(String memberShipSearchScope)
void	setRoleAttributes(String[] roleAttributes)
void	setRoleFilter(String roleFilter)
void	setRoleFilterBase(String roleFilterBase)
void	setRoleGroupMembershipForRoleAttributes(String roleGroupMembershipForRoleAttributes)
void	setRoleIdAttribute(String roleIdAttribute)
void	setRoleMembershipAttributes(String roleMembershipAttributes)
void	setRoleObjectClasses(String[] roleObjectClasses)
void	setRoleObjectRequiredAttributeClasses(String roleObjectRequiredAttributeClasses)
void	setRoleUidAttribute(String roleUidAttribute)
void	setRootContext(String rootContext)
void	setRootDn(String rootDn)
void	setRootPassword(String rootPassword)
void	setUidAttribute(String uidAttribute)
void	setUserAttributes(String[] userAttributes)
void	setUserFilter(String userFilter)
void	setUserFilterBase(String userFilterBase)
void	setUserGroupMembershipAttributes(String userGroupMembershipAttributes)
void	setUserIdAttribute(String userIdAttribute)
void	setUserObjectClasses(String[] userObjectClasses)
void	setUserPasswordAttribute(String userPasswordAttribute)
void	setUserRoleMembershipAttributes(String userRoleMembershipAttributes)
void	setUserUidAttribute(String userUidAttribute)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.commons.logging.Log logger

The logger.

context

private LdapContext context

initialContextFactory

private String initialContextFactory

ldapSocketFactory

private String ldapSocketFactory

ldapScheme

private String ldapScheme

ldapServerName

private String ldapServerName

ldapServerPort

private String ldapServerPort

ldapSecurityLevel

private String ldapSecurityLevel

ldapSecurityProtocol

private String ldapSecurityProtocol

rootDn

private String rootDn

rootPassword

private String rootPassword

rootContext

private String rootContext

props

private org.apache.commons.configuration.PropertiesConfiguration props

groupFilter

private String groupFilter

userFilter

private String userFilter

userRoleMembershipAttributes

private String userRoleMembershipAttributes

groupMembershipAttributes

private String groupMembershipAttributes

userGroupMembershipAttributes

private String userGroupMembershipAttributes

defaultSearchBase

private String defaultSearchBase

groupFilterBase

private String groupFilterBase

userFilterBase

private String userFilterBase

groupIdAttribute

private String groupIdAttribute

userIdAttribute

private String userIdAttribute

uidAttribute

private String uidAttribute

memberShipSearchScope

private String memberShipSearchScope

groupObjectClasses

private String[] groupObjectClasses

userObjectClasses

private String[] userObjectClasses

groupMembershipForRoleAttributes

private String groupMembershipForRoleAttributes

groupUidAttribute

private String groupUidAttribute

userUidAttribute

private String userUidAttribute

groupAttributes

private String[] groupAttributes

userAttributes

private String[] userAttributes

groupObjectRequiredAttributeClasses

private String groupObjectRequiredAttributeClasses

roleObjectClasses

private String[] roleObjectClasses

roleGroupMembershipForRoleAttributes

private String roleGroupMembershipForRoleAttributes

roleAttributes

private String[] roleAttributes

roleObjectRequiredAttributeClasses

private String roleObjectRequiredAttributeClasses

roleFilter

private String roleFilter

roleFilterBase

private String roleFilterBase

roleIdAttribute

private String roleIdAttribute

roleUidAttribute

private String roleUidAttribute

roleMembershipAttributes

private String roleMembershipAttributes

userPasswordAttribute

private String userPasswordAttribute

knownAttributes

private String[] knownAttributes

Constructor Detail

LdapBindingConfig

public LdapBindingConfig()

LdapBindingConfig

public LdapBindingConfig(String factory,
                         String name,
                         String port,
                         String context,
                         String dn,
                         String password,
                         String roleFilter,
                         String groupFilter,
                         String userFilter,
                         String roleMembershipAttributes,
                         String userRoleMembershipAttributes,
                         String groupMembershipAttributes,
                         String userGroupMembershipAttributes,
                         String groupMembershipForRoleAttributes,
                         String roleGroupMembershipForRoleAttributes,
                         String defaultSearchBase,
                         String roleFilterBase,
                         String groupFilterBase,
                         String userFilterBase,
                         String roleObjectClasses,
                         String groupObjectClasses,
                         String userObjectClasses,
                         String roleIdAttribute,
                         String groupIdAttribute,
                         String userIdAttribute,
                         String uidAttribute,
                         String memberShipSearchScope,
                         String roleUidAttribute,
                         String groupUidAttribute,
                         String userUidAttribute,
                         String roleObjectRequiredAttributeClasses,
                         String groupObjectRequiredAttributeClasses,
                         String userAttributes,
                         String roleAttributes,
                         String groupAttributes,
                         String userPasswordAttribute,
                         String knownAttributes)

LdapBindingConfig

public LdapBindingConfig(String ldapType)

Default constructor. By default instantiates LdapBindingConfig from JETSPEED-INF/ldap/ldap.properties in the classpath.

Method Detail

getContext

LdapContext getContext()

setContext

void setContext(LdapContext context)

getInitialContextFactory

public String getInitialContextFactory()

Returns:

Returns the initialContextFactory.

setInitialContextFactory

public void setInitialContextFactory(String initialContextFactory)

Parameters:

initialContextFactory - The initialContextFactory to set.

getLdapScheme

public String getLdapScheme()

Returns:

the ldapScheme

setLdapScheme

public void setLdapScheme(String ldapScheme)

Parameters:

ldapScheme - the ldapScheme to set

getLdapSocketFactory

public String getLdapSocketFactory()

Returns:

the ldapSocketFactory

setLdapSocketFactory

public void setLdapSocketFactory(String ldapSocketFactory)

Parameters:

ldapSocketFactory - the ldapSocketFactory to set

getLdapServerName

public String getLdapServerName()

Returns:

Returns the ldapServerName.

setLdapServerName

public void setLdapServerName(String ldapServerName)

Parameters:

ldapServerName - The ldapServerName to set.

getLdapServerPort

public String getLdapServerPort()

Returns:

Returns the ldapServerPort.

setLdapServerPort

public void setLdapServerPort(String ldapServerPort)

Parameters:

ldapServerPort - The ldapServerPort to set.

getLdapSecurityLevel

public String getLdapSecurityLevel()

Returns:

the ldapSecurityLevel

setLdapSecurityLevel

public void setLdapSecurityLevel(String ldapSecurityLevel)

Parameters:

ldapSecurityLevel - the ldapSecurityLevel to set

getLdapSecurityProtocol

public String getLdapSecurityProtocol()

Returns:

the ldapSecurityProtocol

setLdapSecurityProtocol

public void setLdapSecurityProtocol(String ldapSecurityProtocol)

Parameters:

ldapSecurityProtocol - the ldapSecurityProtocol to set

getRootContext

public String getRootContext()

Returns:

Returns the rootContext.

setRootContext

public void setRootContext(String rootContext)

Parameters:

rootContext - The rootContext to set.

getRootDn

public String getRootDn()

Returns:

Returns the rootDn.

setRootDn

public void setRootDn(String rootDn)

Parameters:

rootDn - The rootDn to set.

getRootPassword

public String getRootPassword()

Returns:

Returns the rootPassword.

setRootPassword

public void setRootPassword(String rootPassword)

Parameters:

rootPassword - The rootPassword to set.

getUserFilter

public String getUserFilter()

setUserFilter

public void setUserFilter(String userFilter)

getUserFilterBase

public String getUserFilterBase()

setUserFilterBase

public void setUserFilterBase(String userFilterBase)

getUserGroupMembershipAttributes

public String getUserGroupMembershipAttributes()

setUserGroupMembershipAttributes

public void setUserGroupMembershipAttributes(String userGroupMembershipAttributes)

getUserRoleMembershipAttributes

public String getUserRoleMembershipAttributes()

setUserRoleMembershipAttributes

public void setUserRoleMembershipAttributes(String userRoleMembershipAttributes)

getDefaultSearchBase

public String getDefaultSearchBase()

setDefaultSearchBase

public void setDefaultSearchBase(String defaultSearchBase)

getGroupFilter

public String getGroupFilter()

setGroupFilter

public void setGroupFilter(String groupFilter)

getGroupFilterBase

public String getGroupFilterBase()

setGroupFilterBase

public void setGroupFilterBase(String groupFilterBase)

getGroupMembershipAttributes

public String getGroupMembershipAttributes()

setGroupMembershipAttributes

public void setGroupMembershipAttributes(String groupMembershipAttributes)

getGroupIdAttribute

public String getGroupIdAttribute()

setGroupIdAttribute

public void setGroupIdAttribute(String groupIdAttribute)

getUserIdAttribute

public String getUserIdAttribute()

setUserIdAttribute

public void setUserIdAttribute(String userIdAttribute)

getGroupObjectClasses

public String[] getGroupObjectClasses()

setGroupObjectClasses

public void setGroupObjectClasses(String[] groupObjectClasses)

getUserObjectClasses

public String[] getUserObjectClasses()

setUserObjectClasses

public void setUserObjectClasses(String[] userObjectClasses)

getGroupMembershipForRoleAttributes

public String getGroupMembershipForRoleAttributes()

setGroupMembershipForRoleAttributes

public void setGroupMembershipForRoleAttributes(String groupMembershipForRoleAttributes)

getUidAttribute

public String getUidAttribute()

setUidAttribute

public void setUidAttribute(String uidAttribute)

getMemberShipSearchScope

public String getMemberShipSearchScope()

setMemberShipSearchScope

public void setMemberShipSearchScope(String memberShipSearchScope)

getGroupUidAttribute

public String getGroupUidAttribute()

setGroupUidAttribute

public void setGroupUidAttribute(String groupUidAttribute)

getUserUidAttribute

public String getUserUidAttribute()

setUserUidAttribute

public void setUserUidAttribute(String userUidAttribute)

getGroupObjectRequiredAttributeClasses

public String getGroupObjectRequiredAttributeClasses()

setGroupObjectRequiredAttributeClasses

public void setGroupObjectRequiredAttributeClasses(String groupObjectRequiredAttributeClasses)

getGroupAttributes

public String[] getGroupAttributes()

setGroupAttributes

public void setGroupAttributes(String[] groupAttributes)

getUserAttributes

public String[] getUserAttributes()

setUserAttributes

public void setUserAttributes(String[] userAttributes)

getRoleObjectRequiredAttributeClasses

public String getRoleObjectRequiredAttributeClasses()

setRoleObjectRequiredAttributeClasses

public void setRoleObjectRequiredAttributeClasses(String roleObjectRequiredAttributeClasses)

getRoleAttributes

public String[] getRoleAttributes()

setRoleAttributes

public void setRoleAttributes(String[] roleAttributes)

getRoleObjectClasses

public String[] getRoleObjectClasses()

setRoleObjectClasses

public void setRoleObjectClasses(String[] roleObjectClasses)

getRoleGroupMembershipForRoleAttributes

public String getRoleGroupMembershipForRoleAttributes()

setRoleGroupMembershipForRoleAttributes

public void setRoleGroupMembershipForRoleAttributes(String roleGroupMembershipForRoleAttributes)

getRoleFilter

public String getRoleFilter()

setRoleFilter

public void setRoleFilter(String roleFilter)

getRoleFilterBase

public String getRoleFilterBase()

setRoleFilterBase

public void setRoleFilterBase(String roleFilterBase)

getRoleMembershipAttributes

public String getRoleMembershipAttributes()

setRoleMembershipAttributes

public void setRoleMembershipAttributes(String roleMembershipAttributes)

getRoleUidAttribute

public String getRoleUidAttribute()

setRoleUidAttribute

public void setRoleUidAttribute(String roleUidAttribute)

getRoleIdAttribute

public String getRoleIdAttribute()

setRoleIdAttribute

public void setRoleIdAttribute(String roleIdAttribute)

getUserPasswordAttribute

public String getUserPasswordAttribute()

setUserPasswordAttribute

public void setUserPasswordAttribute(String userPasswordAttribute)

getKnownAttributes

public String[] getKnownAttributes()

setKnownAttributes

public void setKnownAttributes(String[] knownAttributes)