com.esri.gpt.framework.security.identity.ldap
Class LdapGroupProperties

java.lang.Object
  com.esri.gpt.framework.security.identity.ldap.LdapProperties
      com.esri.gpt.framework.security.identity.ldap.LdapGroupProperties

public class LdapGroupProperties
extends LdapProperties

Defines the configured properties for LDAP group access.

Constructor Summary

LdapGroupProperties()
Default constructor.

Method Summary

void	addGroupObjectClass(String className) Adds group objects that will be used for creating groups.
String	getGroupDisplayNameAttribute() Get the display name attribute for a group.
String	getGroupDynamicMemberAttribute() Gets the attribute used to dynamically determine the groups for a user.
String	getGroupDynamicMembersAttribute() Gets the attribute to dynamically determine the members of a group.
String	getGroupMemberAttribute() Gets the attribute name for a member within a group.
String	getGroupMemberSearchPattern() Gets the group member search pattern.
String	getGroupNameSearchPattern() Gets the group name search pattern.
Attribute	getGroupObjectClasses() Gets the required group object classes.
String	getGroupSearchDIT() Gets the root directory where searching of groups will take place.
String	returnGroupMemberSearchFilter(String memberDN) Returns the search filter for finding a member within a group.
String	returnGroupNameSearchFilter(String name) Returns the search filter for finding a group based upon a name.
void	setGroupDisplayNameAttribute(String attributeName) Set the display name attribute for a group.
void	setGroupDynamicMemberAttribute(String attribute) Sets the attribute used to dynamically determine the groups for a user.
void	setGroupDynamicMembersAttribute(String attribute) Sets the attribute used to dynamically determine the members of a group.
void	setGroupMemberAttribute(String attributeName) Sets the attribute name for a member within a group.
void	setGroupMemberSearchPattern(String pattern) Sets the group member search pattern.
void	setGroupNameSearchPattern(String pattern) Sets the group name search pattern.
void	setGroupSearchDIT(String dit) Sets the root directory where searching of groups will take place.
String	toString() Returns the string representation of the object.

Methods inherited from class com.esri.gpt.framework.security.identity.ldap.LdapProperties

hasSpecialDNCharacter, replace, replaceParam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LdapGroupProperties

public LdapGroupProperties()

Default constructor.

Method Detail

getGroupDisplayNameAttribute

public String getGroupDisplayNameAttribute()

Get the display name attribute for a group.

Returns:

the attribute name

setGroupDisplayNameAttribute

public void setGroupDisplayNameAttribute(String attributeName)

Set the display name attribute for a group.

Parameters:

attributeName - the attribute name

getGroupDynamicMemberAttribute

public String getGroupDynamicMemberAttribute()

Gets the attribute used to dynamically determine the groups for a user.
If specified, a user's group membership is dynamically determined by searching this attribute.
Examples: ibm-allgroups for Tivoli, nsRole for IPlanet, etc

Returns:

the attribute used for dynamic group searches (zero length if none)

setGroupDynamicMemberAttribute

public void setGroupDynamicMemberAttribute(String attribute)

Sets the attribute used to dynamically determine the groups for a user.
If specified, a user's group membership is dynamically determined by searching this attribute.
Examples: ibm-allgroups for Tivoli, nsRole for IPlanet, etc

Parameters:

attribute - the attribute used for dynamic group searches

getGroupDynamicMembersAttribute

public String getGroupDynamicMembersAttribute()

Gets the attribute to dynamically determine the members of a group.
If specified, the members of a group are dynamically determined by searching this attribute.
Examples: ibm-allmembers for tivoli

Returns:

the attribute used for dynamic group searches (zero length if none)

setGroupDynamicMembersAttribute

public void setGroupDynamicMembersAttribute(String attribute)

Sets the attribute used to dynamically determine the members of a group.
If specified, the members of a group are dynamically determined by searching this attribute.
Examples: ibm-allmembers for Tivoli

Parameters:

attribute - the attribute used for dynamic group searches

getGroupMemberAttribute

public String getGroupMemberAttribute()

Gets the attribute name for a member within a group.

Returns:

the attribute name

setGroupMemberAttribute

public void setGroupMemberAttribute(String attributeName)

Sets the attribute name for a member within a group.

Parameters:

attributeName - the attribute name

getGroupMemberSearchPattern

public String getGroupMemberSearchPattern()

Gets the group member search pattern.
eg. (&(objectclass=groupOfNames)(member={0}))
The intent is to support querying for group membership based upon a members distinguished name.
If a the member's DN is "cn=myname,cn=users,o=esri,c=us" , the {0} section of the pattern will be replaced to produce:
(&(objectclass=groupOfNames)(member=cn=myname,cn=users,o=esri,c=us))
The search for groups will begin at the base DN defined by: getGroupSearchDIT()

Returns:

the group member search pattern

setGroupMemberSearchPattern

public void setGroupMemberSearchPattern(String pattern)

Sets the group member search pattern.
eg. (&(objectclass=groupOfNames)(member={0}))
The intent is to support querying for group membership based upon a members distinguished name.
If a the member's DN is "cn=myname,cn=users,o=esri,c=us" , the {0} section of the pattern will be replaced to produce:
(&(objectclass=groupOfNames)(member=cn=myname,cn=users,o=esri,c=us))
The search for groups will begin at the base DN defined by: getGroupSearchDIT()

Parameters:

pattern - the group member search pattern

getGroupNameSearchPattern

public String getGroupNameSearchPattern()

Gets the group name search pattern.
eg. (&(objectclass=groupOfNames)(cn={0}))
The intent is to support querying for a group based upon a supplied short name.
If the short name is "publishers", the {0} section of the pattern will be replaced to produce:
(&(objectclass=groupOfNames)(cn=publishers))
The search for groups will begin at the base DN defined by: getGroupSearchDIT()

Returns:

the group name search pattern

setGroupNameSearchPattern

public void setGroupNameSearchPattern(String pattern)

Sets the group name search pattern.
eg. (&(objectclass=groupOfNames)(cn={0}))
The intent is to support querying for a group based upon a supplied short name.
If the short name is "publishers", the {0} section of the pattern will be replaced to produce:
(&(objectclass=groupOfNames)(cn=publishers))
The search for groups will begin at the base DN defined by: getGroupSearchDIT()

Parameters:

pattern - the group name search pattern

getGroupObjectClasses

public Attribute getGroupObjectClasses()

Gets the required group object classes.

Returns:

the required group object classes

getGroupSearchDIT

public String getGroupSearchDIT()

Gets the root directory where searching of groups will take place.

Returns:

directory root under which all groups reside

setGroupSearchDIT

public void setGroupSearchDIT(String dit)

Sets the root directory where searching of groups will take place.

Parameters:

dit - directory root under which all groups reside

addGroupObjectClass

public void addGroupObjectClass(String className)

Adds group objects that will be used for creating groups.

Parameters:

className - Class to add to group object to be created

returnGroupMemberSearchFilter

public String returnGroupMemberSearchFilter(String memberDN)

Returns the search filter for finding a member within a group.
The filter will be based upon the configured getGroupMemberSearchPattern().

Parameters:

memberDN - the distinguished name of the member

Returns:

the filter

returnGroupNameSearchFilter

public String returnGroupNameSearchFilter(String name)

Returns the search filter for finding a group based upon a name.
The filter will be based upon the configured getGroupNameSearchPattern().

Parameters:

name - the group name

Returns:

the filter

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string