Package com.adaptris.core.json.jq
Class JsonJqTransform
- java.lang.Object
-
- com.adaptris.core.ServiceImp
-
- com.adaptris.core.json.jq.JsonJqTransform
-
- All Implemented Interfaces:
AdaptrisComponent
,ComponentLifecycle
,ComponentLifecycleExtension
,MessageEventGenerator
,Service
,StateManagedComponent
@ComponentProfile(summary="Execute a JQ style query", tag="service,json,transform,jq") public class JsonJqTransform extends ServiceImp
Transform a JSON document using JQ style syntax.In the adapter configuration file this class is aliased as json-jq-transform 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 JsonJqTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
closeService()
void
doService(AdaptrisMessage msg)
MetadataFilter
getMetadataFilter()
DataInputParameter<java.lang.String>
getQuerySource()
protected void
initService()
void
prepare()
void
setMetadataFilter(MetadataFilter f)
Filter metadata to pass through to your query.void
setQuerySource(DataInputParameter<java.lang.String> query)
JsonJqTransform
withMetadataFilter(MetadataFilter f)
JsonJqTransform
withQuerySource(DataInputParameter<java.lang.String> query)
-
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
-
-
-
-
Method Detail
-
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 classServiceImp
- Throws:
CoreException
-
closeService
protected void closeService()
- Specified by:
closeService
in classServiceImp
-
getQuerySource
public DataInputParameter<java.lang.String> getQuerySource()
-
setQuerySource
public void setQuerySource(DataInputParameter<java.lang.String> query)
- Parameters:
query
- the query-source.
-
withQuerySource
public JsonJqTransform withQuerySource(DataInputParameter<java.lang.String> query)
-
getMetadataFilter
public MetadataFilter getMetadataFilter()
-
setMetadataFilter
public void setMetadataFilter(MetadataFilter f)
Filter metadata to pass through to your query.The metadata will be passed in as a
Scope
object bound tometadata
which allows you to reference it as$metadata.myMetadataKey
within your query- Parameters:
f
- the filter, default isremove-all-metadata-filter
if not specified.
-
withMetadataFilter
public JsonJqTransform withMetadataFilter(MetadataFilter f)
-
-