com.adaptris.core.json.jsonpatch

Class GeneratePatchDiffService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.json.jsonpatch.JsonPatchService

com.adaptris.core.json.jsonpatch.GeneratePatchDiffService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Generate a JSON patch diff between two documents",
                  tag="service,json,jsonpatch",
                  since="3.9.0")
public class GeneratePatchDiffService
extends JsonPatchService

Generate a JSON patch diff between two documents

JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document. This service generates the JSON that expresses the differences between 2 JSON documents as a sequence of operations.

For a given diff-source of {"a": 0,"b": [1,2]} and a diff-target of {"b": [1,2,0]} then the patch transformation generated and stored against output should be [{"op":"move","from":"/a","path":"/b/2"}].

Note that zjsonpatch operates on JsonNode objects; this means keeping the both node trees in memory, so behaviour will be size/memory dependent.

In the adapter configuration file this class is aliased as json-patch-generate-diff which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.json.jsonpatch.JsonPatchService

mapper

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
GeneratePatchDiffService()

Method Summary

Modifier and Type	Method and Description
void	doService(AdaptrisMessage msg)
MessageWrapper<java.io.InputStream>	getDiffSource()
MessageWrapper<java.io.InputStream>	getDiffTarget()
java.util.List<PatchDiffFlag>	getFlags()
void	prepare()
void	setDiffSource(MessageWrapper<java.io.InputStream> diffSource) Specify the JSON document that will be transformed.
void	setDiffTarget(MessageWrapper<java.io.InputStream> diffTarget) Specify the target JSON document you want the patch to transform to.
void	setFlags(java.util.List<PatchDiffFlag> flags) Specify any additional flags for the diff operation.
GeneratePatchDiffService	withDiffSource(MessageWrapper<java.io.InputStream> diffSource)
GeneratePatchDiffService	withDiffTarget(MessageWrapper<java.io.InputStream> diffTarget)
GeneratePatchDiffService	withFlags(java.util.List<PatchDiffFlag> flags)
GeneratePatchDiffService	withFlags(PatchDiffFlag... flags)

Methods inherited from class com.adaptris.core.json.jsonpatch.JsonPatchService

closeService, getOutput, initService, output, readAndClose, setOutput, withOutput, writeAndClose

Methods inherited from class com.adaptris.core.ServiceImp

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratePatchDiffService

public GeneratePatchDiffService()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

getDiffSource

public MessageWrapper<java.io.InputStream> getDiffSource()

setDiffSource

public void setDiffSource(MessageWrapper<java.io.InputStream> diffSource)

Specify the JSON document that will be transformed.

Parameters:

diffSource - the source

withDiffSource

public GeneratePatchDiffService withDiffSource(MessageWrapper<java.io.InputStream> diffSource)

getDiffTarget

public MessageWrapper<java.io.InputStream> getDiffTarget()

setDiffTarget

public void setDiffTarget(MessageWrapper<java.io.InputStream> diffTarget)

Specify the target JSON document you want the patch to transform to.

Parameters:

diffTarget - the target JSON document

withDiffTarget

public GeneratePatchDiffService withDiffTarget(MessageWrapper<java.io.InputStream> diffTarget)

getFlags

public java.util.List<PatchDiffFlag> getFlags()

setFlags

public void setFlags(java.util.List<PatchDiffFlag> flags)

Specify any additional flags for the diff operation.

Parameters:

flags - the flags.

withFlags

public GeneratePatchDiffService withFlags(java.util.List<PatchDiffFlag> flags)

withFlags

public GeneratePatchDiffService withFlags(PatchDiffFlag... flags)