Package com.illumon.iris.controller
Interface TypeSpecificWireConfigProvider
- All Superinterfaces:
TypeSpecificConfig
public interface TypeSpecificWireConfigProvider extends TypeSpecificConfig
Configuration for a type specific query.
-
Method Summary
Modifier and Type Method Description org.jdom2.ElementgenerateConfig()Generate the configuration XML Element.TypeSpecificWireConfiggetWireConfig()default voidinstallConfig()Install the verified configuration.voidverifyConfig(org.jdom2.Element element, BiFunction<String,Integer,Double> determineMaxHeapFunction)Given the element (off the xml file's root), verify the configuration entries and pre-load them.
-
Method Details
-
getWireConfig
TypeSpecificWireConfig getWireConfig() -
verifyConfig
void verifyConfig(org.jdom2.Element element, BiFunction<String,Integer,Double> determineMaxHeapFunction) throws ConfigurationVerificationExceptionGiven the element (off the xml file's root), verify the configuration entries and pre-load them. Do not activate them.- Parameters:
element- the Element that was generated by this ReloadableConfiguration's generateConfig calldetermineMaxHeapFunction- a function that determines the maximum heap for a worker- Throws:
ConfigurationVerificationException- if the element has an error
-
installConfig
default void installConfig()Install the verified configuration. -
generateConfig
Generate the configuration XML Element. This may involve reading a Configuration instance and performing other actions.- Returns:
- an Element that can be used to load the configuration. This will be passed to verifyConfig.
- Throws:
IOException
-