com.adaptris.core.services.exception

Class ConfiguredException

java.lang.Object

com.adaptris.core.services.exception.ConfiguredException

All Implemented Interfaces:

ExceptionGenerator

public class ConfiguredException
extends java.lang.Object
implements ExceptionGenerator

ExceptionGenerator implementation that generates the exception from static configuration.

Use this class with ThrowExceptionService to throw an exception as part of a workflow. The configured message forms the exception message (i.e. Throwable.getMessage()).

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

Constructor Summary

Constructors

Constructor and Description
ConfiguredException()
ConfiguredException(java.lang.String msg)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredException

public ConfiguredException()

ConfiguredException

public ConfiguredException(java.lang.String msg)

Method Detail

getMessage

public java.lang.String getMessage()

Returns the configured exception message to use.

Returns:

the configured exception message to use

setMessage

public void setMessage(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.

Specified by:

create in interface ExceptionGenerator

Parameters:

msg - the message

Returns:

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