com.ibm.commerce.foundation.common.config

Class ComponentConfiguration

  • java.lang.Object
    • com.ibm.commerce.foundation.common.config.ComponentConfiguration

  • public class ComponentConfiguration
extends java.lang.Object
    Configuration class stores configuration information for a specific component. This class is instantiated and accessed through the configuration registry.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.List getComponentConfiguration(java.lang.String astrInterfaceName)
      Returns a list of component configuration
      java.lang.String getComponentId()
      Gets the component ID
      java.util.HashSet getReloadFileList()
      Returns the list of files that needs to be reloaded
      java.util.List getValueByConfigGroupingName(java.lang.String astrConfigGroupingName)
      Gets the list of configuration grouping by the specified configuration grouping name in wc-component.xml and wc-admin-component.xml files
      java.lang.String getValueByConfigGroupingNameAndPropertyName(java.lang.String astrConfigGroupingName, java.lang.String astrName)
      Gets the value of name-value pair configuration property defined under the "ExtendedConfiguration" element in wc-component.xml and wc-admin-component.xml files
      boolean isConfigNodeConfigured(java.lang.String astrInterfaceName)
      Determines if a particular configuration node is configured for this component.
      boolean isReloadConfig()
      Indicates whether the component configuration reloading feature is enabled for the component.
      boolean isReloadedAnyConfig()
      Indicates whether the component configuration reloading feature is enabled for the component and has any configuration is reloaded.
      void resetReloadAnyConfig()
      Reset the reloading any configuration flag to false.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Method Detail

      • getComponentId

        public java.lang.String getComponentId()
        Gets the component ID
        Returns:
        The component ID

      • getComponentConfiguration

        public java.util.List getComponentConfiguration(java.lang.String astrInterfaceName)
        Returns a list of component configuration
        Parameters:
        astrInterfaceName - the interface name of the configuration you want to get
        Returns:
        a list of the component configuration objects for the specified interface name

      • getValueByConfigGroupingNameAndPropertyName

        public java.lang.String getValueByConfigGroupingNameAndPropertyName(java.lang.String astrConfigGroupingName,
                                                                    java.lang.String astrName)
        Gets the value of name-value pair configuration property defined under the "ExtendedConfiguration" element in wc-component.xml and wc-admin-component.xml files
        Parameters:
        astrConfigGroupingName - the name of the configuration grouping.
        astrName - the name of the name-value pair property
        Returns:
        the value of the specified property. For loading policy for the name-value pair configuration property is "extend" that means the value in the component-ext directory takes the precedence.

      • getValueByConfigGroupingName

        public java.util.List getValueByConfigGroupingName(java.lang.String astrConfigGroupingName)
        Gets the list of configuration grouping by the specified configuration grouping name in wc-component.xml and wc-admin-component.xml files
        Parameters:
        astrConfigGroupingName - the name of the configuration grouping.
        Returns:
        the list of the HashMap object represent the name-value pair configuration for the specified configuration grouping.

      • isConfigNodeConfigured

        public boolean isConfigNodeConfigured(java.lang.String astrInterfaceName)
        Determines if a particular configuration node is configured for this component. True if the configuration node is registered with the config, false otherwise.
        Parameters:
        astrInterfaceName - The interface name of the config node
        Returns:
        true if the config node is configured for this component, false otherwise

      • isReloadConfig

        public boolean isReloadConfig()
        Indicates whether the component configuration reloading feature is enabled for the component.
        Returns:
        true the component configuration reloading feature is enabled for the component. Otherwise, configuration reloading is disabled for the component.

      • isReloadedAnyConfig

        public boolean isReloadedAnyConfig()
        Indicates whether the component configuration reloading feature is enabled for the component and has any configuration is reloaded.
        Returns:
        true the component configuration reloading feature is enabled for the component and has reloaded some configuration. Otherwise, on configuration is reloaded for the component.

      • resetReloadAnyConfig

        public void resetReloadAnyConfig()
        Reset the reloading any configuration flag to false.

      • getReloadFileList

        public java.util.HashSet getReloadFileList()
        Returns the list of files that needs to be reloaded
        Returns:
        The list of files that needs to be reloaded
Skip navigation links