com.adaptris.core.services.metadata

Class PayloadFromMetadataService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.metadata.PayloadFromTemplateService

com.adaptris.core.services.metadata.PayloadFromMetadataService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

Deprecated.

since 3.10.0 use PayloadFromTemplateService or MetadataToPayloadService instead; most of the time you're abusing it...

@Deprecated
 @ComponentProfile(summary="Construct a new payload based on metadata and a template",
                  tag="service,metadata")
 @ConfigDeprecated(removalVersion="4.0.0",
                  message="use payload-from-template or metadata-to-payload instead",
                  groups=java.lang.Deprecated.class)
public class PayloadFromMetadataService
extends PayloadFromTemplateService

Replaces the payload with something else.

This follows the configuration for PayloadFromTemplateService with 2 exceptions

• escape-backslash is still available to be configured but deprecated
• multi-line-expression defaults to FALSE in the constructor for backwards compatibility reasons

In the adapter configuration file this class is aliased as payload-from-metadata-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 and Description
PayloadFromMetadataService() Deprecated.
PayloadFromMetadataService(java.lang.String template) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getEscapeBackslash() Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.
void	prepare() Deprecated. Prepare for initialisation.
protected boolean	quoteReplacement() Deprecated.
void	setEscapeBackslash(java.lang.Boolean b) Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.
PayloadFromMetadataService	withEscapeBackslash(java.lang.Boolean b) Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.

Methods inherited from class com.adaptris.core.services.metadata.PayloadFromTemplateService

closeService, doService, getMetadataTokens, getMultiLineExpression, getQuiet, getQuoteReplacement, getTemplate, initService, multiLineExpression, setMetadataTokens, setMultiLineExpression, setQuiet, setQuoteReplacement, setTemplate, withMetadataTokens, withMetadataTokens, withMultiLineExpression, withQuietMode, withQuoteReplacement, withTemplate

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, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadFromMetadataService

public PayloadFromMetadataService()

Deprecated.

PayloadFromMetadataService

public PayloadFromMetadataService(java.lang.String template)

Deprecated.

Method Detail

prepare

public void prepare()
             throws CoreException

Deprecated.

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class PayloadFromTemplateService

Throws:

CoreException

getEscapeBackslash

@Deprecated
 @ConfigDeprecated(removalVersion="4.0.0",
                  message="use quote-replacement instead",
                  groups=java.lang.Deprecated.class)
public java.lang.Boolean getEscapeBackslash()

Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.

setEscapeBackslash

@Deprecated
 @Removal(version="4.0.0",
         message="use quote-replacement instead")
public void setEscapeBackslash(java.lang.Boolean b)

Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.

If any metadata value contains backslashes then ensure that they are escaped.

Set this flag to make sure that special characters are treated literally by the regular expression engine.

Parameters:

b - the value to set

See Also:

Matcher.quoteReplacement(String)

withEscapeBackslash

@Deprecated
 @Removal(version="4.0.0",
         message="use quote-replacement instead")
public PayloadFromMetadataService withEscapeBackslash(java.lang.Boolean b)

Deprecated. since 3.10.0, use PayloadFromTemplateService.setQuoteReplacement(Boolean) instead.

quoteReplacement

protected boolean quoteReplacement()

Deprecated.

Overrides:

quoteReplacement in class PayloadFromTemplateService