edu.internet2.middleware.ldappc
Interface LdappcConfig

All Known Implementing Classes:
ConfigManager

public interface LdappcConfig


Nested Class Summary
static class LdappcConfig.GroupDNStructure
          Indicates creating either a flat or bushy Group DN structure.
 
Field Summary
static String GROUPER_ID_ATTRIBUTE
          Grouper group id attribute.
static String GROUPER_NAME_ATTRIBUTE
          Grouper group name attribute.
 
Method Summary
 Map<String,List<String>> getAttributeResolverMapping()
          This method returns a possibly empty Map of the AttributeResolver attribute name to LDAP attribute name mapping.
 String getAttributeResolverMappingLdapEmptyValue(String ldapAttribute)
          This gets the value to store in the ldap attribute if there are no AttributeResolver attribute values to store there.
 Set<String> getAttributeResolverMappingObjectClass()
          This gets the LDAP objectclass the Group entry must have to support the AttributeResolver attribute to LDAP attribute mapping.
 boolean getBundleModifications()
          Returns true if a group's attribute modifications should be performed in one LDAP operation.
 boolean getCreateGroupThenModifyMembers()
          Returns true if the group should be created without members followed by a modification which adds member attributes, defaults to false.
 Map<String,List<String>> getGroupAttributeMapping()
          This method returns a possibly empty Map of the Group attribute name to LDAP attribute name mapping.
 String getGroupAttributeMappingLdapEmptyValue(String ldapAttribute)
          This gets the value to store in the ldap attribute if there are no grouper attribute values to store there.
 Set<String> getGroupAttributeMappingObjectClass()
          This gets the LDAP objectclass the Group entry must have to support the Grouper attribute to LDAP attribute mapping.
 Map getGroupAttrMatchingQueries()
          This method returns a possibly empty Map of the Group attribute name/value pairs for creating matching queries.
 String getGroupDnGrouperAttribute()
          This returns the Grouper group attribute whose value is the Group RND value.
 String getGroupDnObjectClass()
          Returns the object class for the Group entry.
 String getGroupDnRdnAttribute()
          Returns the RDN attribute name for the Group entry.
 String getGroupDnRoot()
          This returns the DN of the root entry being used for Group DNs.
 LdappcConfig.GroupDNStructure getGroupDnStructure()
          This returns the defined Group DN structure.
 int getGroupHashEstimate()
          Get the group hash table size estimate.
 String getGroupMembersDnListAttribute()
          This gets the LDAP entry attribute containing the list of Member DNs which belong to the Group.
 String getGroupMembersDnListEmptyValue()
          This gets the value to store in the group member DN list attribute if there are no member DNs to store there.
 String getGroupMembersDnListObjectClass()
          This gets the object class to be added to the Group LDAP entry so support the Group members Dn list attribute.
 String getGroupMembersNameListAttribute()
          This gets the LDAP entry attribute containing the list of Member names which belong to the Group.
 String getGroupMembersNameListEmptyValue()
          This gets the value to store in the group member name list attribute if there are no member names to store there.
 String getGroupMembersNameListNamingAttribute(String source)
          This method returns the Subject attribute name for creating the Member's name for the given source name.
 Map getGroupMembersNameListNamingAttributes()
          This method returns a possibly empty Map of the Group members name list source to subject attribute mapping used to determine a members name.
 String getGroupMembersNameListObjectClass()
          This gets the object class to be added to the Group LDAP entry so support the Group members name list attribute.
 Set getGroupSubordinateStemQueries()
          This method returns a possibly empty Set of the Group stems for creating subordinate stem queries.
 Hashtable getLdapContextParameters()
          This method returns a Hashtable of the LDAP parameters defined to create the InitialContext.
 String getMemberGroupsListAttribute()
          This gets the LDAP entry attribute name containing the list of Groups to which a Member belongs.
 String getMemberGroupsListObjectClass()
          This returns the object class the Member's LDAP entry must have to support the member groups list attribute.
 String getMemberGroupsListTemporaryDirectory()
          Directory for the membership updates temporary file.
 String getMemberGroupsNamingAttribute()
          This gets the Grouper Group naming attribute to be used when creating the list of Groups to which Member belongs.
 boolean getProvisionGroupsTwoStep()
          Returns true if groups should be provisioned in two steps.
 boolean getProvisionMemberGroups()
          Returns true if member groups should be provisioned as members, false otherwise.
 boolean getProvisionMemberGroupsIgnoreQueries()
          Returns true if member groups should be provisioned even if they are not in the set of groups to be provisioned, which reproduces the behavior of LDAPPC prior to 1.5.0.
 Set<String> getResolverQueries()
          This method returns a possibly empty Set of the attribute resolver data connector ids for returning the groups to be provisioned.
 int getSourceSubjectHashEstimate(String source)
          This returns the size estimate for a hash table containing the subjects in this source that will be provisioned.
 Map<String,Integer> getSourceSubjectHashEstimates()
          This returns a Map of size estimate for a hash table containing the subjects in this source that will be provisioned.
 LdapSearchFilter getSourceSubjectLdapFilter(String source)
          This returns the Subject LDAP filter for the given Source for the Source Subject identifiers.
 Map<String,LdapSearchFilter> getSourceSubjectLdapFilters()
          This returns a Map of the Source to Subject LDAP filters for the Source Subject identifiers.
 String getSourceSubjectNamingAttribute(String source)
          This returns the Subject naming attribute for the given Source for the Source Subject identifiers.
 Map getSourceSubjectNamingAttributes()
          This returns a Map of the Source to Subject naming attribute for the Source Subject identifiers.
 boolean isGroupMembersDnListed()
          This returns a boolean indicating if a Group Members LDAP entry DN list is to be maintained on the Groups LDAP entry.
 boolean isGroupMembersNameListed()
          This returns a boolean indicating if a Group Members name list is to be maintained on the Groups LDAP entry.
 boolean isMemberGroupsListed()
          This returns a boolean indicating if Member Groups list is to be maintained.
 boolean useRangeSearchResultHandler()
          Returns true if the RangeSearchResultHandler should be used to process attributes returned from LDAP searches.
 

Field Detail

GROUPER_ID_ATTRIBUTE

static final String GROUPER_ID_ATTRIBUTE
Grouper group id attribute.

See Also:
Constant Field Values

GROUPER_NAME_ATTRIBUTE

static final String GROUPER_NAME_ATTRIBUTE
Grouper group name attribute.

See Also:
Constant Field Values
Method Detail

getGroupHashEstimate

int getGroupHashEstimate()
Get the group hash table size estimate.

Returns:
Size of hash table estimate for holding cached subject data.

getGroupAttrMatchingQueries

Map getGroupAttrMatchingQueries()
This method returns a possibly empty Map of the Group attribute name/value pairs for creating matching queries. The key for the map is the attribute name, and the value is a Set of the attribute value strings.

Returns:
Map of the attribute name to the Set of values.

getGroupSubordinateStemQueries

Set getGroupSubordinateStemQueries()
This method returns a possibly empty Set of the Group stems for creating subordinate stem queries.

Returns:
Set of Group stem strings.

getResolverQueries

Set<String> getResolverQueries()
This method returns a possibly empty Set of the attribute resolver data connector ids for returning the groups to be provisioned.

Returns:
Set of Group stem strings.

getGroupDnStructure

LdappcConfig.GroupDNStructure getGroupDnStructure()
This returns the defined Group DN structure.

Returns:
Group DN structure.

getGroupDnRoot

String getGroupDnRoot()
This returns the DN of the root entry being used for Group DNs.

Returns:
DN of the root entry

getGroupDnObjectClass

String getGroupDnObjectClass()
Returns the object class for the Group entry.

Returns:
Object class for a Group

getGroupDnRdnAttribute

String getGroupDnRdnAttribute()
Returns the RDN attribute name for the Group entry.

Returns:
RDN attribute name for the Group entry

getGroupDnGrouperAttribute

String getGroupDnGrouperAttribute()
This returns the Grouper group attribute whose value is the Group RND value.

Returns:
The Grouper group attribute whose value is the RND value

isMemberGroupsListed

boolean isMemberGroupsListed()
This returns a boolean indicating if Member Groups list is to be maintained.

Returns:
true if the Groups to which a Member belongs are listed, and false otherwise
See Also:
getMemberGroupsListAttribute(), getMemberGroupsNamingAttribute()

getMemberGroupsListObjectClass

String getMemberGroupsListObjectClass()
This returns the object class the Member's LDAP entry must have to support the member groups list attribute. If isMemberGroupsListed() returns false, the value defined here has no meaning.

Returns:
Object class name or null if not defined.

getMemberGroupsListAttribute

String getMemberGroupsListAttribute()
This gets the LDAP entry attribute name containing the list of Groups to which a Member belongs.

Returns:
Name of the LDAP entry attribute containing the list of Groups to which a Member belongs.

getMemberGroupsListTemporaryDirectory

String getMemberGroupsListTemporaryDirectory()
Directory for the membership updates temporary file. The default value is null, causing the files to be placed in the current directory.

Returns:
the temporary directory.

getMemberGroupsNamingAttribute

String getMemberGroupsNamingAttribute()
This gets the Grouper Group naming attribute to be used when creating the list of Groups to which Member belongs.

Returns:
Grouper Group naming attribute to be used to create the list of Groups to which a Member belongs.

isGroupMembersDnListed

boolean isGroupMembersDnListed()
This returns a boolean indicating if a Group Members LDAP entry DN list is to be maintained on the Groups LDAP entry.

Returns:
true if the DNs of Members which belong to the Group are listed, and false otherwise
See Also:
getGroupMembersDnListObjectClass(), getGroupMembersDnListAttribute()

getGroupMembersDnListObjectClass

String getGroupMembersDnListObjectClass()
This gets the object class to be added to the Group LDAP entry so support the Group members Dn list attribute. If isGroupMembersDnListed() returns false, the value defined here has no meaning.

Returns:
Group members Dn list object class, or null if not defined.

getGroupMembersDnListAttribute

String getGroupMembersDnListAttribute()
This gets the LDAP entry attribute containing the list of Member DNs which belong to the Group. If isGroupMembersDnListed() returns false, the value defined here has no meaning.

Returns:
LDAP entry attribute containing the list of Members DNs which belong to the Group.

getGroupMembersDnListEmptyValue

String getGroupMembersDnListEmptyValue()
This gets the value to store in the group member DN list attribute if there are no member DNs to store there.

Returns:
String to place in the group members DN list attribute if no DNs are found to store there, or null if not defined.

isGroupMembersNameListed

boolean isGroupMembersNameListed()
This returns a boolean indicating if a Group Members name list is to be maintained on the Groups LDAP entry.

Returns:
true if the names of Members which belong to the Group are listed, and false otherwise
See Also:
getGroupMembersNameListAttribute(), getGroupMembersNameListNamingAttribute(String)

getGroupMembersNameListObjectClass

String getGroupMembersNameListObjectClass()
This gets the object class to be added to the Group LDAP entry so support the Group members name list attribute.

Returns:
Group members name list LDAP object class, or null if not defined.

getGroupMembersNameListAttribute

String getGroupMembersNameListAttribute()
This gets the LDAP entry attribute containing the list of Member names which belong to the Group.

Returns:
LDAP entry attribute containing the list of Member names which belong to the Group.

getGroupMembersNameListEmptyValue

String getGroupMembersNameListEmptyValue()
This gets the value to store in the group member name list attribute if there are no member names to store there.

Returns:
String to place in the group members name list attribute if no names are found to store there, or null if not defined.

getGroupMembersNameListNamingAttribute

String getGroupMembersNameListNamingAttribute(String source)
This method returns the Subject attribute name for creating the Member's name for the given source name.

Parameters:
source - Source name
Returns:
Subject attribute name for the source, or null if the source was not found.

getGroupMembersNameListNamingAttributes

Map getGroupMembersNameListNamingAttributes()
This method returns a possibly empty Map of the Group members name list source to subject attribute mapping used to determine a members name.

Returns:
Map of Source names to Subject attribute names.

getGroupAttributeMappingObjectClass

Set<String> getGroupAttributeMappingObjectClass()
This gets the LDAP objectclass the Group entry must have to support the Grouper attribute to LDAP attribute mapping.

Returns:
LDAP object class or null if not defined.

getGroupAttributeMapping

Map<String,List<String>> getGroupAttributeMapping()
This method returns a possibly empty Map of the Group attribute name to LDAP attribute name mapping.

Returns:
Map of Group attribute names to LDAP attribute names.

getGroupAttributeMappingLdapEmptyValue

String getGroupAttributeMappingLdapEmptyValue(String ldapAttribute)
This gets the value to store in the ldap attribute if there are no grouper attribute values to store there.

Parameters:
ldapAttribute - Name of the Ldap Attribute
Returns:
String to place in the ldap attribute if no Grouper attribute values are found to store there, or null if not defined.

getCreateGroupThenModifyMembers

boolean getCreateGroupThenModifyMembers()
Returns true if the group should be created without members followed by a modification which adds member attributes, defaults to false.

Returns:
true if the group should be created without members followed by a modification which adds member attributes, defaults to false

getSourceSubjectNamingAttributes

Map getSourceSubjectNamingAttributes()
This returns a Map of the Source to Subject naming attribute for the Source Subject identifiers.

Returns:
Map of Source Subject naming attribute name/value pairs.

getSourceSubjectNamingAttribute

String getSourceSubjectNamingAttribute(String source)
This returns the Subject naming attribute for the given Source for the Source Subject identifiers.

Parameters:
source - Source name
Returns:
Subject naming attribute name or null if the Source is not found

getSourceSubjectLdapFilters

Map<String,LdapSearchFilter> getSourceSubjectLdapFilters()
This returns a Map of the Source to Subject LDAP filters for the Source Subject identifiers.

Returns:
Map of Source Subject LDAP filter name/value pairs.

getSourceSubjectLdapFilter

LdapSearchFilter getSourceSubjectLdapFilter(String source)
This returns the Subject LDAP filter for the given Source for the Source Subject identifiers.

Parameters:
source - Source name
Returns:
Subject LDAP filter or null if the Source is not found

getSourceSubjectHashEstimates

Map<String,Integer> getSourceSubjectHashEstimates()
This returns a Map of size estimate for a hash table containing the subjects in this source that will be provisioned.

Returns:
size estimate for a hash table.

getSourceSubjectHashEstimate

int getSourceSubjectHashEstimate(String source)
This returns the size estimate for a hash table containing the subjects in this source that will be provisioned.

Parameters:
source - Source name
Returns:
size estimate for a hash table.

getLdapContextParameters

Hashtable getLdapContextParameters()
This method returns a Hashtable of the LDAP parameters defined to create the InitialContext. Each of the parameter names from the configuration file that match, ignoring case, a constant name from LdapContext have been converted to the actual value of the LdapContext constant. This allows the returned Hashtable to be used directly when creating an initial context.

Returns:
Hashtable with the LDAP initial context parameters.

getProvisionMemberGroups

boolean getProvisionMemberGroups()
Returns true if member groups should be provisioned as members, false otherwise. True by default. A member group is a group which is a member of another group. This method effectively replaces the "g:gsa" source-subject-identifier.

Returns:
true if member groups should be provisioned as members.

getProvisionGroupsTwoStep

boolean getProvisionGroupsTwoStep()
Returns true if groups should be provisioned in two steps. The first step provisions all groups without any members. The second step provisions all groups with members. If false, LDAPPC will log errors when provisioning groups which have other groups as members which have not been provisioned yet. True by default.

Returns:
true if groups should be provisioned in two steps.

getBundleModifications

boolean getBundleModifications()
Returns true if a group's attribute modifications should be performed in one LDAP operation. If false, each group attribute modification is performed as a separate LDAP operation. True by default.

Returns:
true if attribute modifications should be bundled

getAttributeResolverMappingObjectClass

Set<String> getAttributeResolverMappingObjectClass()
This gets the LDAP objectclass the Group entry must have to support the AttributeResolver attribute to LDAP attribute mapping.

Returns:
LDAP object class or null if not defined.

getAttributeResolverMapping

Map<String,List<String>> getAttributeResolverMapping()
This method returns a possibly empty Map of the AttributeResolver attribute name to LDAP attribute name mapping.

Returns:
Map of AttributeResolver attribute names to LDAP attribute names.

getAttributeResolverMappingLdapEmptyValue

String getAttributeResolverMappingLdapEmptyValue(String ldapAttribute)
This gets the value to store in the ldap attribute if there are no AttributeResolver attribute values to store there.

Parameters:
ldapAttribute - Name of the Ldap Attribute
Returns:
String to place in the ldap attribute if no AttributeResolver attribute values are found to store there, or null if not defined.

useRangeSearchResultHandler

boolean useRangeSearchResultHandler()
Returns true if the RangeSearchResultHandler should be used to process attributes returned from LDAP searches. See http://code.google.com/p/vt-middleware/wiki/vtldapAD

Returns:
true if "range" attributes should be incrementally retrieved

getProvisionMemberGroupsIgnoreQueries

boolean getProvisionMemberGroupsIgnoreQueries()
Returns true if member groups should be provisioned even if they are not in the set of groups to be provisioned, which reproduces the behavior of LDAPPC prior to 1.5.0. Defaults to false, which means that member groups are provisioned only if they are in the set of groups to be provisioned. Ignored unless getProvisionMemberGroups() is true.

Returns:
true if non-selected member groups should be provisioned


Copyright © 2011 Internet2. All Rights Reserved.