jenkins.security.plugins.ldap

Class LDAPConfiguration

java.lang.Object

hudson.model.AbstractDescribableImpl<LDAPConfiguration>

jenkins.security.plugins.ldap.LDAPConfiguration

All Implemented Interfaces:

hudson.model.Describable<LDAPConfiguration>

public class LDAPConfiguration
extends hudson.model.AbstractDescribableImpl<LDAPConfiguration>

A configuration for one ldap connection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPConfiguration.LDAPConfigurationDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECURITY_REALM_LDAPBIND_GROOVY

Constructor Summary

Constructors

Constructor and Description
LDAPConfiguration(String server, String rootDN, boolean inhibitInferRootDN, String managerDN, hudson.util.Secret managerPasswordSecret)

Method Summary

Modifier and Type	Method and Description
org.springframework.web.context.WebApplicationContext	createApplicationContext(LDAPSecurityRealm realm, boolean usePotentialUserProvidedBinding)
String	getDisplayNameAttributeName()
LDAPSecurityRealm.EnvironmentProperty[]	getEnvironmentProperties()
Map<String,String>	getExtraEnvVars()
LDAPGroupMembershipStrategy	getGroupMembershipStrategy()
String	getGroupSearchBase() This defines the organizational unit that contains groups.
String	getGroupSearchFilter() Query to locate an entry that identifies the group, given the group name string.
String	getId()
static File	getLdapBindOverrideFile(jenkins.model.Jenkins jenkins)
org.acegisecurity.ldap.LdapTemplate	getLdapTemplate()
String	getLDAPURL()
String	getMailAddressAttributeName()
String	getManagerDN() If non-null, we use this and getManagerPassword() when binding to LDAP.
String	getManagerPassword() Password used to first bind to LDAP.
hudson.util.Secret	getManagerPasswordSecret()
String	getRootDN() The root DN to connect to.
String	getServer() LDAP server name(s) separated by spaces, optionally with TCP port number, like "ldap.acme.org" or "ldap.acme.org:389" and/or with protcol, like "ldap://ldap.acme.org".
String	getServerUrl()
String	getUserSearch() Query to locate an entry that identifies the user, given the user name string.
String	getUserSearchBase() Specifies the relative DN from the root DN.
boolean	isConfiguration(String id)
boolean	isInhibitInferRootDN() Allow the rootDN to be inferred? Default is false.
void	setDisplayNameAttributeName(String displayNameAttributeName)
void	setEnvironmentProperties(LDAPSecurityRealm.EnvironmentProperty[] environmentProperties)
void	setExtraEnvVars(Map<String,String> extraEnvVars)
void	setGroupMembershipStrategy(LDAPGroupMembershipStrategy groupMembershipStrategy)
void	setGroupSearchBase(String groupSearchBase) This defines the organizational unit that contains groups.
void	setGroupSearchFilter(String groupSearchFilter) Query to locate an entry that identifies the group, given the group name string.
void	setMailAddressAttributeName(String mailAddressAttributeName)
void	setUserSearch(String userSearch) Query to locate an entry that identifies the user, given the user name string.
void	setUserSearchBase(String userSearchBase) Specifies the relative DN from the root DN.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

SECURITY_REALM_LDAPBIND_GROOVY

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String SECURITY_REALM_LDAPBIND_GROOVY

See Also:

Constant Field Values

Constructor Detail

LDAPConfiguration

@DataBoundConstructor
public LDAPConfiguration(@Nonnull
                                               String server,
                                               String rootDN,
                                               boolean inhibitInferRootDN,
                                               String managerDN,
                                               hudson.util.Secret managerPasswordSecret)

Method Detail

getServer

public String getServer()

LDAP server name(s) separated by spaces, optionally with TCP port number, like "ldap.acme.org" or "ldap.acme.org:389" and/or with protcol, like "ldap://ldap.acme.org".

getServerUrl

public String getServerUrl()

getRootDN

public String getRootDN()

The root DN to connect to. Normally something like "dc=sun,dc=com"

getLDAPURL

public String getLDAPURL()

isInhibitInferRootDN

public boolean isInhibitInferRootDN()

Allow the rootDN to be inferred? Default is false. If true, allow rootDN to be blank.

getUserSearchBase

public String getUserSearchBase()

Specifies the relative DN from the root DN. This is used to narrow down the search space when doing user search. Something like "ou=people" but can be empty.

setUserSearchBase

@DataBoundSetter
public void setUserSearchBase(String userSearchBase)

Specifies the relative DN from the root DN. This is used to narrow down the search space when doing user search. Something like "ou=people" but can be empty.

getUserSearch

public String getUserSearch()

Query to locate an entry that identifies the user, given the user name string. Normally "uid={0}"

See Also:

FilterBasedLdapUserSearch

setUserSearch

@DataBoundSetter
public void setUserSearch(String userSearch)

Query to locate an entry that identifies the user, given the user name string. Normally "uid={0}"

See Also:

FilterBasedLdapUserSearch

getGroupSearchBase

public String getGroupSearchBase()

This defines the organizational unit that contains groups. Normally "" to indicate the full LDAP search, but can be often narrowed down to something like "ou=groups"

See Also:

FilterBasedLdapUserSearch

setGroupSearchBase

@DataBoundSetter
public void setGroupSearchBase(String groupSearchBase)

This defines the organizational unit that contains groups. Normally "" to indicate the full LDAP search, but can be often narrowed down to something like "ou=groups"

See Also:

FilterBasedLdapUserSearch

getGroupSearchFilter

public String getGroupSearchFilter()

Query to locate an entry that identifies the group, given the group name string. If non-null it will override the default specified by LDAPSecurityRealm.GROUP_SEARCH

setGroupSearchFilter

@DataBoundSetter
public void setGroupSearchFilter(String groupSearchFilter)

Query to locate an entry that identifies the group, given the group name string. If non-null it will override the default specified by LDAPSecurityRealm.GROUP_SEARCH

getGroupMembershipStrategy

public LDAPGroupMembershipStrategy getGroupMembershipStrategy()

setGroupMembershipStrategy

@DataBoundSetter
public void setGroupMembershipStrategy(LDAPGroupMembershipStrategy groupMembershipStrategy)

getManagerDN

public String getManagerDN()

If non-null, we use this and getManagerPassword() when binding to LDAP. This is necessary when LDAP doesn't support anonymous access.

getManagerPassword

public String getManagerPassword()

Password used to first bind to LDAP.

getManagerPasswordSecret

public hudson.util.Secret getManagerPasswordSecret()

getDisplayNameAttributeName

public String getDisplayNameAttributeName()

setDisplayNameAttributeName

@DataBoundSetter
public void setDisplayNameAttributeName(String displayNameAttributeName)

getMailAddressAttributeName

public String getMailAddressAttributeName()

setMailAddressAttributeName

@DataBoundSetter
public void setMailAddressAttributeName(String mailAddressAttributeName)

getExtraEnvVars

public Map<String,String> getExtraEnvVars()

setExtraEnvVars

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public void setExtraEnvVars(Map<String,String> extraEnvVars)

getEnvironmentProperties

public LDAPSecurityRealm.EnvironmentProperty[] getEnvironmentProperties()

setEnvironmentProperties

@DataBoundSetter
public void setEnvironmentProperties(LDAPSecurityRealm.EnvironmentProperty[] environmentProperties)

getId

public String getId()

isConfiguration

public boolean isConfiguration(String id)

createApplicationContext

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.springframework.web.context.WebApplicationContext createApplicationContext(LDAPSecurityRealm realm,
                                                                                                                                                             boolean usePotentialUserProvidedBinding)

getLdapTemplate

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public org.acegisecurity.ldap.LdapTemplate getLdapTemplate()

getLdapBindOverrideFile

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static File getLdapBindOverrideFile(jenkins.model.Jenkins jenkins)