Class FrankPlugin

java.lang.Object

org.springframework.core.io.DefaultResourceLoader

org.springframework.context.support.AbstractApplicationContext

org.springframework.context.support.GenericApplicationContext

org.frankframework.lifecycle.ConfigurableApplicationContext

org.frankframework.core.PipeLine

org.frankframework.components.FrankPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, ICacheEnabled<String,String>, ConfigurationAware, FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IScopeProvider, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactory, org.springframework.beans.factory.HierarchicalBeanFactory, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.ListableBeanFactory, org.springframework.beans.factory.support.BeanDefinitionRegistry, 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.AliasRegistry, org.springframework.core.env.EnvironmentCapable, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver

public class FrankPlugin
extends PipeLine

Nested Class Summary

Nested classes/interfaces inherited from class PipeLine

PipeLine.ExitState

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

org.springframework.core.io.DefaultResourceLoader.ClassPathContextResource

Field Summary

Fields inherited from class PipeLine

DEFAULT_SUCCESS_EXIT_NAME, INPUT_VALIDATOR_NAME, INPUT_WRAPPER_NAME, OUTPUT_VALIDATOR_NAME, OUTPUT_WRAPPER_NAME

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
FrankPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	additionalToString(StringBuilder result)
void	afterPropertiesSet()
void	configure()	Configures the pipes of this Pipeline and does some basic checks.
static PipeLineSession	createChildSession(ParameterValueList pvl, PipeLineSession parentSession)	Allow uses to inject session variables through parameters, and set the CID when present.
PluginLoader	getPluginLoader(org.springframework.context.ApplicationContext applicationContext)
final PipeLineResult	process(@Nullable Receiver<?> receiver, @NonNull Message message, @NonNull PipeLineSession pipeLineSession)	The process method does the processing of a message. It retrieves the first pipe to execute from the firstPipe field, the call results in a PipRunResult, containing the next pipe to activate.
final PipeLineResult	process(@NonNull Message message, @NonNull PipeLineSession pipeLineSession)
void	setConfigurationFile(String configurationFile)
void	setPluginName(String pluginName)

Methods inherited from class PipeLine

addForward, addPipe, addPipeLineExit, configure, findExitByState, findGlobalForward, getAllPipeLineExits, getApplicationContext, getMessageSizeWarnNum, getName, getPhase, getPipe, getPipe, getPipeLineSize, getPipeSizeInStatistics, getPipeSizeOutStatistics, getPipeStatistics, getPipeWaitStatistics, registerBeanPostProcessors, resolveForward, setCache, setExpectsSessionKeys, setFirstPipe, setGlobalForwards, setInputValidator, setInputWrapper, setLocker, setMaxThreads, setMessageSizeWarn, setOutputValidator, setOutputWrapper, setPipeLineExits, setStoreOriginalMessageWithoutNamespaces, setTransactionTimeout, setTransformNullMessage, start, startPipe, stop, stopPipe, toString

Methods inherited from class ConfigurableApplicationContext

close, getClassLoader, initLifecycleProcessor, inState, isAutoStartup, isRunning, setApplicationContext

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

cancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanDefinitionOverridable, isBeanNameInUse, refreshBeanFactory, refreshForAotProcessing, register, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setApplicationStartup, setClassLoader, setParent, setResourceLoader

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

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

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

addProtocolResolver, getProtocolResolvers, getResourceByPath, getResourceCache

Methods inherited from class Object

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

Methods inherited from interface org.springframework.core.AliasRegistry

getAliases

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry

containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

addProtocolResolver

Methods inherited from interface ConfigurableLifecycle

isConfigured

Methods inherited from interface ConfigurationAware

setConfiguration

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getConfigurationClassLoader

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface ICacheEnabled

getCache

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

FrankPlugin

public FrankPlugin()

Method Details

getPluginLoader

public PluginLoader getPluginLoader(org.springframework.context.ApplicationContext applicationContext)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class PipeLine

Throws:

Exception

configure

public void configure()
               throws ConfigurationException

Description copied from class: PipeLine

Configures the pipes of this Pipeline and does some basic checks. It also registers the PipeLineSession object at the pipes.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class PipeLine

Throws:

ConfigurationException - in case it was not able to configure the component.

See Also:

• IPipe

process

public final PipeLineResult process(@Nullable Receiver<?> receiver,
 @NonNull Message message,
 @NonNull PipeLineSession pipeLineSession)
                             throws PipeRunException

Description copied from class: PipeLine

The process method does the processing of a message.
It retrieves the first pipe to execute from the firstPipe field, the call results in a PipRunResult, containing the next pipe to activate. While processing the process method keeps statistics.

Overrides:

process in class PipeLine

Parameters:

message - The message as received from the Listener

Returns:

the result of the processing.

Throws:

PipeRunException - when something went wrong in the pipes.

process

public final PipeLineResult process(@NonNull Message message,
 @NonNull PipeLineSession pipeLineSession)
                             throws PipeRunException

Throws:

PipeRunException

createChildSession

public static PipeLineSession createChildSession(ParameterValueList pvl,
 PipeLineSession parentSession)

Allow uses to inject session variables through parameters, and set the CID when present.

setPluginName

public void setPluginName(String pluginName)

setConfigurationFile

public void setConfigurationFile(String configurationFile)

additionalToString

protected void additionalToString(StringBuilder result)

Overrides:

additionalToString in class PipeLine