psdi.security.ldap

Class GroupSettings

  • java.lang.Object
    • psdi.security.ldap.GroupSettings


  • public class GroupSettings
    extends java.lang.Object
    A class to indicate group settings configured.
    • Constructor Summary

      Constructors 
      Constructor and Description
      GroupSettings() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addAttribute(java.lang.String attribute)
      Adds the given attribute to the list of attributes.
      java.lang.String[] getAttributeArray()
      Returns the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server.
      java.util.Iterator getAttributes()
      Returns the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server, in an Iterator.
      java.lang.String getBaseDN()
      Returns the base distinguished name of the group hierarchy to be used for search.
      DataMap getDataMap()
      Returns the data mapping for the groups as defined in the configuration file.
      MemberDataMap getMemberDataMap()
      Returns the group member data mapping as defined in the configuration file.
      java.lang.String getSearchFilter()
      Returns the search filter to be used to search for group objects that need to be synchronized to MAXIMO tables.
      java.lang.String getSearchScope()
      Returns the search scope to be used for group searches.
      int getSearchScopeAsInt()
      Returns the search scope to be used for user searches.
      void setAttributes(java.util.Set attributesSet)
      Sets the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server.
      void setBaseDN(java.lang.String string)
      Sets the base distinguished name of the group hierarchy to be used for search.
      void setDataMap(DataMap dataMap)
      Sets the data mapping for the groups as defined in the configuration file.
      void setMemberDataMap(MemberDataMap memberDataMap)
      Sets the the group member data mapping as defined in the configuration file.
      void setSearchFilter(java.lang.String string)
      Sets the search filter to be used to search for groups.
      void setSearchScope(java.lang.String string)
      Sets the search scope to be used for group searches.
      java.lang.String toString()
      Returns the data in string representation for debug purpose.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • GroupSettings

        public GroupSettings()
    • Method Detail

      • getBaseDN

        public java.lang.String getBaseDN()
        Returns the base distinguished name of the group hierarchy to be used for search.
        Returns:
        the base distinguished name of the group hierarchy.
      • setBaseDN

        public void setBaseDN(java.lang.String string)
        Sets the base distinguished name of the group hierarchy to be used for search.
        Parameters:
        string - the base distinguished name of the group hierarchy
      • getSearchFilter

        public java.lang.String getSearchFilter()
        Returns the search filter to be used to search for group objects that need to be synchronized to MAXIMO tables.
        Returns:
        the search filter to be used to search for group objects.
      • setSearchFilter

        public void setSearchFilter(java.lang.String string)
        Sets the search filter to be used to search for groups.
        Parameters:
        string - the search filter to be used to search for groups.
      • getSearchScope

        public java.lang.String getSearchScope()
        Returns the search scope to be used for group searches.
        Returns:
        the search scope to be used for group searches.
      • getSearchScopeAsInt

        public int getSearchScopeAsInt()
        Returns the search scope to be used for user searches. Possible values javax.naming.directory.SearchControls.ONELEVEL_SCOPE javax.naming.directory.SearchControls.SUBTREE_SCOPE
        Returns:
        the search scope to be used for user searches.
      • setSearchScope

        public void setSearchScope(java.lang.String string)
        Sets the search scope to be used for group searches.
        Parameters:
        string - the search scope to be used for group searches.
      • getAttributes

        public java.util.Iterator getAttributes()
        Returns the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server, in an Iterator.
        Returns:
        an iterator to iterate over the list of attributes.
      • getAttributeArray

        public java.lang.String[] getAttributeArray()
        Returns the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server.
        Returns:
        the list of attributes.
      • setAttributes

        public void setAttributes(java.util.Set attributesSet)
        Sets the list of attributes that should be included in the LDAP search, for which data is expected to be returned from the LDAP server.
        Parameters:
        attributesSet - list of attributes.
      • addAttribute

        public void addAttribute(java.lang.String attribute)
        Adds the given attribute to the list of attributes.
        Parameters:
        attribute - attribute to be added to the list of attributes.
      • getDataMap

        public DataMap getDataMap()
        Returns the data mapping for the groups as defined in the configuration file.
        Returns:
        the data mapping for the groups as defined in the configuration file.
      • setDataMap

        public void setDataMap(DataMap dataMap)
        Sets the data mapping for the groups as defined in the configuration file.
        Parameters:
        dataMap - the data mapping for the groups.
      • getMemberDataMap

        public MemberDataMap getMemberDataMap()
        Returns the group member data mapping as defined in the configuration file.
        Returns:
        the group member data mapping.
      • setMemberDataMap

        public void setMemberDataMap(MemberDataMap memberDataMap)
        Sets the the group member data mapping as defined in the configuration file.
        Parameters:
        memberDataMap - the group member data mapping.
      • toString

        public java.lang.String toString()
        Returns the data in string representation for debug purpose.
        Overrides:
        toString in class java.lang.Object