Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.soam
Class FatalException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.platform.symphony.soam.SoamException
              extended by com.platform.symphony.soam.FatalException
All Implemented Interfaces:
java.io.Serializable

public class FatalException
extends SoamException

Thrown to indicate a fatal error has occurred in the service.

After a fatal error is thrown, the service request will not be retried on other compute hosts.

For more details, please refer to the Application Development Guide.

See Also:
Serialized Form

Constructor Summary
FatalException()
          Constructs an exception with a null detail message and no cause.
FatalException(java.lang.String message)
          Constructs an exception with the provided detail message and no cause.
FatalException(java.lang.String message, int errorCode)
          Constructs an exception with the provided detail message and associated error code.
FatalException(java.lang.String message, java.lang.Throwable cause)
          Constructs an exception with the provided detail message and cause.
FatalException(java.lang.Throwable cause)
          Constructs an exception with a null detail message and the provided cause.
 
Method Summary
 void applyCustomizedDebugAction(boolean shouldApply)
          Specifies whether to apply the customizedDebugAction when this exception is thrown.
 
Methods inherited from class com.platform.symphony.soam.SoamException
getEmbeddedException, getErrorCode, getErrorType, toString
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FatalException

public FatalException()
Constructs an exception with a null detail message and no cause. The cause may be later initialized by invoking initCause.


FatalException

public FatalException(java.lang.String message)
Constructs an exception with the provided detail message and no cause. The cause may be later initialized by invoking initCause.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.

FatalException

public FatalException(java.lang.String message,
                      int errorCode)
Constructs an exception with the provided detail message and associated error code.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.
errorCode - The Error Code message. The detail message can be accessed by invoking getErrorCode.

FatalException

public FatalException(java.lang.String message,
                      java.lang.Throwable cause)
Constructs an exception with the provided detail message and cause.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.
cause - The cause of the exception. The cause can be accessed by invoking getCause.

FatalException

public FatalException(java.lang.Throwable cause)
Constructs an exception with a null detail message and the provided cause.

Parameters:
cause - The cause of the exception. The cause can be accessed by invoking getCause.
Method Detail

applyCustomizedDebugAction

public void applyCustomizedDebugAction(boolean shouldApply)
Specifies whether to apply the customizedDebugAction when this exception is thrown.

This method can be used to specify whether to apply the customizedDebugAction, specified in the Service > Control > Method > Exception section of the application profile, when this exception is thrown. This behavior is applicable only if debugSetting="customized" in the Service section of the application profile. By default, if you do not call this method, the customizedDebugAction is applied when this exception is thrown.

You can use this method when you are throwing an expected exception and do not need to debug it. For example, if the customizedDebugAction="writeServiceEventReplayFiles" then you can avoid the overhead of creating unnecessary SERL files by calling applyCustomizedDebugAction(false) on the exception before throwing it.

Parameters:
shouldApply - Flag to indicate whether to apply customizedDebugAction.

Version 4.1
Date Modified: -DREL_DATE=Nov 03 2008
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.