Package com.adaptris.core.services.metadata

Class ExtractMetadataService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.metadata.MetadataServiceImpl

com.adaptris.core.services.metadata.ExtractMetadataService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Extract additional metadata values from an item of metadata",
                  since="3.9.0",
                  tag="service,metadata")
public class ExtractMetadataService
extends MetadataServiceImpl

Extract additional metadata values from an item of metadata.

Given a metadata key url containing /record/zeus/apollo if you have a regular expression /record/(.*)/(.*) with metadata keys recordId, childId then parentId=zeus, childId=apollo will be set when this service executes.

In the adapter configuration file this class is aliased as extract-metadata-from-metadata which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.services.metadata.MetadataServiceImpl

MetadataServiceImpl.LogWrapper

Field Summary

Fields inherited from class com.adaptris.core.services.metadata.MetadataServiceImpl

DEBUG, ERROR, INFO, TRACE, WARN

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
ExtractMetadataService()

Method Summary

Modifier and Type	Method	Description
void	doService(AdaptrisMessage msg)	Apply the service to the message.
List<String>	getMetadataKeys()
String	getRegularExpression()
String	getSourceKey()
protected void	initService()
void	prepare()	Prepare for initialisation.
void	setMetadataKeys(List<String> metadataKeys)
void	setRegularExpression(String regExp)
void	setSourceKey(String sourceKey)
ExtractMetadataService	withMetadataKeys(String... keys)
ExtractMetadataService	withMetadataKeys(List<String> keys)
ExtractMetadataService	withRegularExpression(String s)
ExtractMetadataService	withSourceKey(String s)

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

closeService, getMetadataLogger, logMetadata, logMetadata, logMetadata, logMetadata, setMetadataLogger, withMetadataLogger

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 Details

ExtractMetadataService

public ExtractMetadataService()

Method Details

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class MetadataServiceImpl

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Overrides:

initService in class MetadataServiceImpl

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

getSourceKey

public String getSourceKey()

setSourceKey

public void setSourceKey(String sourceKey)

withSourceKey

public ExtractMetadataService withSourceKey(String s)

getRegularExpression

public String getRegularExpression()

setRegularExpression

public void setRegularExpression(String regExp)

withRegularExpression

public ExtractMetadataService withRegularExpression(String s)

getMetadataKeys

public List<String> getMetadataKeys()

setMetadataKeys

public void setMetadataKeys(List<String> metadataKeys)

withMetadataKeys

public ExtractMetadataService withMetadataKeys(List<String> keys)

withMetadataKeys

public ExtractMetadataService withMetadataKeys(String... keys)