Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• ComponentConfiguration

  protected ComponentConfiguration(java.lang.String astrCompId,
                        java.util.Map aConfigMapping,
                        boolean reloadConfig)
  

  Creates an instance of the ComponentConfiguration object, based on the configuration mapping, to load the configuration files for the specified component. If a configuration file cannot be parsed, a ComponentConfigurationException is thrown.

  Parameters:

  astrCompId - a String object which represents the component ID.

  aConfigMapping - a Map object which contains the configuration file and its implementation class

  reloadConfig - The flag indicates if the component configuration needs to be reloaded

• ComponentConfiguration

  protected ComponentConfiguration(java.lang.String astrCompId,
                        java.util.Map aConfigMapping,
                        boolean reloadConfig,
                        java.util.HashSet reloadFiles)
  

  Creates an instance of the ComponentConfiguration object, based on the configuration mapping, to load the configuration files for the specified component. If a configuration file cannot be parsed, a ComponentConfigurationException is thrown.

  Parameters:

  astrCompId - a String object which represents the component ID.

  aConfigMapping - a Map object which contains the configuration file and its implementation class

  reloadConfig - The flag indicates if the component configuration needs to be reloaded

  reloadFiles - A list of files that are specified in foundation configuration that needs to be reloaded.

Method Detail

• getComponentId

  public java.lang.String getComponentId()
  

  Gets the component ID

  Returns:

  The component ID

• reload

  protected void reload()
  

  Reloads the component configuration

• 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.

• 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