Package net.engio.mbassy.bus.error

Class PublicationError

java.lang.Object

net.engio.mbassy.bus.error.PublicationError

Direct Known Subclasses:

InternalPublicationError

public class PublicationError
extends java.lang.Object

Publication errors are used to communicate exceptions that occur during message publication. The most common reason is most likely an exception thrown during the execution of a message handler. The publication error contains details about to the cause and location where error occurred. They are passed to all registered instances of IPublicationErrorHandler configured within the IBusConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Throwable	cause
private java.lang.String	errorMsg
private java.lang.reflect.Method	handler
private java.lang.Object	listener
private java.lang.Object	message
private IMessagePublication	publication

Constructor Summary

Constructors

Constructor	Description
PublicationError()	Default constructor.
PublicationError(java.lang.Throwable cause, java.lang.String errorMsg)
PublicationError(java.lang.Throwable cause, java.lang.String errorMsg, java.lang.reflect.Method handler, java.lang.Object listener, IMessagePublication publication)	Compound constructor, creating a PublicationError from the supplied objects.
PublicationError(java.lang.Throwable cause, java.lang.String errorMsg, IMessagePublication publication)
PublicationError(java.lang.Throwable cause, java.lang.String errorMsg, SubscriptionContext context)

Method Summary

Modifier and Type	Method	Description
java.lang.Throwable	getCause()
java.lang.reflect.Method	getHandler()
java.lang.Object	getListener()
java.lang.String	getMessage()
java.lang.Object	getPublishedMessage()
PublicationError	setCause(java.lang.Throwable cause)	Assigns the cause of this PublicationError.
PublicationError	setHandler(java.lang.reflect.Method handler)
PublicationError	setListener(java.lang.Object listener)
PublicationError	setMessage(java.lang.String message)
PublicationError	setPublication(IMessagePublication publication)
PublicationError	setPublishedMessage(java.lang.Object message)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cause

private java.lang.Throwable cause

errorMsg

private java.lang.String errorMsg

handler

private java.lang.reflect.Method handler

listener

private java.lang.Object listener

publication

private IMessagePublication publication

message

private java.lang.Object message

Constructor Detail

PublicationError

public PublicationError(java.lang.Throwable cause,
                        java.lang.String errorMsg,
                        java.lang.reflect.Method handler,
                        java.lang.Object listener,
                        IMessagePublication publication)

Compound constructor, creating a PublicationError from the supplied objects.

Parameters:

cause - The Throwable giving rise to this PublicationError.

errorMsg - The message to send.

handler - The method where the error was created.

listener - The object in which the PublicationError was generated.

publication - The publication that errored

PublicationError

public PublicationError(java.lang.Throwable cause,
                        java.lang.String errorMsg,
                        IMessagePublication publication)

PublicationError

public PublicationError(java.lang.Throwable cause,
                        java.lang.String errorMsg,
                        SubscriptionContext context)

PublicationError

public PublicationError(java.lang.Throwable cause,
                        java.lang.String errorMsg)

PublicationError

public PublicationError()

Default constructor.

Method Detail

getCause

public java.lang.Throwable getCause()

Returns:

The Throwable giving rise to this PublicationError.

setCause

public PublicationError setCause(java.lang.Throwable cause)

Assigns the cause of this PublicationError.

Parameters:

cause - A Throwable which gave rise to this PublicationError.

Returns:

This PublicationError.

getMessage

public java.lang.String getMessage()

setMessage

public PublicationError setMessage(java.lang.String message)

setPublishedMessage

public PublicationError setPublishedMessage(java.lang.Object message)

getHandler

public java.lang.reflect.Method getHandler()

setHandler

public PublicationError setHandler(java.lang.reflect.Method handler)

getListener

public java.lang.Object getListener()

setListener

public PublicationError setListener(java.lang.Object listener)

getPublishedMessage

public java.lang.Object getPublishedMessage()

setPublication

public PublicationError setPublication(IMessagePublication publication)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object