com.buildforge.services.client.dbo
Class LDAP

java.lang.Object
  extended by com.buildforge.services.client.dbo.LDAP

public class LDAP
extends java.lang.Object

An object representing an LDAP domain within the Build Forge system. An LDAP object defines the parameters for connecting to and using a should generally contain no more than a few closely related commands that accomplish a fundamental task that is part of the automated process.

In addition to the command itself, step objects define much of the context within which a command is executed and how that step may interact with other steps that surround it.


Field Summary
static java.lang.Class<LDAP> CLASS
           
 
Constructor Summary
LDAP(APIClientConnection conn)
           
 
Method Summary
 LDAP create()
          Creates this LDAP configuration object in the database
 void delete()
          Removes this LDAP configuration from the database
static java.util.List<java.lang.String> findAllDomains(APIClientConnection conn)
          Finds and returns all LDAP Domains.
static LDAP findByDomain(APIClientConnection conn, java.lang.String domain)
          Finds and returns the LDAP configuration object associated with the provided domain.
 java.lang.String getAdminCN()
          Returns the Administrative CN
 java.lang.String getAuthorizedGroupDN()
          Returns the DN for a listing of groups that are allowed to authenticate
 boolean getBindUserAccount()
          Returns the user account used to bind to the LDAP server
 java.lang.String getDisplayName()
           
 java.lang.String getDistinguishedName()
           
 java.lang.String getDomain()
           
 java.lang.String getEncryptedPassword()
           
 java.lang.String getGroupName()
           
 java.lang.String getGroupsSearchBase()
           
 java.lang.String getGroupsUniqueIdentifier()
           
 java.lang.String getHost()
           
 java.lang.String getMailName()
           
 boolean getMapAccessGroups()
           
 java.lang.String getSearchBase()
           
 java.lang.String getUniqueIdentifier()
           
 void setAdminCN(java.lang.String adminCN)
           
 void setAuthorizedGroupDN(java.lang.String authorizedGroupDN)
           
 void setBindUserAccount(boolean bindUserAccount)
           
 void setDisplayName(java.lang.String displayName)
           
 void setDistinguishedName(java.lang.String distinguishedName)
           
 void setDomain(java.lang.String domain)
           
 void setEncryptedPassword(java.lang.String encryptedPassword)
           
 void setGroupName(java.lang.String groupName)
           
 void setGroupsSearchBase(java.lang.String groupsSearchBase)
           
 void setGroupsUniqueIdentifier(java.lang.String groupsUniqueIdentifier)
           
 void setHost(java.lang.String host)
           
 void setMailName(java.lang.String mailName)
           
 void setMapAccessGroups(boolean mapAccessGroups)
           
 void setSearchBase(java.lang.String searchBase)
           
 void setUniqueIdentifier(java.lang.String uniqueIdentifier)
           
 java.lang.String toString()
           
 LDAP update()
          Commits the current state of this LDAP configuration to the database
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS

public static final java.lang.Class<LDAP> CLASS
Constructor Detail

LDAP

public LDAP(APIClientConnection conn)
Method Detail

findAllDomains

public static java.util.List<java.lang.String> findAllDomains(APIClientConnection conn)
                                                       throws java.io.IOException,
                                                              ServiceException
Finds and returns all LDAP Domains. The returned objects will only have the domain property set, which can be used with findById(APIClientConnection conn, String authId) to retrieve the fully inflated object, if desired.

Parameters:
conn - connection
Returns:
the LDAP domain list
Throws:
java.io.IOException
ServiceException

findByDomain

public static LDAP findByDomain(APIClientConnection conn,
                                java.lang.String domain)
                         throws java.io.IOException,
                                ServiceException
Finds and returns the LDAP configuration object associated with the provided domain.

Parameters:
conn -
domain - The string representing the domain to be retrieved
Returns:
Throws:
java.io.IOException
ServiceException

create

public LDAP create()
            throws java.io.IOException,
                   ServiceException
Creates this LDAP configuration object in the database

Returns:
Throws:
java.io.IOException
ServiceException

update

public LDAP update()
            throws java.io.IOException,
                   ServiceException
Commits the current state of this LDAP configuration to the database

Returns:
Throws:
java.io.IOException
ServiceException

delete

public void delete()
            throws java.io.IOException,
                   ServiceException
Removes this LDAP configuration from the database

Throws:
java.io.IOException
ServiceException

getAdminCN

public java.lang.String getAdminCN()
Returns the Administrative CN


getAuthorizedGroupDN

public java.lang.String getAuthorizedGroupDN()
Returns the DN for a listing of groups that are allowed to authenticate


getBindUserAccount

public boolean getBindUserAccount()
Returns the user account used to bind to the LDAP server


getDisplayName

public java.lang.String getDisplayName()

getDistinguishedName

public java.lang.String getDistinguishedName()

getDomain

public java.lang.String getDomain()

getEncryptedPassword

public java.lang.String getEncryptedPassword()

getGroupName

public java.lang.String getGroupName()

getGroupsSearchBase

public java.lang.String getGroupsSearchBase()

getGroupsUniqueIdentifier

public java.lang.String getGroupsUniqueIdentifier()

getHost

public java.lang.String getHost()

getMailName

public java.lang.String getMailName()

getMapAccessGroups

public boolean getMapAccessGroups()

getSearchBase

public java.lang.String getSearchBase()

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()

setAdminCN

public void setAdminCN(java.lang.String adminCN)

setAuthorizedGroupDN

public void setAuthorizedGroupDN(java.lang.String authorizedGroupDN)

setBindUserAccount

public void setBindUserAccount(boolean bindUserAccount)

setDisplayName

public void setDisplayName(java.lang.String displayName)

setDistinguishedName

public void setDistinguishedName(java.lang.String distinguishedName)

setDomain

public void setDomain(java.lang.String domain)

setEncryptedPassword

public void setEncryptedPassword(java.lang.String encryptedPassword)

setGroupName

public void setGroupName(java.lang.String groupName)

setGroupsSearchBase

public void setGroupsSearchBase(java.lang.String groupsSearchBase)

setGroupsUniqueIdentifier

public void setGroupsUniqueIdentifier(java.lang.String groupsUniqueIdentifier)

setHost

public void setHost(java.lang.String host)

setMailName

public void setMailName(java.lang.String mailName)

setMapAccessGroups

public void setMapAccessGroups(boolean mapAccessGroups)

setSearchBase

public void setSearchBase(java.lang.String searchBase)

setUniqueIdentifier

public void setUniqueIdentifier(java.lang.String uniqueIdentifier)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object