Package com.adaptris.core.transform.json

Class MetadataToJsonService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.transform.json.MetadataToJsonService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Convert metadata values to a JSON object that will be set as the payload of the message")
public class MetadataToJsonService
extends ServiceImp

Convert all metadata values to a JSON object in the message payload.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
MetadataToJsonService()

Method Summary

Modifier and Type	Method	Description
protected void	closeService()
void	doService(AdaptrisMessage msg)
Boolean	getAddTrailingNewline()
Boolean	getConvertNumeric()
MetadataFilter	getMetadataFilter()
protected void	initService()
void	prepare()
void	setAddTrailingNewline(Boolean b)	Add a trailing new line to the payload.
void	setConvertNumeric(Boolean convertNumeric)	Make an attempt to convert numerics into their number form rather than leaving as strings.
void	setMetadataFilter(MetadataFilter metadataFilter)	Set the metadata filter to be used when generating keys for the JSON payload.
MetadataToJsonService	withAddTrailingNewline(boolean b)
MetadataToJsonService	withConvertNumeric(boolean convertNumerics)
MetadataToJsonService	withMetadataFilter(MetadataFilter metadataFilter)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getComments, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setComments, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataToJsonService

public MetadataToJsonService()

Method Details

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

setConvertNumeric

public void setConvertNumeric(Boolean convertNumeric)

Make an attempt to convert numerics into their number form rather than leaving as strings.

getConvertNumeric

public Boolean getConvertNumeric()

withConvertNumeric

public MetadataToJsonService withConvertNumeric(boolean convertNumerics)

getMetadataFilter

public MetadataFilter getMetadataFilter()

setMetadataFilter

public void setMetadataFilter(MetadataFilter metadataFilter)

Set the metadata filter to be used when generating keys for the JSON payload.

Parameters:

metadataFilter - the filter, default is NoOpMetadataFilter if not specified.

withMetadataFilter

public MetadataToJsonService withMetadataFilter(MetadataFilter metadataFilter)

setAddTrailingNewline

public void setAddTrailingNewline(Boolean b)

Add a trailing new line to the payload.

The JSON object is emitted without beautification; this allows you to add a new line to the end of the JSON object if this is required. The newline will be platform dependent c.f. System.lineSeparator().

Parameters:

b - true to add a trailing new line, default is false if not otherwise specified.

getAddTrailingNewline

public Boolean getAddTrailingNewline()

withAddTrailingNewline

public MetadataToJsonService withAddTrailingNewline(boolean b)