Class ConfigurationFactory

    • Field Detail

      • CONFIGURATION_FACTORY_PROPERTY

        public static final java.lang.String CONFIGURATION_FACTORY_PROPERTY
        Allows the ConfigurationFactory class to be specified as a system property.
        See Also:
        Constant Field Values
      • CONFIGURATION_FILE_PROPERTY

        public static final java.lang.String CONFIGURATION_FILE_PROPERTY
        Allows the location of the configuration file to be specified as a system property.
        See Also:
        Constant Field Values
      • CATEGORY

        public static final java.lang.String CATEGORY
        Plugin category used to inject a ConfigurationFactory Plugin class.
        Since:
        2.1
        See Also:
        Constant Field Values
      • LOGGER

        protected static final Logger LOGGER
        Allows subclasses access to the status logger without creating another instance.
      • TEST_PREFIX

        protected static final java.lang.String TEST_PREFIX
        File name prefix for test configurations.
        See Also:
        Constant Field Values
      • DEFAULT_PREFIX

        protected static final java.lang.String DEFAULT_PREFIX
        File name prefix for standard configurations.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ConfigurationFactory

        public ConfigurationFactory()
    • Method Detail

      • getInstance

        public static ConfigurationFactory getInstance()
        Returns the ConfigurationFactory.
        Returns:
        the ConfigurationFactory.
      • setConfigurationFactory

        public static void setConfigurationFactory​(ConfigurationFactory factory)
        Sets the configuration factory. This method is not intended for general use and may not be thread safe.
        Parameters:
        factory - the ConfigurationFactory.
      • resetConfigurationFactory

        public static void resetConfigurationFactory()
        Resets the ConfigurationFactory to the default. This method is not intended for general use and may not be thread safe.
      • removeConfigurationFactory

        public static void removeConfigurationFactory​(ConfigurationFactory factory)
        Removes the ConfigurationFactory. This method is not intended for general use and may not be thread safe.
        Parameters:
        factory - The factory to remove.
      • getSupportedTypes

        protected abstract java.lang.String[] getSupportedTypes()
      • isActive

        protected boolean isActive()
      • getConfiguration

        public Configuration getConfiguration​(LoggerContext loggerContext,
                                              java.lang.String name,
                                              java.net.URI configLocation)
        Returns the Configuration.
        Parameters:
        loggerContext - The logger context
        name - The configuration name.
        configLocation - The configuration location.
        Returns:
        The Configuration.
      • getConfiguration

        public Configuration getConfiguration​(LoggerContext loggerContext,
                                              java.lang.String name,
                                              java.net.URI configLocation,
                                              java.lang.ClassLoader loader)
        Returns the Configuration obtained using a given ClassLoader.
        Parameters:
        loggerContext - The logger context
        name - The configuration name.
        configLocation - A URI representing the location of the configuration.
        loader - The default ClassLoader to use. If this is null, then the default ClassLoader will be used.
        Returns:
        The Configuration.
      • getInputFromString

        protected ConfigurationSource getInputFromString​(java.lang.String config,
                                                         java.lang.ClassLoader loader)
        Loads the configuration from the location represented by the String.
        Parameters:
        config - The configuration location.
        loader - The default ClassLoader to use.
        Returns:
        The InputSource to use to read the configuration.