com.ibm.commerce.foundation.common.config

Class AbstractConfigurationImpl

  • java.lang.Object
    • com.ibm.commerce.foundation.common.config.AbstractConfigurationImpl
  • Direct Known Subclasses:
    SubscriptionConfigurationImpl

    public abstract class AbstractConfigurationImpl
extends java.lang.Object
    Abstract class for processing a node from the configuration file.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getComponentId()
      Gets the component Id
      java.lang.String getConfigurationFileName()
      Gets the configuration file name of this object represents to.
      java.lang.String getConfigurationFilePath()
      Returns the file path to the configuration files.
      abstract java.lang.String getInterfaceName()
      Each configuration is associated with an interfacename, to be used to cast down the configuration object when it is retrieved.
      abstract boolean isOverridable()
      Returns a boolean flag to indicate if the configuration file is an overridable configuration.
      void setConfigurationFilePath(java.lang.String aConfigurationFilePath)
      Sets the location of the configuration files.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractConfigurationImpl

        public AbstractConfigurationImpl()

    • Method Detail

      • getComponentId

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

      • getConfigurationFileName

        public java.lang.String getConfigurationFileName()
        Gets the configuration file name of this object represents to.
        Returns:
        the configuration file name of this object represents to.

      • getInterfaceName

        public abstract java.lang.String getInterfaceName()
        Each configuration is associated with an interfacename, to be used to cast down the configuration object when it is retrieved. The interfaceName is also used to store the configuration file in the registry; the configuration will always be fetched by interfaceName, not by the name of the implementation class
        Returns:
        The interfaceName for the component

      • isOverridable

        public abstract boolean isOverridable()
        Returns a boolean flag to indicate if the configuration file is an overridable configuration. If it is set to true, the configuration at extended or custom directory will completely override (replace) the configuration at the base configuration directory.
        Returns:
        true if it is an overridable configuration, otherwise, set to false.

      • getConfigurationFilePath

        public final java.lang.String getConfigurationFilePath()
        Returns the file path to the configuration files. If the caller did not specify the path, assume that the configuration directory is the component default configuration directory.
        Returns:
        Returns the configurationFilePath.

      • setConfigurationFilePath

        public final void setConfigurationFilePath(java.lang.String aConfigurationFilePath)
        Sets the location of the configuration files.
        Parameters:
        aConfigurationFilePath - The configurationFilePath to set.
Skip navigation links