com.buildforge.services.common.dbo
Class LdapDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.LdapDBO

public class LdapDBO
extends DBObject

Database information representing the configuration of an LDAP domain.


Nested Class Summary
static class LdapDBO.LdapProperty
           
 
Field Summary
static java.lang.String ADMIN_CN_KEY
           
static java.lang.String ADMIN_PASSWORD_KEY
           
static java.lang.String AUTHORIZED_GROUP_DN_KEY
           
static java.lang.String BIND_USER_ACCOUNT_KEY
           
static java.lang.String DISPLAY_NAME_KEY
           
static java.lang.String DISTINGUISHED_NAME_KEY
           
static java.lang.String GROUP_NAME_KEY
           
static java.lang.String GROUP_SEARCH_BASE_KEY
           
static java.lang.String GROUP_UNIQUE_IDENTIFIER_KEY
           
static java.lang.String HOST_KEY
           
static java.lang.String MAIL_NAME_KEY
           
static java.lang.String MAP_ACCESS_GROUPS_KEY
           
static java.lang.String NO
           
static java.lang.String PROTOCOL_KEY
           
static java.lang.String SEARCH_BASE_KEY
           
static java.lang.String SEARCHES_SHOULD_RECURSE_KEY
           
static java.lang.String TYPE_KEY
           
static java.lang.String UNIQUE_IDENTIFIER_KEY
           
static java.lang.String YES
           
 
Constructor Summary
LdapDBO()
           
 
Method Summary
 LdapDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 java.lang.String get(LdapDBO.LdapProperty prop)
           
 java.lang.String getAdminCN()
           
 java.lang.String getAuthorizedGroupDN()
           
 boolean getBindUserAccount()
           
 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 getLiveDomain()
           
 java.lang.String getMailName()
           
 boolean getMapAccessGroups()
           
 java.lang.String getProtocol()
           
 java.lang.String getSearchBase()
           
 boolean getSearchesShouldRecurse()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getUniqueIdentifier()
           
 boolean isLive()
          Checks whether or not the object is live.
static void sanityCheck(java.lang.String domain)
           
 void set(LdapDBO.LdapProperty prop, java.lang.String value)
           
 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 setLiveDomain(java.lang.String liveDomain)
           
 void setMailName(java.lang.String mailName)
           
 void setMapAccessGroups(boolean mapAccessGroups)
           
 void setProtocol(java.lang.String protocol)
           
 void setSearchBase(java.lang.String searchBase)
           
 void setSearchesShouldRecurse(boolean shouldRecurse)
           
 void setUniqueIdentifier(java.lang.String uniqueIdentifier)
           
 java.lang.Object[] toArray()
          Serializes this database object as an array of objects.
 java.lang.String toString()
           
 
Methods inherited from class com.buildforge.services.common.dbo.DBObject
badId, badName, checkDead, checkLive, collision, collision
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values

YES

public static final java.lang.String YES
See Also:
Constant Field Values

NO

public static final java.lang.String NO
See Also:
Constant Field Values

ADMIN_CN_KEY

public static final java.lang.String ADMIN_CN_KEY
See Also:
Constant Field Values

ADMIN_PASSWORD_KEY

public static final java.lang.String ADMIN_PASSWORD_KEY
See Also:
Constant Field Values

AUTHORIZED_GROUP_DN_KEY

public static final java.lang.String AUTHORIZED_GROUP_DN_KEY
See Also:
Constant Field Values

BIND_USER_ACCOUNT_KEY

public static final java.lang.String BIND_USER_ACCOUNT_KEY
See Also:
Constant Field Values

DISPLAY_NAME_KEY

public static final java.lang.String DISPLAY_NAME_KEY
See Also:
Constant Field Values

DISTINGUISHED_NAME_KEY

public static final java.lang.String DISTINGUISHED_NAME_KEY
See Also:
Constant Field Values

GROUP_SEARCH_BASE_KEY

public static final java.lang.String GROUP_SEARCH_BASE_KEY
See Also:
Constant Field Values

GROUP_UNIQUE_IDENTIFIER_KEY

public static final java.lang.String GROUP_UNIQUE_IDENTIFIER_KEY
See Also:
Constant Field Values

GROUP_NAME_KEY

public static final java.lang.String GROUP_NAME_KEY
See Also:
Constant Field Values

HOST_KEY

public static final java.lang.String HOST_KEY
See Also:
Constant Field Values

MAIL_NAME_KEY

public static final java.lang.String MAIL_NAME_KEY
See Also:
Constant Field Values

MAP_ACCESS_GROUPS_KEY

public static final java.lang.String MAP_ACCESS_GROUPS_KEY
See Also:
Constant Field Values

PROTOCOL_KEY

public static final java.lang.String PROTOCOL_KEY
See Also:
Constant Field Values

SEARCH_BASE_KEY

public static final java.lang.String SEARCH_BASE_KEY
See Also:
Constant Field Values

SEARCHES_SHOULD_RECURSE_KEY

public static final java.lang.String SEARCHES_SHOULD_RECURSE_KEY
See Also:
Constant Field Values

UNIQUE_IDENTIFIER_KEY

public static final java.lang.String UNIQUE_IDENTIFIER_KEY
See Also:
Constant Field Values
Constructor Detail

LdapDBO

public LdapDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

get

public java.lang.String get(LdapDBO.LdapProperty prop)

set

public void set(LdapDBO.LdapProperty prop,
                java.lang.String value)

getAdminCN

public java.lang.String getAdminCN()

getAuthorizedGroupDN

public java.lang.String getAuthorizedGroupDN()

getBindUserAccount

public boolean getBindUserAccount()

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()

getLiveDomain

public java.lang.String getLiveDomain()

getMailName

public java.lang.String getMailName()

getMapAccessGroups

public boolean getMapAccessGroups()

getProtocol

public java.lang.String getProtocol()

getSearchBase

public java.lang.String getSearchBase()

getSearchesShouldRecurse

public boolean getSearchesShouldRecurse()

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)

setLiveDomain

public void setLiveDomain(java.lang.String liveDomain)

setMailName

public void setMailName(java.lang.String mailName)

setMapAccessGroups

public void setMapAccessGroups(boolean mapAccessGroups)

setProtocol

public void setProtocol(java.lang.String protocol)

setSearchBase

public void setSearchBase(java.lang.String searchBase)

setSearchesShouldRecurse

public void setSearchesShouldRecurse(boolean shouldRecurse)

setUniqueIdentifier

public void setUniqueIdentifier(java.lang.String uniqueIdentifier)

sanityCheck

public static void sanityCheck(java.lang.String domain)
                        throws APIException
Throws:
APIException

toString

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

fromArray

public LdapDBO fromArray(java.lang.Object[] data)
                  throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
APIException - if there is something wrong with the serialized data that interferes with the reconstruction of the object. The most obvious reason for this would be if the serialized array contains the wrong number of fields or otherwise does not match the serialized form for this type of database object.

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject