com.ibm.wsspi.wim

Class ConfigHelper

  • java.lang.Object
    • com.ibm.wsspi.wim.ConfigHelper


  • public class ConfigHelper
    extends java.lang.Object
    Config related utility methods for SPI(adapter)/Plugin providers.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ConfigHelper() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static java.util.Set getallEntityProps()
      Returns the set of all defined properties for the current domain
      static java.util.Set getallEntityRefProps()
      Returns the set of all defined reference properties for the current domain
      static java.lang.String getConfigXMLFilePath()
      Returns the full path of the configuration XML file.
      static java.util.Map getEntityRDNs()
      Returns the Map containing entity type as the key and a java.util.List of Relative Distinguished Name(RDN) properties as the value.
      static java.util.List getRDNProperties(java.lang.String entityType)
      Returns the configured RDN properties of an supporting entity type.
      static java.util.List getSupportedEntityTypes()
      Returns the entity types which are configured in virtual member manager.
      static boolean isRDNProperty(java.lang.String type, java.lang.String propName)
      Returns true if the property name is a Relative Distinguished Name(RDN) property of the entity type.
      • Methods inherited from class java.lang.Object

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

      • ConfigHelper

        public ConfigHelper()
    • Method Detail

      • getallEntityRefProps

        public static java.util.Set getallEntityRefProps()
                                                  throws WIMException
        Returns the set of all defined reference properties for the current domain
        Throws:
        WIMException
        Return:
      • getallEntityProps

        public static java.util.Set getallEntityProps()
                                               throws WIMException
        Returns the set of all defined properties for the current domain
        Throws:
        WIMException
        Return:
      • getSupportedEntityTypes

        public static java.util.List getSupportedEntityTypes()
        Returns the entity types which are configured in virtual member manager. If the entity type is not in the virtual member manager name space, a prefix will be added to the entity type name. For example, "wimext:EPerson".
        Return:
        A list containing names of configured supported entity types.
      • getEntityRDNs

        public static java.util.Map getEntityRDNs()
        Returns the Map containing entity type as the key and a java.util.List of Relative Distinguished Name(RDN) properties as the value.
      • getRDNProperties

        public static java.util.List getRDNProperties(java.lang.String entityType)
        Returns the configured RDN properties of an supporting entity type.
        Parameters:
        entityType - supporting entity type name.
        Return:
        A list of configured RDN properties of the supporting entity type.
      • isRDNProperty

        public static boolean isRDNProperty(java.lang.String type,
                            java.lang.String propName)
        Returns true if the property name is a Relative Distinguished Name(RDN) property of the entity type.
        Parameters:
        type - entity type.
        propName - property name.
        Return:
        True if property name is RDN property of the entity type, false otherwise.
      • getConfigXMLFilePath

        public static java.lang.String getConfigXMLFilePath()
        Returns the full path of the configuration XML file.