nl.nn.adapterframework.senders

Class SenderBase

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

DelaySender, SenderWithParametersBase

public abstract class SenderBase
extends Object
implements ISender, org.springframework.context.ApplicationContextAware

Baseclass for senders.

Since:

4.9

Author:

Gerrit van Brakel

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SenderBase()

Method Summary

Modifier and Type	Method and Description
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
boolean	consumesSessionVariable(String sessionKey) returns true if the sender or one of its children use the named session variable.
protected <T> T	createBean(Class<T> beanClass)
protected String	getLogPrefix() Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d.
String	getName()
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
void	open() This method will be called to start the sender.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) final method to ensure nobody overrides this...
void	setName(String name) The functional name of the object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.ISender

sendMessage

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Field Detail

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

SenderBase

public SenderBase()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Throws:

SenderException

close

public void close()
           throws SenderException

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Throws:

SenderException

setApplicationContext

public final void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

final method to ensure nobody overrides this...

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

createBean

protected <T> T createBean(Class<T> beanClass)

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

getLogPrefix

protected String getLogPrefix()

Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d. ClassUtils.nameOf(Object) makes sure the original class will be used.

Returns:

className + name of the ISender

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: ISender

returns true if the sender or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface ISender

setName

@IbisDoc(value={"name of the sender",""})
public void setName(String name)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

getName

public String getName()

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject