psdi.security.ldap

Class MemberDataMap

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


  • public class MemberDataMap
    extends java.lang.Object
    A class to represent the group member data mapping that's configured in the configuration file used for synchronizing the group members from LDAP Server to MAXIMO database tables.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ALN
      ALN data type.
      static int INTEGER
      INTEGER data type.
      static int LOWER
      LOWER case ALN data tpe.
      static int UPPER
      UPPER case ALN data type.
      static int YORN
      Boolean data type represented as 1 or 0.
    • Constructor Summary

      Constructors 
      Constructor and Description
      MemberDataMap() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addColumnName(java.lang.String column, java.lang.String attribute, java.lang.String type)
      Adds the given column name as a column with the corresponding attribute to be used to retrieve data from LDAP server.
      void addKeyColumnName(java.lang.String column, java.lang.String attribute, java.lang.String type)
      Adds the given column name as a key column with the corresponding attribute to be used to retrieve data from LDAP server.
      java.lang.String getAttribute(java.lang.String column)
      Returns the LDAP attribute that's mapped for the given column name.
      java.util.Iterator getColumnNames()
      Returns an Iterator to iterate over the list of non-key column names.
      java.lang.String getKeyAttribute(java.lang.String column)
      Returns the LDAP attribute that's mapped for the given key column name.
      java.util.Iterator getKeyColumnNames()
      Returns an Iterator to iterate over the list of key column names.
      java.lang.String getMemberAttribute()
      Returns the attribute to be used to retrieve the member data from LDAP server.
      java.lang.String getMemberColumn()
      Returns the column name to be used to store the member information.
      java.lang.String getMemberColumnType()
      Returns the data type of the member column.
      int getMemberColumnTypeAsInt()
      Returns the data type of the member column as integer value.
      java.lang.String getMemberGroupAttribute()
      Returns the attribute to be used to retrieve group account name, if the member of the group is a group.
      java.lang.String getMemberUserAttribute()
      Returns the attribute to be used to retrieve user account name, if the member of the group is a user.
      java.lang.String getTableName()
      Returns the table name used to store the group members.
      int getTypeAsInt(java.lang.String column)
      Returns data type of the column as an integer value.
      boolean isSysDateColumn(java.lang.String column)
      Returns whether the column is configured to have system date when adding records.
      boolean isUniqueIdColumn(java.lang.String column)
      Returns whether the column is configured to have unique id generated when adding records.
      void setMemberAttribute(java.lang.String attribute)
      Sets the attribute to be used to retrieve the member data from LDAP server.
      void setMemberColumn(java.lang.String column)
      Sets the column name to be used to store the member information.
      void setMemberColumnType(java.lang.String type)
      Sets the member column data type.
      void setMemberGroupAttribute(java.lang.String attribute)
      Sets the attribute to be used to retrieve group account name, if the member of the group is a group.
      void setMemberUserAttribute(java.lang.String attribute)
      Sets the attribute to be used to retrieve user account name, if the member of the group is a user.
      void setTableName(java.lang.String table)
      Sets the table name to be used to store group members.
      java.lang.String toString()
      Returns a string representation of the data for debug purpose.
      • Methods inherited from class java.lang.Object

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

      • MemberDataMap

        public MemberDataMap()
    • Method Detail

      • getTableName

        public java.lang.String getTableName()
        Returns the table name used to store the group members.
        Returns:
        the table name used to store the group members.
      • setTableName

        public void setTableName(java.lang.String table)
        Sets the table name to be used to store group members.
        Parameters:
        table - the table name to be used to store group members.
      • getMemberColumn

        public java.lang.String getMemberColumn()
        Returns the column name to be used to store the member information.
        Returns:
        the column name to be used to store the member information.
      • setMemberColumn

        public void setMemberColumn(java.lang.String column)
        Sets the column name to be used to store the member information.
        Parameters:
        column - the column name to be used to store the member information.
      • getMemberAttribute

        public java.lang.String getMemberAttribute()
        Returns the attribute to be used to retrieve the member data from LDAP server.
        Returns:
        the attribute to be used to retrieve the member data from LDAP server.
      • setMemberAttribute

        public void setMemberAttribute(java.lang.String attribute)
        Sets the attribute to be used to retrieve the member data from LDAP server.
        Parameters:
        attribute - the attribute to be used to retrieve the member data from LDAP server.
      • getMemberUserAttribute

        public java.lang.String getMemberUserAttribute()
        Returns the attribute to be used to retrieve user account name, if the member of the group is a user.
        Returns:
        the attribute to be used to retrieve user account name, if the member of the group is a user.
      • setMemberUserAttribute

        public void setMemberUserAttribute(java.lang.String attribute)
        Sets the attribute to be used to retrieve user account name, if the member of the group is a user.
        Parameters:
        attribute - the attribute to be used to retrieve user account name, if the member of the group is a user.
      • getMemberGroupAttribute

        public java.lang.String getMemberGroupAttribute()
        Returns the attribute to be used to retrieve group account name, if the member of the group is a group.
        Returns:
        the attribute to be used to retrieve group account name, if the member of the group is a group.
      • setMemberGroupAttribute

        public void setMemberGroupAttribute(java.lang.String attribute)
        Sets the attribute to be used to retrieve group account name, if the member of the group is a group.
        Parameters:
        attribute - the attribute to be used to retrieve group account name, if the member of the group is a group.
      • getMemberColumnType

        public java.lang.String getMemberColumnType()
        Returns the data type of the member column.
        Returns:
        the data type of the member column.
      • getMemberColumnTypeAsInt

        public int getMemberColumnTypeAsInt()
        Returns the data type of the member column as integer value.
        Returns:
        the data type of the member column.
      • setMemberColumnType

        public void setMemberColumnType(java.lang.String type)
        Sets the member column data type.
        Parameters:
        type - the data type of the member column.
      • addKeyColumnName

        public void addKeyColumnName(java.lang.String column,
                                     java.lang.String attribute,
                                     java.lang.String type)
        Adds the given column name as a key column with the corresponding attribute to be used to retrieve data from LDAP server.
        Parameters:
        column - key column name.
        attribute - LDAP attribute for the group.
      • getKeyColumnNames

        public java.util.Iterator getKeyColumnNames()
        Returns an Iterator to iterate over the list of key column names.
        Returns:
        an Iterator to iterate over the list of key column names.
      • addColumnName

        public void addColumnName(java.lang.String column,
                                  java.lang.String attribute,
                                  java.lang.String type)
        Adds the given column name as a column with the corresponding attribute to be used to retrieve data from LDAP server.
        Parameters:
        column - column name.
        attribute - LDAP attribute for the group.
      • getColumnNames

        public java.util.Iterator getColumnNames()
        Returns an Iterator to iterate over the list of non-key column names.
        Returns:
        an Iterator to iterate over the list of non-key column names.
      • getKeyAttribute

        public java.lang.String getKeyAttribute(java.lang.String column)
        Returns the LDAP attribute that's mapped for the given key column name.
        Parameters:
        column - key column name.
        Returns:
        the LDAP attribute that's mapped for the given column name.
      • getAttribute

        public java.lang.String getAttribute(java.lang.String column)
        Returns the LDAP attribute that's mapped for the given column name.
        Parameters:
        column - column name.
        Returns:
        the LDAP attribute that's mapped for the given column name.
      • isUniqueIdColumn

        public boolean isUniqueIdColumn(java.lang.String column)
        Returns whether the column is configured to have unique id generated when adding records.
        Parameters:
        column - column name
        Returns:
        true, if column is configured to have unique id.
      • isSysDateColumn

        public boolean isSysDateColumn(java.lang.String column)
        Returns whether the column is configured to have system date when adding records.
        Parameters:
        column - column name
        Returns:
        true, if column is configured to have system date.
      • getTypeAsInt

        public int getTypeAsInt(java.lang.String column)
        Returns data type of the column as an integer value.
        Parameters:
        tableId - table id.
        column - column name
        Returns:
        data type of the column as an integer value.
      • toString

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