Package com.adaptris.core

Class DynamicPollingTemplate

java.lang.Object

com.adaptris.core.DynamicPollingTemplate

All Implemented Interfaces:

ComponentLifecycle, PollingTrigger.MessageProvider

public class DynamicPollingTemplate
extends java.lang.Object
implements PollingTrigger.MessageProvider

Provides a template for PollingTrigger.

This PollingTrigger.MessageProvider implementation allows you to use an implementation of DynamicPollingTemplate.TemplateProvider to dynamically populate the contents of the message before submitting to a workflow. At the moment only a limited subset of services are enabled for this provider :

• ScriptingServiceImp
• JdbcDataQueryService
• HttpRequestService

If you opt to use JdbcDataQueryService or HttpRequestService then there will be some types of configuration that will make no sense in this context such as metadata/xpath driven parameters or use of some ResultSetTranslator implementations (most notably SplittingXmlPayloadTranslator

In the adapter configuration file this class is aliased as dynamic-polling-trigger-template which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DynamicPollingTemplate.TemplateProvider	Marker interface so that not all services can be configured.

Constructor Summary

Constructors

Constructor	Description
DynamicPollingTemplate()
DynamicPollingTemplate(DynamicPollingTemplate.TemplateProvider s)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the component.
AdaptrisMessage	createMessage(AdaptrisMessageFactory fac)
DynamicPollingTemplate.TemplateProvider	getTemplate()
void	init()	Initialises the component.
void	setTemplate(DynamicPollingTemplate.TemplateProvider provider)
void	start()	Starts the component.
void	stop()	Stop the component

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicPollingTemplate

public DynamicPollingTemplate()

DynamicPollingTemplate

public DynamicPollingTemplate(DynamicPollingTemplate.TemplateProvider s)

Method Detail

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

Specified by:

close in interface ComponentLifecycle

getTemplate

public DynamicPollingTemplate.TemplateProvider getTemplate()

setTemplate

public void setTemplate(DynamicPollingTemplate.TemplateProvider provider)

createMessage

public AdaptrisMessage createMessage(AdaptrisMessageFactory fac)
                              throws CoreException

Specified by:

createMessage in interface PollingTrigger.MessageProvider

Throws:

CoreException