edu.internet2.middleware.ldappc
Class ConfigManager

java.lang.Object
  extended by edu.internet2.middleware.ldappc.ConfigManager
All Implemented Interfaces:
LdappcConfig

public class ConfigManager
extends Object
implements LdappcConfig

Class for accessing values from the Auth2Ldap configuration file.


Nested Class Summary
 
Nested classes/interfaces inherited from interface edu.internet2.middleware.ldappc.LdappcConfig
LdappcConfig.GroupDNStructure
 
Field Summary
static String CONFIG_FILE_RESOURCE
          Default configuration file resource name.
static String JAXP_SCHEMA_LANGUAGE
          JAXP schema language property name.
static String JAXP_SCHEMA_SOURCE
          JAXP schema source property name.
static String PROPERTIES_FILE_RESOURCE
          Default properties file resource name.
static String PROPERTY_USE_RANGE_HANDLER
          Property which defines whether or not the range search result handler is used
static String SCHEMA_FILE_RESOURCE
          Configuration Schema file resource name.
static String W3C_XML_SCHEMA
          JAXP schema language value for W3C XML Schema.
 
Fields inherited from interface edu.internet2.middleware.ldappc.LdappcConfig
GROUPER_ID_ATTRIBUTE, GROUPER_NAME_ATTRIBUTE
 
Constructor Summary
ConfigManager()
           
ConfigManager(String pathToConfig)
          Constructs an instance of ConfigManager using the configuration file identified by the uri.
ConfigManager(String pathToConfig, String pathToProperties)
          Constructs an instance of ConfigManager using the given configuration file and properties file
 
Method Summary
 void addSubjectHashEstimate(String source, int size)
          Sets the estimated size for a hash table listing groups to populate.
 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 sets objectclass that a Group entry must have in order to support the AttributeResolver attribute to LDAP attribute.
 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 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 name of the object class for the Group entry when getGroupDnStructure() returns LdappcConfig#GROUP_DN_FLAT .
 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.
static URL getSystemResourceURL(String resource, boolean isRequired)
          This returns a URL created by ClassLoader.getSystemResource(java.lang.String) for resource.
 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 isRootElementFound()
          This method returns true if the root element of the configuration file was encountered.
 Iterator listSaxParseErrors()
          This method returns the list, possibly empty, of the SAXParseExceptions created while parsing the configuration file.
 void resetGroupSubordinateStemQueries()
          This method returns a new empty Set of the Group stems for creating subordinate stem queries.
protected  void setBundleModifications(Boolean bundleModifications)
           
protected  void setGroupDnStructure(LdappcConfig.GroupDNStructure structure)
           
 void setGroupHashEstimate(int size)
          Sets the estimated size for a hash table listing groups to populate.
protected  void setProvisionGroupsTwoStep(Boolean provisionGroupsTwoStep)
           
protected  void setProvisionMemberGroups(Boolean provisionMemberGroups)
           
protected  void setProvisionMemberGroupsIgnoreQueries(Boolean provisionMemberGroupsIgnoreQueries)
           
 boolean useRangeSearchResultHandler()
          Returns true if the RangeSearchResultHandler should be used to process attributes returned from LDAP searches.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONFIG_FILE_RESOURCE

public static final String CONFIG_FILE_RESOURCE
Default configuration file resource name.

See Also:
Constant Field Values

PROPERTIES_FILE_RESOURCE

public static final String PROPERTIES_FILE_RESOURCE
Default properties file resource name.

See Also:
Constant Field Values

SCHEMA_FILE_RESOURCE

public static final String SCHEMA_FILE_RESOURCE
Configuration Schema file resource name.

See Also:
Constant Field Values

JAXP_SCHEMA_LANGUAGE

public static final String JAXP_SCHEMA_LANGUAGE
JAXP schema language property name.

See Also:
Constant Field Values

JAXP_SCHEMA_SOURCE

public static final String JAXP_SCHEMA_SOURCE
JAXP schema source property name.

See Also:
Constant Field Values

W3C_XML_SCHEMA

public static final String W3C_XML_SCHEMA
JAXP schema language value for W3C XML Schema.

See Also:
Constant Field Values

PROPERTY_USE_RANGE_HANDLER

public static final String PROPERTY_USE_RANGE_HANDLER
Property which defines whether or not the range search result handler is used

See Also:
Constant Field Values
Constructor Detail

ConfigManager

public ConfigManager()
              throws ConfigurationException
Throws:
ConfigurationException

ConfigManager

public ConfigManager(String pathToConfig)
              throws ConfigurationException
Constructs an instance of ConfigManager using the configuration file identified by the uri. Constructor is private to enforce singleton pattern.

Parameters:
pathToConfig - path to configuration file
Throws:
ConfigurationException - thrown if an error occurs loading the instance from the given uri.

ConfigManager

public ConfigManager(String pathToConfig,
                     String pathToProperties)
              throws ConfigurationException
Constructs an instance of ConfigManager using the given configuration file and properties file

Parameters:
pathToConfig - path to configuration file
ldappcPropertiesFile - path to properties file
Throws:
ConfigurationException
Method Detail

listSaxParseErrors

public Iterator listSaxParseErrors()
This method returns the list, possibly empty, of the SAXParseExceptions created while parsing the configuration file.

Returns:
Vector of SAXParseExceptions

getSystemResourceURL

public static URL getSystemResourceURL(String resource,
                                       boolean isRequired)
                                throws ConfigurationException
This returns a URL created by ClassLoader.getSystemResource(java.lang.String) for resource. If the resource is not found (i.e., URL is null) and isRequired is true, this throws a ConfigurationException.

Parameters:
resource - The resource name
isRequired - Boolean indicating if the resource is required
Returns:
URL for the resource, possibly a null value.
Throws:
ConfigurationException - thrown as defined above.

getLdapContextParameters

public 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.

Specified by:
getLdapContextParameters in interface LdappcConfig
Returns:
Hashtable with the LDAP initial context parameters.

getGroupAttrMatchingQueries

public 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.

Specified by:
getGroupAttrMatchingQueries in interface LdappcConfig
Returns:
Map of the attribute name to the Set of values.

getGroupSubordinateStemQueries

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

Specified by:
getGroupSubordinateStemQueries in interface LdappcConfig
Returns:
Set of Group stem strings.

resetGroupSubordinateStemQueries

public void resetGroupSubordinateStemQueries()
This method returns a new empty Set of the Group stems for creating subordinate stem queries. It is used only for testing to override the ldappc.xml file values.


getGroupDnStructure

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

Specified by:
getGroupDnStructure in interface LdappcConfig
Returns:
Group DN structure, either edu.internet2.middleware.ldappc.LdappcConfig#GROUP_DN_FLAT or edu.internet2.middleware.ldappc.LdappcConfig#GROUP_DN_BUSHY

setGroupDnStructure

protected void setGroupDnStructure(LdappcConfig.GroupDNStructure structure)

getGroupDnRoot

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

Specified by:
getGroupDnRoot in interface LdappcConfig
Returns:
DN of the root entry

getGroupDnObjectClass

public String getGroupDnObjectClass()
Returns the name of the object class for the Group entry when getGroupDnStructure() returns LdappcConfig#GROUP_DN_FLAT .

Specified by:
getGroupDnObjectClass in interface LdappcConfig
Returns:
Name of the object class for a Group

getGroupDnRdnAttribute

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

Specified by:
getGroupDnRdnAttribute in interface LdappcConfig
Returns:
RDN attribute name for the Group entry

getGroupDnGrouperAttribute

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

Specified by:
getGroupDnGrouperAttribute in interface LdappcConfig
Returns:
The Grouper group attribute whose value is the RND value

getGroupAttributeMappingObjectClass

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

Specified by:
getGroupAttributeMappingObjectClass in interface LdappcConfig
Returns:
LDAP object class or null if not defined.

getGroupAttributeMapping

public Map getGroupAttributeMapping()
This method returns a possibly empty Map of the Group attribute name to LDAP attribute name mapping.

Specified by:
getGroupAttributeMapping in interface LdappcConfig
Returns:
Map of Group attribute names to LDAP attribute names.

getGroupAttributeMappingLdapEmptyValue

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

Specified by:
getGroupAttributeMappingLdapEmptyValue in interface LdappcConfig
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.

getSourceSubjectNamingAttributes

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

Specified by:
getSourceSubjectNamingAttributes in interface LdappcConfig
Returns:
Map of Source Subject naming attribute name/value pairs.

getSourceSubjectNamingAttribute

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

Specified by:
getSourceSubjectNamingAttribute in interface LdappcConfig
Parameters:
source - Source name
Returns:
Subject naming attribute name or null if the Source is not found

getSourceSubjectLdapFilters

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

Specified by:
getSourceSubjectLdapFilters in interface LdappcConfig
Returns:
Map of Source Subject LDAP filter name/value pairs.

addSubjectHashEstimate

public void addSubjectHashEstimate(String source,
                                   int size)
Sets the estimated size for a hash table listing groups to populate.

Parameters:
source - Source name.
size - Estimated cache size for this source.

getSourceSubjectHashEstimates

public 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.

Specified by:
getSourceSubjectHashEstimates in interface LdappcConfig
Returns:
size estimate for a hash table.

getSourceSubjectHashEstimate

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

Specified by:
getSourceSubjectHashEstimate in interface LdappcConfig
Parameters:
source - Source name
Returns:
size estimate for a hash table.

getSourceSubjectLdapFilter

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

Specified by:
getSourceSubjectLdapFilter in interface LdappcConfig
Parameters:
source - Source name
Returns:
Subject LDAP filter or null if the Source is not found

setGroupHashEstimate

public void setGroupHashEstimate(int size)
Sets the estimated size for a hash table listing groups to populate.

Parameters:
size - Estimated cache size.

getGroupHashEstimate

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

Specified by:
getGroupHashEstimate in interface LdappcConfig
Returns:
Size of hash table estimate for holding cached subject data.

isMemberGroupsListed

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

Specified by:
isMemberGroupsListed in interface LdappcConfig
Returns:
true if the Groups to which a Member belongs are listed, and false otherwise
See Also:
getMemberGroupsListAttribute(), getMemberGroupsNamingAttribute()

getMemberGroupsListObjectClass

public 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.

Specified by:
getMemberGroupsListObjectClass in interface LdappcConfig
Returns:
Object class name or null if not defined.

getMemberGroupsListAttribute

public String getMemberGroupsListAttribute()
This gets the LDAP entry attribute name containing the list of Groups to which a Member belongs. If isMemberGroupsListed() returns false, the value defined here has no meaning.

Specified by:
getMemberGroupsListAttribute in interface LdappcConfig
Returns:
Name of the LDAP entry attribute containing the list of Groups to which a Member belongs.

getMemberGroupsNamingAttribute

public String getMemberGroupsNamingAttribute()
This gets the Grouper Group naming attribute to be used when creating the list of Groups to which Member belongs. If isMemberGroupsListed() returns false, the value defined here has no meaning.

Specified by:
getMemberGroupsNamingAttribute in interface LdappcConfig
Returns:
Grouper Group naming attribute to be used to create the list of Groups to which a Member belongs.

getMemberGroupsListTemporaryDirectory

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

Specified by:
getMemberGroupsListTemporaryDirectory in interface LdappcConfig
Returns:
the temporary directory.

isGroupMembersDnListed

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

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

getGroupMembersDnListObjectClass

public 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.

Specified by:
getGroupMembersDnListObjectClass in interface LdappcConfig
Returns:
Group members Dn list object class or null if not defined.

getGroupMembersDnListAttribute

public 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.

Specified by:
getGroupMembersDnListAttribute in interface LdappcConfig
Returns:
LDAP entry attribute containing the list of Members DNs which belong to the Group.

getGroupMembersDnListEmptyValue

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

Specified by:
getGroupMembersDnListEmptyValue in interface LdappcConfig
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

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

Specified by:
isGroupMembersNameListed in interface LdappcConfig
Returns:
true if the names of Members which belong to the Group are listed, and false otherwise
See Also:
getGroupMembersNameListAttribute(), getGroupMembersNameListObjectClass(), getGroupMembersNameListNamingAttribute(String), getGroupMembersNameListNamingAttributes()

getGroupMembersNameListObjectClass

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

Specified by:
getGroupMembersNameListObjectClass in interface LdappcConfig
Returns:
Group members name list object class or null if not defined.

getGroupMembersNameListAttribute

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

Specified by:
getGroupMembersNameListAttribute in interface LdappcConfig
Returns:
LDAP entry attribute containing the list of Members names which belong to the Group.

getGroupMembersNameListEmptyValue

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

Specified by:
getGroupMembersNameListEmptyValue in interface LdappcConfig
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

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

Specified by:
getGroupMembersNameListNamingAttribute in interface LdappcConfig
Parameters:
source - Source name
Returns:
Subject attribute name for the source, or null if the source was not found.

getGroupMembersNameListNamingAttributes

public 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.

Specified by:
getGroupMembersNameListNamingAttributes in interface LdappcConfig
Returns:
Map of Source names to Subject attribute names.

isRootElementFound

public boolean isRootElementFound()
This method returns true if the root element of the configuration file was encountered.

Returns:
true if root element encountered, and false otherwise.

getCreateGroupThenModifyMembers

public boolean getCreateGroupThenModifyMembers()
Description copied from interface: LdappcConfig
Returns true if the group should be created without members followed by a modification which adds member attributes, defaults to false.

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

getProvisionMemberGroups

public boolean getProvisionMemberGroups()
Description copied from interface: LdappcConfig
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.

Specified by:
getProvisionMemberGroups in interface LdappcConfig
Returns:
true if member groups should be provisioned as members.

setProvisionMemberGroups

protected void setProvisionMemberGroups(Boolean provisionMemberGroups)

getProvisionGroupsTwoStep

public boolean getProvisionGroupsTwoStep()
Description copied from interface: LdappcConfig
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.

Specified by:
getProvisionGroupsTwoStep in interface LdappcConfig
Returns:
true if groups should be provisioned in two steps.

setProvisionGroupsTwoStep

protected void setProvisionGroupsTwoStep(Boolean provisionGroupsTwoStep)

getBundleModifications

public boolean getBundleModifications()
Description copied from interface: LdappcConfig
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.

Specified by:
getBundleModifications in interface LdappcConfig
Returns:
true if attribute modifications should be bundled

setBundleModifications

protected void setBundleModifications(Boolean bundleModifications)

getAttributeResolverMapping

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

Specified by:
getAttributeResolverMapping in interface LdappcConfig
Returns:
Map of Group attribute names to LDAP attribute names.

getAttributeResolverMappingLdapEmptyValue

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

Specified by:
getAttributeResolverMappingLdapEmptyValue in interface LdappcConfig
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.

getAttributeResolverMappingObjectClass

public Set<String> getAttributeResolverMappingObjectClass()
This sets objectclass that a Group entry must have in order to support the AttributeResolver attribute to LDAP attribute.

Specified by:
getAttributeResolverMappingObjectClass in interface LdappcConfig
Parameters:
objectClass - Object class to support the AttributeResolver attribute to LDAP attribute map
Returns:
LDAP object class or null if not defined.

useRangeSearchResultHandler

public boolean useRangeSearchResultHandler()
Description copied from interface: LdappcConfig
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

Specified by:
useRangeSearchResultHandler in interface LdappcConfig
Returns:
true if "range" attributes should be incrementally retrieved
See Also:
LdappcConfig.useRangeSearchResultHandler()

getProvisionMemberGroupsIgnoreQueries

public boolean getProvisionMemberGroupsIgnoreQueries()
Description copied from interface: LdappcConfig
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 LdappcConfig.getProvisionMemberGroups() is true.

Specified by:
getProvisionMemberGroupsIgnoreQueries in interface LdappcConfig
Returns:
true if non-selected member groups should be provisioned

setProvisionMemberGroupsIgnoreQueries

protected void setProvisionMemberGroupsIgnoreQueries(Boolean provisionMemberGroupsIgnoreQueries)

getResolverQueries

public Set<String> getResolverQueries()
Description copied from interface: LdappcConfig
This method returns a possibly empty Set of the attribute resolver data connector ids for returning the groups to be provisioned.

Specified by:
getResolverQueries in interface LdappcConfig
Returns:
Set of Group stem strings.


Copyright © 2011 Internet2. All Rights Reserved.