com.adaptris.core

Class FormattedMetadataDestination

java.lang.Object

com.adaptris.core.FormattedMetadataDestination

All Implemented Interfaces:

MessageDrivenDestination, ProduceDestination

public class FormattedMetadataDestination
extends java.lang.Object
implements MessageDrivenDestination

Implementation of ProduceDestination that uses String.format(String, Object...) along with metadata to create a dynamic destination.

The following rules will apply when you are constructing your formatted destination

• The format is passed directly to String.format(String, Object...) with no checks.
• Each of the values that are associated with the getMetadataKeys() and getObjectMetadataKeys() will be passed into the formatter.
• Object Metadata values are always listed after standard metadata values.
• Standard metadata values will be defaulted to an empty string, if not present in the message
• Object Metadata values will be passed as-is (i.e. they may be null), behaviour will be dependent on the format/locale
• If the resulting destination is the empty string; then null is returned

Examples

The message in question has the metadata {key1=archive, key2=orders} and object metadata containing {timestamp=new Date(1335948092985)} (the date is roughly "2012-05-02 09:41:23"). The configuration for this destination contains metadataKeys={key1, key2}, objectMetadataKeys={timestamp}. then we could use to following formats for the destination-format to generate output that matches our criteria

• "/path/to/my/dir" would give us /path/to/my/dir; which is equivalent to configuring a ConfiguredProduceDestination
• "/%1$s/%2$s/%3$tF" would give us /archive/orders/2012-05-02
• "/%1$s/%3$tA/%2$s" would give us /archive/Wednesday/orders

See Also:

String.format(String, Object...), Formatter

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

Constructor Summary

Constructors

Constructor and Description
FormattedMetadataDestination()

Method Summary

Modifier and Type	Method and Description
void	addMetadataKey(java.lang.String s)
void	addObjectMetadataKey(java.lang.String s)
java.lang.String	getDestination(AdaptrisMessage msg) Returns a String destination name.
java.lang.String	getDestinationTemplate()
ElementFormatter	getElementFormatter() Get the element formatter.
java.util.List<java.lang.String>	getMetadataKeys()
java.util.List<java.lang.String>	getObjectMetadataKeys()
void	setDestinationTemplate(java.lang.String s)
void	setElementFormatter(ElementFormatter elementFormatter) Set the element formatter.
void	setMetadataKeys(java.util.List<java.lang.String> l)
void	setObjectMetadataKeys(java.util.List<java.lang.String> l)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattedMetadataDestination

public FormattedMetadataDestination()

Method Detail

addMetadataKey

public void addMetadataKey(java.lang.String s)

getMetadataKeys

public java.util.List<java.lang.String> getMetadataKeys()

getElementFormatter

public ElementFormatter getElementFormatter()

Get the element formatter.

Returns:

The element formatter.

setElementFormatter

public void setElementFormatter(ElementFormatter elementFormatter)

Set the element formatter.

Parameters:

elementFormatter - The element formatter.

setMetadataKeys

public void setMetadataKeys(java.util.List<java.lang.String> l)

addObjectMetadataKey

public void addObjectMetadataKey(java.lang.String s)

getObjectMetadataKeys

public java.util.List<java.lang.String> getObjectMetadataKeys()

setObjectMetadataKeys

public void setObjectMetadataKeys(java.util.List<java.lang.String> l)

getDestination

public java.lang.String getDestination(AdaptrisMessage msg)
                                throws CoreException

Description copied from interface: ProduceDestination

Returns a String destination name. Implementations may or may not use the AdaptrisMessage to dynamically generate the name.

Specified by:

getDestination in interface ProduceDestination

Parameters:

msg - the AdaptrisMessage for which the name is being generated

Returns:

the destination name to use

Throws:

CoreException - wrapping any underlying Exception

getDestinationTemplate

public java.lang.String getDestinationTemplate()

setDestinationTemplate

public void setDestinationTemplate(java.lang.String s)