Package com.adaptris.core.json.jslt

Class JsltTransformService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.json.jslt.JsltTransformService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Execute a JSLT Transform, using the result as the payload",
                  tag="jslt,transform,json",
                  since="3.12.0",
                  recommended=com.adaptris.core.services.cache.CacheConnection.class)
public class JsltTransformService
extends ServiceImp
implements ConnectedService

Execute a JSLT Transform, using the result as the payload

In the adapter configuration file this class is aliased as jslt-transform-service which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
JsltTransformService()

Method Summary

Modifier and Type	Method	Description
protected void	closeService()
void	doService(AdaptrisMessage msg)
AdaptrisConnection	getConnection()	The connection that wraps any underlying caching required.
java.lang.String	getUrl()	Set the URL that contains the transformation you wish to execute.
@NonNull JsltVariables	getVariables()	Any additional variables you want to pass into the JSLT transformation.
protected void	initService()
void	prepare()
void	setConnection(AdaptrisConnection connection)	The connection that wraps any underlying caching required.
void	setUrl(java.lang.String url)	Set the URL that contains the transformation you wish to execute.
void	setVariables(@NonNull JsltVariables variables)	Any additional variables you want to pass into the JSLT transformation.
void	start()
void	stop()
JsltTransformService	withConnection(AdaptrisConnection c)
JsltTransformService	withUrl(java.lang.String url)
JsltTransformService	withVariables(JsltVariables v)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, 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.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Detail

JsltTransformService

public JsltTransformService()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Specified by:

doService in interface Service

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class ServiceImp

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class ServiceImp

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

withUrl

public JsltTransformService withUrl(java.lang.String url)

withConnection

public JsltTransformService withConnection(AdaptrisConnection c)

withVariables

public JsltTransformService withVariables(JsltVariables v)

getUrl

public java.lang.String getUrl()

Set the URL that contains the transformation you wish to execute.

Although named as a URL it can resolve the JSLT file from either the classpath or filesystem depending on the value here.

• /Users/interlok/work/runtime/my.jslt - either file or classpath
• my.jslt - either file or classpath
• file:////Users/interlok/path/to/my.jslt - considered an absolute local file URL, but classpath will be checked as a last resort for /Users/interlok/path/to/my.jslt
• file:///C:/Users/interlok/path/to/my.jslt - explicit absolute URL (windows style)
• https://myserver.com/path/to/my.jslt - explicit absolute URL supported by the JVM

This also supports the %message{} syntax to resolve metadata.

See Also:

ResourceLocator

setUrl

public void setUrl(java.lang.String url)

Set the URL that contains the transformation you wish to execute.

Although named as a URL it can resolve the JSLT file from either the classpath or filesystem depending on the value here.

• /Users/interlok/work/runtime/my.jslt - either file or classpath
• my.jslt - either file or classpath
• file:////Users/interlok/path/to/my.jslt - considered an absolute local file URL, but classpath will be checked as a last resort for /Users/interlok/path/to/my.jslt
• file:///C:/Users/interlok/path/to/my.jslt - explicit absolute URL (windows style)
• https://myserver.com/path/to/my.jslt - explicit absolute URL supported by the JVM

This also supports the %message{} syntax to resolve metadata.

See Also:

ResourceLocator

getVariables

@NonNull
public @NonNull JsltVariables getVariables()

Any additional variables you want to pass into the JSLT transformation.

Check passing values to jslt for what this means. Conceptually it is very similar to XmlTransformParameters if you have dynamic values that you need to provide to your JSLT mapping.

setVariables

public void setVariables(@NonNull
                         @NonNull JsltVariables variables)

Any additional variables you want to pass into the JSLT transformation.

Check passing values to jslt for what this means. Conceptually it is very similar to XmlTransformParameters if you have dynamic values that you need to provide to your JSLT mapping.

getConnection

public AdaptrisConnection getConnection()

The connection that wraps any underlying caching required.

When using the cache note that the JSLT Expression is not serializable so distributed caches may not work as you expect; in this instance the cache key will be the URL as resolved during first execution.

This defaults to a normal CacheConnection with a NullCacheImplementation if not explicit configured.

Specified by:

getConnection in interface ConnectedService

setConnection

public void setConnection(AdaptrisConnection connection)

The connection that wraps any underlying caching required.

When using the cache note that the JSLT Expression is not serializable so distributed caches may not work as you expect; in this instance the cache key will be the URL as resolved during first execution.

This defaults to a normal CacheConnection with a NullCacheImplementation if not explicit configured.

Specified by:

setConnection in interface ConnectedService