Package org.frankframework.configuration

Class Configuration

java.lang.Object
org.springframework.core.io.DefaultResourceLoader
org.springframework.context.support.AbstractApplicationContext
org.springframework.context.support.AbstractRefreshableApplicationContext
org.springframework.context.support.AbstractRefreshableConfigApplicationContext
org.springframework.context.support.AbstractXmlApplicationContext
org.springframework.context.support.ClassPathXmlApplicationContext
org.frankframework.configuration.Configuration
All Implemented Interfaces:
Closeable, AutoCloseable, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactory, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.HierarchicalBeanFactory, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.ListableBeanFactory, org.springframework.context.ApplicationContext, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisher, org.springframework.context.ConfigurableApplicationContext, org.springframework.context.Lifecycle, org.springframework.context.MessageSource, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.core.env.EnvironmentCapable, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver
@FrankDocGroup(OTHER) public class Configuration extends org.springframework.context.support.ClassPathXmlApplicationContext implements ConfigurableLifecycle, FrankElement
Container of Adapters that belong together. A configuration may be deployed independently from other configurations. Names of nested elements like Adapters, Receivers, listeners and senders can be reused in other configurations.

Configurations are shown in the Frank!Console along with their Adapters, Receivers, listeners and senders. The Adapter Status page of the Frank!Console has a tab for each configuration that only shows information about that configuration. See the Frank!Manual for details.
Author:
Niels Meijer

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

    org.springframework.core.io.DefaultResourceLoader.ClassPathContextResource

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.apache.logging.log4j.Logger
    log
     

    Fields inherited from class org.springframework.context.support.AbstractApplicationContext

    APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME

    Fields inherited from interface org.springframework.beans.factory.BeanFactory

    FACTORY_BEAN_PREFIX, FACTORY_BEAN_PREFIX_CHAR

    Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

    APPLICATION_STARTUP_BEAN_NAME, BOOTSTRAP_EXECUTOR_BEAN_NAME, CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SHUTDOWN_HOOK_THREAD_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME

    Fields inherited from interface org.springframework.core.io.ResourceLoader

    CLASSPATH_URL_PREFIX

    Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

    CLASSPATH_ALL_URL_PREFIX

    Fields inherited from interface org.springframework.context.SmartLifecycle

    DEFAULT_PHASE

  • Constructor Summary

    Constructors
    Constructor
    Description
    Configuration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAdapter(Adapter adapter)
    Add adapter.
    void
    addInclude(Include module)
    Include the referenced Module in this configuration
    void
    addJmsRealm(JmsRealm realm)
    Deprecated.
    void
    addScheduledJob(IJob jobdef)
    Deprecated.
    void
    afterPropertiesSet()
    Spring's configure method.
    void
    close()
     
    void
    configure()
    Digest the configuration and generate flow diagram.
    protected final Map<String,Adapter>
    getAdapters()
     
    org.springframework.context.ApplicationContext
    getApplicationContext()
     
    String
    getClassLoaderType()
    If no ClassLoader has been set it tries to fall back on the `configurations.xxx.classLoaderType` property.
    ClassLoader
    getConfigurationClassLoader()
    This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
    ConfigurationWarnings
    getConfigurationWarnings()
     
    String
    getName()
     
    Adapter
    getRegisteredAdapter(String name)
    Get a registered adapter by its name.
    List<Adapter>
    getRegisteredAdapters()
     
    IJob
    getScheduledJob(String name)
     
    List<IJob>
    getScheduledJobs()
     
    boolean
    isAutoStartup()
    By default these beans are not started.
    boolean
    isRunning()
     
    boolean
    isStubbed()
     
    boolean
    isUnloadInProgressOrDone()
     
    void
    publishEvent(org.springframework.context.ApplicationEvent event)
     
    void
    refresh()
    Don't manually call this method.
    protected void
    registerBeanPostProcessors(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
    Enables the Autowired annotation and ConfigurationAware objects.
    void
    registerMonitoring(MonitorManager factory)
    Deprecated.
    void
    removeAdapter(Adapter adapter)
    Remove adapter.
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setAutoStart(boolean autoStart)
    If the Configuration should automatically start all Adapters and Scheduled Jobs.
    void
    setBeanName(String name)
    Overwrite the DisplayName created by the super.setBeanName which prepends 'ApplicationContext'.
    void
    setConfigurationException(ConfigurationException exception)
     
    void
    setErrorMessageFormatter(IErrorMessageFormatter errorMessageFormatter)
    Set the default IErrorMessageFormatter for all adapters in this configuration that do not have an ErrorMessageFormatter defined.
    void
    setIbisManager(IbisManager ibisManager)
     
    void
    setJmsRealms(JmsRealmFactory realm)
     
    void
    setLoadedConfiguration(String loadedConfiguration)
    The loaded (with resolved properties) configuration
    void
    setMonitoring(MonitorManager monitorManager)
    Container for monitor objects
    void
    setName(String name)
    Configurations should be wired through Spring, which in turn should call setBeanName(String).
    void
    setOriginalConfiguration(String originalConfiguration)
    The entire (raw) configuration
    void
    setSapSystems(SapSystems sapSystems)
     
    void
    setScheduleManager(ScheduleManager scheduleManager)
    Container for jobs scheduled for periodic execution.
    void
    setSharedResources(SharedResources resource)
     
    void
    setVersion(String version)
    The version of the Configuration, typically provided by the BuildInfo.properties file.
    void
    start()
    Spring method which starts the ApplicationContext.
    void
    stop()
     

    Methods inherited from class org.springframework.context.support.ClassPathXmlApplicationContext

    getConfigResources

    Methods inherited from class org.springframework.context.support.AbstractXmlApplicationContext

    initBeanDefinitionReader, loadBeanDefinitions, loadBeanDefinitions, setValidating

    Methods inherited from class org.springframework.context.support.AbstractRefreshableConfigApplicationContext

    getConfigLocations, getDefaultConfigLocations, resolvePath, setConfigLocation, setConfigLocations, setId

    Methods inherited from class org.springframework.context.support.AbstractRefreshableApplicationContext

    assertBeanFactoryActive, cancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferences

    Methods inherited from class org.springframework.context.support.AbstractApplicationContext

    addApplicationListener, addBeanFactoryPostProcessor, clearResourceCaches, containsBean, containsBeanDefinition, containsLocalBean, createEnvironment, destroyBeans, doClose, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getApplicationName, getApplicationStartup, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResourcePatternResolver, getResources, getStartupDate, getType, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, initPropertySources, invokeBeanFactoryPostProcessors, isActive, isClosed, isPrototype, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, postProcessBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, registerListeners, registerShutdownHook, removeApplicationListener, resetCommonCaches, setApplicationStartup, setDisplayName, setEnvironment, setParent, toString

    Methods inherited from class org.springframework.core.io.DefaultResourceLoader

    addProtocolResolver, getClassLoader, getProtocolResolvers, getResource, getResourceByPath, getResourceCache, setClassLoader

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

    addProtocolResolver, setClassLoader

    Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

    getPhase, isConfigured

    Methods inherited from interface org.frankframework.core.FrankElement

    addConfigWarning

    Methods inherited from interface org.springframework.core.io.ResourceLoader

    getClassLoader, getResource

    Methods inherited from interface org.springframework.context.SmartLifecycle

    stop

  • Field Details

    • log

      protected org.apache.logging.log4j.Logger log

  • Constructor Details

    • Configuration

      public Configuration()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(@Nonnull org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Throws:
      org.springframework.beans.BeansException

    • getApplicationContext

      public org.springframework.context.ApplicationContext getApplicationContext()
      Specified by:
      getApplicationContext in interface HasApplicationContext

    • afterPropertiesSet

      public void afterPropertiesSet()
      Spring's configure method. Only called when the Configuration has been added through a parent context!
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Overrides:
      afterPropertiesSet in class org.springframework.context.support.AbstractRefreshableConfigApplicationContext

    • refresh

      public void refresh() throws org.springframework.beans.BeansException, IllegalStateException
      Don't manually call this method. Spring should automatically trigger this when super.afterPropertiesSet(); is called.
      Specified by:
      refresh in interface org.springframework.context.ConfigurableApplicationContext
      Overrides:
      refresh in class org.springframework.context.support.AbstractApplicationContext
      Throws:
      org.springframework.beans.BeansException
      IllegalStateException

    • registerBeanPostProcessors

      protected void registerBeanPostProcessors(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
      Enables the Autowired annotation and ConfigurationAware objects.
      Overrides:
      registerBeanPostProcessors in class org.springframework.context.support.AbstractApplicationContext

    • start

      public void start()
      Spring method which starts the ApplicationContext. Loads + digests the configuration and calls start() in all registered beans that implement the Spring Lifecycle interface.
      Specified by:
      start in interface ConfigurableLifecycle
      Specified by:
      start in interface org.springframework.context.Lifecycle
      Overrides:
      start in class org.springframework.context.support.AbstractApplicationContext

    • stop

      public void stop()
      Specified by:
      stop in interface org.springframework.context.Lifecycle
      Overrides:
      stop in class org.springframework.context.support.AbstractApplicationContext

    • configure

      public void configure() throws ConfigurationException
      Digest the configuration and generate flow diagram.
      Specified by:
      configure in interface IConfigurable
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface org.springframework.context.ConfigurableApplicationContext
      Overrides:
      close in class org.springframework.context.support.AbstractApplicationContext

    • publishEvent

      public void publishEvent(org.springframework.context.ApplicationEvent event)
      Specified by:
      publishEvent in interface org.springframework.context.ApplicationEventPublisher
      Overrides:
      publishEvent in class org.springframework.context.support.AbstractApplicationContext

    • isUnloadInProgressOrDone

      public boolean isUnloadInProgressOrDone()

    • isRunning

      public boolean isRunning()
      Specified by:
      isRunning in interface org.springframework.context.Lifecycle
      Overrides:
      isRunning in class org.springframework.context.support.AbstractApplicationContext

    • setAutoStart

      public void setAutoStart(boolean autoStart)
      If the Configuration should automatically start all Adapters and Scheduled Jobs.

    • isAutoStartup

      public boolean isAutoStartup()
      Description copied from interface: ConfigurableLifecycle
      By default these beans are not started. The Configuration may do so in the configure() method.
      Specified by:
      isAutoStartup in interface ConfigurableLifecycle
      Specified by:
      isAutoStartup in interface org.springframework.context.SmartLifecycle

    • isStubbed

      public boolean isStubbed()

    • getRegisteredAdapter

      @Nullable public Adapter getRegisteredAdapter(String name)
      Get a registered adapter by its name.
      Parameters:
      name - the adapter to retrieve
      Returns:
      Adapter

    • getRegisteredAdapters

      @Nonnull public List<Adapter> getRegisteredAdapters()

    • getAdapters

      protected final Map<String,Adapter> getAdapters()

    • addInclude

      public void addInclude(Include module)
      Include the referenced Module in this configuration

    • addAdapter

      public void addAdapter(Adapter adapter)
      Add adapter.

    • removeAdapter

      public void removeAdapter(Adapter adapter)
      Remove adapter.

    • setScheduleManager

      public void setScheduleManager(ScheduleManager scheduleManager)
      Container for jobs scheduled for periodic execution.

    • addScheduledJob

      @Deprecated public void addScheduledJob(IJob jobdef)
      Deprecated.
      Add an job for scheduling at the configuration. The configuration will create an AdapterJob instance and a JobDetail with the information from the parameters, after checking the parameters of the job. (basically, it checks whether the adapter and the receiver are registered.

      See the Quartz scheduler documentation

      Parameters:
      jobdef - a JobDef object
      Since:
      4.0
      See Also:

    • setName

      @Optional public void setName(String name)
      Configurations should be wired through Spring, which in turn should call setBeanName(String). Once the ConfigurationContext has a name it should not be changed anymore, hence super.setBeanName(String) only sets the name once. If not created by Spring, the setIdCalled flag in AbstractRefreshableConfigApplicationContext wont be set, allowing the name to be updated. The DisplayName will always be updated, which is purely used for logging purposes.

    • getName

      public String getName()
      Specified by:
      getName in interface HasName

    • setVersion

      @Protected public void setVersion(String version)
      The version of the Configuration, typically provided by the BuildInfo.properties file.

    • getClassLoaderType

      @Nullable public String getClassLoaderType()
      If no ClassLoader has been set it tries to fall back on the `configurations.xxx.classLoaderType` property. Because of this, it may not always represent the correct or accurate type.

    • setIbisManager

      public void setIbisManager(IbisManager ibisManager)

    • setOriginalConfiguration

      @Protected public void setOriginalConfiguration(String originalConfiguration)
      The entire (raw) configuration

    • setLoadedConfiguration

      @Protected public void setLoadedConfiguration(String loadedConfiguration)
      The loaded (with resolved properties) configuration

    • getScheduledJob

      public IJob getScheduledJob(String name)

    • getScheduledJobs

      public List<IJob> getScheduledJobs()

    • setConfigurationException

      public void setConfigurationException(ConfigurationException exception)

    • getConfigurationWarnings

      public ConfigurationWarnings getConfigurationWarnings()

    • getConfigurationClassLoader

      public ClassLoader getConfigurationClassLoader()
      Description copied from interface: IScopeProvider
      This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
      Specified by:
      getConfigurationClassLoader in interface HasApplicationContext
      Specified by:
      getConfigurationClassLoader in interface IScopeProvider
      Returns:
      returns the ClassLoader created by the ClassLoaderManager.

    • setSapSystems

      public void setSapSystems(SapSystems sapSystems)

    • setJmsRealms

      public void setJmsRealms(JmsRealmFactory realm)

    • addJmsRealm

      @Deprecated public void addJmsRealm(JmsRealm realm)
      Deprecated.

    • setMonitoring

      public void setMonitoring(MonitorManager monitorManager)
      Container for monitor objects

    • registerMonitoring

      @Deprecated public void registerMonitoring(MonitorManager factory)
      Deprecated.

    • setSharedResources

      public void setSharedResources(SharedResources resource)

    • setErrorMessageFormatter

      public void setErrorMessageFormatter(IErrorMessageFormatter errorMessageFormatter)
      Set the default IErrorMessageFormatter for all adapters in this configuration that do not have an ErrorMessageFormatter defined.
      See Also:

    • setBeanName

      @Protected public void setBeanName(String name)
      Overwrite the DisplayName created by the super.setBeanName which prepends 'ApplicationContext'. The BeanName can only be set once, after which it only updates the DisplayName.
      Specified by:
      setBeanName in interface org.springframework.beans.factory.BeanNameAware
      Overrides:
      setBeanName in class org.springframework.context.support.AbstractRefreshableConfigApplicationContext