com.adaptris.core.services.metadata

Class MapMetadataService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.metadata.MetadataServiceImpl

com.adaptris.core.services.metadata.MapMetadataService

All Implemented Interfaces:

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

@ComponentProfile(summary="Change a metadata value based on a regular expression match",
                  tag="service,metadata")
public class MapMetadataService
extends MetadataServiceImpl

Changes the value of a specific metadata key based on a regular expression match of the value associated with the key.

It supports the special syntax of {n} as the replacement value. This indicates that the corresponding match group should be used as the replacement value.

There are similiarities between this service and ReplaceMetadataValue . This service could be easily replaced with multiple instances of ReplaceMetadataValue and you should consider using that if you have to use match groups.

See Also:

Pattern

In the adapter configuration file this class is aliased as map-metadata-service 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

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
MapMetadataService()

Method Summary

Modifier and Type	Method and Description
void	doService(AdaptrisMessage msg) Apply the service to the message.
java.lang.String	getMetadataKey()
KeyValuePairList	getMetadataKeyMap() Returns a KeyValuePairList in which the key is the regular expression to match the metadata value against, and the value is the replacement value.
void	setMetadataKey(java.lang.String s)
void	setMetadataKeyMap(KeyValuePairList m) Sets a KeyValuePairList in which the key is the regular expression to match the metadata value against, and the value is the replacement value (the replacement value may be an expression a-la %message{metadataKey}.

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

closeService, getMetadataLogger, initService, logMetadata, logMetadata, logMetadata, logMetadata, prepare, setMetadataLogger, withMetadataLogger

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

MapMetadataService

public MapMetadataService()

Method Detail

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

See Also:

Service.doService(AdaptrisMessage)

getMetadataKeyMap

public KeyValuePairList getMetadataKeyMap()

Returns a KeyValuePairList in which the key is the regular expression to match the metadata value against, and the value is the replacement value.

It supports the special syntax of {n} which indicates that the corresponding match group should be used as the replacement value

Returns:

a KeyValuePairList

setMetadataKeyMap

public void setMetadataKeyMap(KeyValuePairList m)

Sets a KeyValuePairList in which the key is the regular expression to match the metadata value against, and the value is the replacement value (the replacement value may be an expression a-la %message{metadataKey}.

Parameters:

m - a KeyValuePairList

getMetadataKey

public java.lang.String getMetadataKey()

Returns:

the metadataKey

setMetadataKey

public void setMetadataKey(java.lang.String s)

Parameters:

s - the metadataKey to set