com.adaptris.core.services.metadata

Class CopyMetadataService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.metadata.MetadataServiceImpl

com.adaptris.core.services.metadata.CopyMetadataService

All Implemented Interfaces:

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

@ComponentProfile(summary="Copy metadata values to other metadata keys",
                  tag="service,metadata")
public class CopyMetadataService
extends MetadataServiceImpl

Copies metadata from one key to another.

Updates message metadata by

• obtaining the metadata value stored against the 'original' key configured as the key in the metadata-keys section
• copying this value to the 'new' key configured as the value of the associated metadata-keys element
.

If the configured 'original' metadata key does not exist, then metadata is not copied, if the 'new' metadata key already exists, it is overwritten.

In the adapter configuration file this class is aliased as copy-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
CopyMetadataService()

Method Summary

Modifier and Type	Method and Description
void	doService(AdaptrisMessage msg) Apply the service to the message.
KeyValuePairCollection	getMetadataKeys() Returns a KeyValuePairCollection in which the key is the key to look up, and the value is the key to store whatever was found against.
void	setMetadataKeys(KeyValuePairCollection m) Sets a KeyValuePairCollection in which the key is the key to look up, and the value is the key to store whatever was found against the key.

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, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, 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

CopyMetadataService

public CopyMetadataService()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

getMetadataKeys

public KeyValuePairCollection getMetadataKeys()

Returns a KeyValuePairCollection in which the key is the key to look up, and the value is the key to store whatever was found against.

Returns:

a KeyValuePairCollection

setMetadataKeys

public void setMetadataKeys(KeyValuePairCollection m)

Sets a KeyValuePairCollection in which the key is the key to look up, and the value is the key to store whatever was found against the key.

Parameters:

m - a KeyValuePairCollection