com.adaptris.core.services.splitter

Class NoExceptionIfWorkDone

java.lang.Object

com.adaptris.core.services.splitter.ServiceExceptionHandler

com.adaptris.core.services.splitter.NoExceptionIfWorkDone

All Implemented Interfaces:

ServiceErrorHandler, java.lang.Thread.UncaughtExceptionHandler

@ComponentProfile(summary="No exceptions if pooled-split-join-service recorded \'some work\'",
                  since="3.11.1",
                  tag="service,splitjoin")
public class NoExceptionIfWorkDone
extends ServiceExceptionHandler

Ignores exception so long as some messages were considered successful based on a metadata key.

This strategy is useful if messages within a split-join are transient, and can be ignored provided some of them work; it allows you to ignore exceptions processing individual mesages provided one or more messages have set a specific metadata to the value true | 1.

There are some caveats to using this class as part of a PooledSplitJoinService

• If your aggregator is sensitive to payload structure (e.g you're aggregating as a JSON ARRAY, but because of failures, the message to be aggregated is in fact XML) then you have to use a Condition to filter the message somehow. Presumably via the same metadata flag that you've set here.
• If your aggregator isn't sensitive to payloads (e.g. an AppendingMessageAggregator then you may still end up with a mix of JSON/XML
• Exceptions may still be thrown by the aggregator, and they will be propagated to the service; this only ignores exceptions that come from the service-list executed as part of the splitter.

In the adapter configuration file this class is aliased as no-exception-if-work-done which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_METADATA_KEY

Constructor Summary

Constructors

Constructor and Description
NoExceptionIfWorkDone()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMetadataKey() Set the metadata key that captures if any service did work.
void	markSuccessful(AdaptrisMessage msg)
void	setMetadataKey(java.lang.String metadataKey) Set the metadata key that captures if any service did work.
void	throwExceptionAsRequired()
NoExceptionIfWorkDone	withMetadataKey(java.lang.String k)

Methods inherited from class com.adaptris.core.services.splitter.ServiceExceptionHandler

clearExceptions, getFirstThrowableException, throwFirstException, uncaughtException

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METADATA_KEY

public static final java.lang.String DEFAULT_METADATA_KEY

See Also:

Constant Field Values

Constructor Detail

NoExceptionIfWorkDone

public NoExceptionIfWorkDone()

Method Detail

throwExceptionAsRequired

public void throwExceptionAsRequired()
                              throws ServiceException

Specified by:

throwExceptionAsRequired in interface ServiceErrorHandler

Overrides:

throwExceptionAsRequired in class ServiceExceptionHandler

Throws:

ServiceException

markSuccessful

public void markSuccessful(AdaptrisMessage msg)

Parameters:

msg - the message that was successful

withMetadataKey

public NoExceptionIfWorkDone withMetadataKey(java.lang.String k)

getMetadataKey

public java.lang.String getMetadataKey()

Set the metadata key that captures if any service did work.

Defaults to "serviceResult" if not specified.

setMetadataKey

public void setMetadataKey(java.lang.String metadataKey)

Set the metadata key that captures if any service did work.

Defaults to "serviceResult" if not specified.