com.adaptris.core.services.exception

Class ExceptionFromMetadata

java.lang.Object

com.adaptris.core.services.exception.ExceptionFromMetadataImpl

com.adaptris.core.services.exception.ExceptionFromMetadata

All Implemented Interfaces:

ExceptionGenerator

public class ExceptionFromMetadata
extends ExceptionFromMetadataImpl

ExceptionGenerator implementation that generates the exception from metadata.

Use this class with ThrowExceptionService to throw an exception as part of a workflow. The exception message (i.e. Throwable.getMessage()) is derived from the configured metadata key. If the metadata key does not exist (or returns no value) then the default exception message is used to generate the exception. Note that this always throws an exception.

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

Constructor Summary

Constructors

Constructor and Description
ExceptionFromMetadata()
ExceptionFromMetadata(java.lang.String defaultMessage)
ExceptionFromMetadata(java.lang.String defaultMessage, java.lang.String metadataKey)

Method Summary

Modifier and Type	Method and Description
ServiceException	create(AdaptrisMessage msg) Generate a service exception from the AdaptrisMessage.
java.lang.String	getDefaultExceptionMessage() Returns the configured exception message to use.
void	setDefaultExceptionMessage(java.lang.String s) Sets the configured exception message to use.

Methods inherited from class com.adaptris.core.services.exception.ExceptionFromMetadataImpl

getExceptionMessageMetadataKey, setExceptionMessageMetadataKey

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionFromMetadata

public ExceptionFromMetadata()

ExceptionFromMetadata

public ExceptionFromMetadata(java.lang.String defaultMessage)

ExceptionFromMetadata

public ExceptionFromMetadata(java.lang.String defaultMessage,
                             java.lang.String metadataKey)

Method Detail

getDefaultExceptionMessage

public java.lang.String getDefaultExceptionMessage()

Returns the configured exception message to use.

Returns:

the configured exception message to use

setDefaultExceptionMessage

public void setDefaultExceptionMessage(java.lang.String s)

Sets the configured exception message to use.

Parameters:

s - the configured exception message to use.

create

public ServiceException create(AdaptrisMessage msg)

Description copied from interface: ExceptionGenerator

Generate a service exception from the AdaptrisMessage.

Parameters:

msg - the message

Returns:

a ServiceException ready to be thrown, or null if no exception is appropriate