hudson.plugins.active_directory

Class ActiveDirectoryDomain

java.lang.Object

hudson.model.AbstractDescribableImpl<ActiveDirectoryDomain>

hudson.plugins.active_directory.ActiveDirectoryDomain

All Implemented Interfaces:

hudson.model.Describable<ActiveDirectoryDomain>, Serializable

public class ActiveDirectoryDomain
extends hudson.model.AbstractDescribableImpl<ActiveDirectoryDomain>
implements Serializable

Represents an Active Directory domain with its Domain Controllers Easily allows you to match Domains with Domains Controllers

Since:

2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActiveDirectoryDomain.Catalog
static class	ActiveDirectoryDomain.DescriptorImpl

Field Summary

Fields

Modifier and Type	Field and Description
String	bindName If non-null, use this name and password to bind to LDAP to obtain the DN of the user trying to login.
hudson.util.Secret	bindPassword
String	name Domain name
String	servers If non-null, Jenkins will try to connect at this server at the first priority, before falling back to discovered DNS servers.
String	site Active directory site (which specifies the physical concentration of the servers), if any.

Constructor Summary

Constructors

Constructor and Description
ActiveDirectoryDomain(String name, String servers)
ActiveDirectoryDomain(String name, String servers, String site, String bindName, String bindPassword)

Method Summary

Modifier and Type	Method and Description
DirContext	createDNSLookupContext() Creates DirContext for accesssing DNS.
static String	fixEmpty(String s) Convert empty string to null.
String	getBindName()
hudson.util.Secret	getBindPassword()
String	getName()
Attribute	getRecordFromDomain() Get the record from a domain
String	getServers()
Attribute	getServersOnCatalog(String catalog) Get the list of servers which compose the ActiveDirectoryDomain.Catalog The ActiveDirectoryDomain.Catalog can be gc or ldap.
String	getSite()

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

name

public String name

Domain name

When this plugin is used on Windows, this field is null, and we use ADSI and ADO through com4j to perform authentication.

OTOH, when this plugin runs on non-Windows, this field must be non-null, and we'll use LDAP for authentication.

servers

public String servers

If non-null, Jenkins will try to connect at this server at the first priority, before falling back to discovered DNS servers.

site

public String site

Active directory site (which specifies the physical concentration of the servers), if any. If the value is non-null, we'll only contact servers in this site.

On Windows, I'm assuming ADSI takes care of everything automatically.

bindName

public String bindName

If non-null, use this name and password to bind to LDAP to obtain the DN of the user trying to login. This is unnecessary in a single-domain mode, where we can just bind with the user name and password provided during the login, but in a forest mode, without some known credential, we cannot figure out which domain in the forest the user belongs to.

bindPassword

public hudson.util.Secret bindPassword

Constructor Detail

ActiveDirectoryDomain

public ActiveDirectoryDomain(String name,
                             String servers)

ActiveDirectoryDomain

@DataBoundConstructor
public ActiveDirectoryDomain(String name,
                                                   String servers,
                                                   String site,
                                                   String bindName,
                                                   String bindPassword)

Method Detail

getName

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getName()

getServers

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getServers()

getBindName

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getBindName()

getBindPassword

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public hudson.util.Secret getBindPassword()

getSite

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getSite()

getRecordFromDomain

public Attribute getRecordFromDomain()

Get the record from a domain

Returns:

the record of a domain

createDNSLookupContext

public DirContext createDNSLookupContext()
                                  throws NamingException

Creates DirContext for accesssing DNS.

Throws:

NamingException

getServersOnCatalog

public Attribute getServersOnCatalog(String catalog)

Get the list of servers which compose the ActiveDirectoryDomain.Catalog The ActiveDirectoryDomain.Catalog can be gc or ldap.

Returns:

the list of servers in the selected ActiveDirectoryDomain.Catalog

fixEmpty

public static String fixEmpty(String s)

Convert empty string to null.