be.SIRAPRISE.messages
Class NonSiraPriseErrorMessageType

java.lang.Object
  be.SIRAPRISE.messages.ServerMessageType
      be.SIRAPRISE.messages.NonSiraPriseErrorMessageType

Direct Known Subclasses:

NonSiraPriseErrorMessageTypeV1_0, NonSiraPriseErrorMessageTypeV1_1

public abstract class NonSiraPriseErrorMessageType
extends ServerMessageType

The NonSiraPriseErrorMessageType is the type of message returned by a SIRA_PRISE server to a client in the case when a command issued by that client has resulted in an exception being thrown by the Java environment, such as e.g. Java security exceptions, stack overflow errors, ...

Author:

Erwin Smout

Field Summary

static int

MESSAGETYPEID Comment for MESSAGETYPEID

Method Summary

NonSiraPriseErrorMessage	message(java.lang.String exceptionClassName, java.lang.String exceptionMessage) Factory method for getting a message of this version of the type holding the given java exception data
abstract NonSiraPriseErrorMessage	message(java.lang.String exceptionClassName, java.lang.String exceptionMessage, boolean fatal) Factory method for getting a message of this version of the type holding the given java exception data

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGETYPEID

public static final int MESSAGETYPEID

Comment for MESSAGETYPEID

See Also:

Constant Field Values

Method Detail

message

public final NonSiraPriseErrorMessage message(java.lang.String exceptionClassName,
                                              java.lang.String exceptionMessage)

Factory method for getting a message of this version of the type holding the given java exception data

Parameters:

exceptionClassName - The class name of the thrown non-sira-prise exception that caused this message to (have to be) sent

exceptionMessage - The exception message contained in the thrown exception object

Returns:

A NonSiraPriseErrorMessage of the appropriate version reflecting the given exception class name and exception message

message

public abstract NonSiraPriseErrorMessage message(java.lang.String exceptionClassName,
                                                 java.lang.String exceptionMessage,
                                                 boolean fatal)

Factory method for getting a message of this version of the type holding the given java exception data

Parameters:

exceptionClassName - The class name of the thrown non-sira-prise exception that caused this message to (have to be) sent

exceptionMessage - The exception message contained in the thrown exception object

fatal - Flag indicating whether the error was 'fatal', i.e. whether the server has aborted its side of the transaction as a consequence of the error

Returns:

A NonSiraPriseErrorMessage of the appropriate version reflecting the given exception class name and exception message