toolbox.ldap
Class EntryDefinition

Package class diagram package EntryDefinition
java.lang.Object
  extended by toolbox.ldap.EntryDefinition

public class EntryDefinition
extends java.lang.Object

Class that describes a supported LDAP entry.

The definition will carry the object class attribute values of the entry, the bind attribute name and an optional collection of attributes with default values.


Constructor Summary
EntryDefinition(java.lang.String name, java.lang.String bindAttr, java.util.List ocList, java.util.Map defaults)
          Construct a new definition.
 
Method Summary
 java.lang.String getBindAttribute()
          Return the name of the attribute that must be used to bind entries of this type.
 java.util.Set getDefaultAttributes()
          Return the Set of attribute names that have default values available.
 java.util.Set getDefaultValues(java.lang.String attrName)
          Return the Set of default values for the named attribute.
 java.lang.String getName()
          Return the name of this definition.
 java.util.List getObjectClass()
          Return the List of object class values that define entries of this type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EntryDefinition

public EntryDefinition(java.lang.String name,
                       java.lang.String bindAttr,
                       java.util.List ocList,
                       java.util.Map defaults)
Construct a new definition.

Parameters:
name - String containing the name of this definition.
bindAttr - String containing the name of the attribute that must to bind entries of this type to the directory.
ocList - List containing the object class names that define entries of this type.
defaults - Map containing a collection of default attribute values.
Method Detail

getName

public java.lang.String getName()
Return the name of this definition.

Returns:
String containing the name of this definition.

getBindAttribute

public java.lang.String getBindAttribute()
Return the name of the attribute that must be used to bind entries of this type.

Returns:
String containing bind attribute name.

getObjectClass

public java.util.List getObjectClass()
Return the List of object class values that define entries of this type.

Returns:
List containing object class values.

getDefaultValues

public java.util.Set getDefaultValues(java.lang.String attrName)
Return the Set of default values for the named attribute.

Parameters:
attrName - String containing the attribute name.
Returns:
Set of default values or null if none are available.

getDefaultAttributes

public java.util.Set getDefaultAttributes()
Return the Set of attribute names that have default values available.

Returns:
Set containing attribute names.