Class MessagingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.j7m.middleware.api.MiddlewareException

org.j7m.middleware.api.messaging.MessagingException

All Implemented Interfaces:

Serializable

public final class MessagingException
extends MiddlewareException

Messaging exception mapped to stable middleware error codes.

The exception carries only redacted public diagnostics. When a recovery failure prevents a queue service from opening, recoveryReport() exposes the partial safe recovery report that was available before the failure was surfaced.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MessagingException(MiddlewareErrorCode code, String message)	Creates a messaging exception.
MessagingException(MiddlewareErrorCode code, String message, Throwable cause)	Creates a messaging exception with cause.
MessagingException(MiddlewareErrorCode code, String message, Throwable cause, Map<String,String> details, MessagingRecoveryReport recoveryReport)	Creates a messaging exception with redacted diagnostic details.

Method Summary

Modifier and Type	Method	Description
MessagingRecoveryReport	recoveryReport()	Returns the safe partial recovery report attached to this failure.

Methods inherited from class MiddlewareException

code, dirtyTarget, of, remote, remoteError, retryable

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Constructor Details

MessagingException

public MessagingException(MiddlewareErrorCode code,
 String message)

Creates a messaging exception.

Parameters:

code - stable middleware error code

message - safe public message

MessagingException

public MessagingException(MiddlewareErrorCode code,
 String message,
 Throwable cause)

Creates a messaging exception with cause.

Parameters:

code - stable middleware error code

message - safe public message

cause - implementation cause

MessagingException

public MessagingException(MiddlewareErrorCode code,
 String message,
 Throwable cause,
 Map<String,String> details,
 MessagingRecoveryReport recoveryReport)

Creates a messaging exception with redacted diagnostic details.

Parameters:

code - stable middleware error code

message - safe public message

cause - implementation cause

details - safe public diagnostic details

recoveryReport - partial recovery report, or null when unavailable

Method Details

recoveryReport

public MessagingRecoveryReport recoveryReport()

Returns the safe partial recovery report attached to this failure.

Returns:

recovery report, or null when this failure did not occur during recovery