com.adaptris.core.services

Class ScriptingServiceImp

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.ScriptingServiceImp

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, DynamicPollingTemplate.TemplateProvider, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

EmbeddedScriptingService, ScriptingService

public abstract class ScriptingServiceImp
extends ServiceImp
implements DynamicPollingTemplate.TemplateProvider

Base class for enabling JSR223 enabled scripting languages.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
ScriptingServiceImp()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
protected abstract java.io.Reader	createReader()
void	doService(AdaptrisMessage msg) Apply the service to the message.
java.lang.Boolean	getBranchingEnabled()
java.lang.String	getLanguage()
protected void	initService()
boolean	isBranching() Returns true if the implementation supports branching.
void	prepare() Prepare for initialisation.
void	setBranchingEnabled(java.lang.Boolean branching) Specify whether or not this service is branching.
void	setLanguage(java.lang.String s) Set the language the the script is written in.
void	start() Starts the component.
void	stop() Stop the component

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setLookupName, setUniqueId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, setUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.JndiBindable

getLookupName

Constructor Detail

ScriptingServiceImp

public ScriptingServiceImp()

Method Detail

doService

public final void doService(AdaptrisMessage msg)
                     throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Specified by:

doService in interface Service

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

createReader

protected abstract java.io.Reader createReader()
                                        throws java.io.IOException

Throws:

java.io.IOException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

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

Overrides:

start in class ServiceImp

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

Overrides:

stop in class ServiceImp

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String s)

Set the language the the script is written in.

Parameters:

s - a JSR223 supported language.

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

isBranching

public boolean isBranching()

Description copied from interface: Service

Returns true if the implementation supports branching.

Specified by:

isBranching in interface Service

Overrides:

isBranching in class ServiceImp

Returns:

true if the implementation supports branching

See Also:

BranchingServiceCollection

getBranchingEnabled

public java.lang.Boolean getBranchingEnabled()

setBranchingEnabled

public void setBranchingEnabled(java.lang.Boolean branching)

Specify whether or not this service is branching.

Parameters:

branching - true to cause isBranching() to return true; default is false.

Since:

3.4.0

See Also:

Service.isBranching()