com.sap.aii.af.lib.mp.module

Class ModuleException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.sap.aii.af.lib.mp.module.ModuleException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ModuleProcessorException

public class ModuleException
extends Exception

ModuleException must be thrown by modules in case of error conditions. ModuleException can include a nested exception as cause description that is logged in the trace to give further debugging hints. In contrast to earlier SPs it is not necessary to set a particular exception in order to trigger the message retry. In case of receiver channels the AF MS will always enter the message retry algorithm as it is specified in AAM. In case of sender channels the adapter implementation must decide whether a retry is sensible or not

See Also:
Serialized Form

Field Summary
protected  Throwable cause
           
 
Constructor Summary
ModuleException()
          Simple constructor without cause (no retry)
ModuleException(String message)
          Constructor with exception text but without cause (no retry)
ModuleException(String message, Throwable cause)
          Constructor with exception text and cause (retry if cause is a MessagingException)
ModuleException(Throwable cause)
          Constructor without exception text but with cause (retry if cause is a MessagingException)
 
Method Summary
 Throwable getCause()
          Retrieves the cause for this module exception
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

cause

protected Throwable cause
Constructor Detail

ModuleException

public ModuleException()
Simple constructor without cause (no retry)


ModuleException

public ModuleException(String message)
Constructor with exception text but without cause (no retry)

Parameters:
message - Human readable exception message

ModuleException

public ModuleException(String message,
                       Throwable cause)
Constructor with exception text and cause (retry if cause is a MessagingException)

Parameters:
message - Human readable exception message
cause - Throwable which caused this exception

ModuleException

public ModuleException(Throwable cause)
Constructor without exception text but with cause (retry if cause is a MessagingException)

Parameters:
cause - Throwable which caused this exception
Method Detail

getCause

public Throwable getCause()
Retrieves the cause for this module exception

Overrides:
getCause in class Throwable
Returns:
Throwable Reason for this exception


Copyright 2009 SAP AG Complete Copyright Notice