Summary: Methods | [Expand All]
@PublicApi public interface

MessageHandlerErrorCollector

com.atlassian.jira.service.util.handler.MessageHandlerErrorCollector
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Message handlers should report here what they are doing. Depending on the context in which handlers are run (either normal production run as from a scheduled service or in a test mode - a dry run - from UI) this information can be transparently routed to appropriate place. Consider passing here translated strings (i18n), do not pass i18n keys.

Summary

Public Methods
void error(String error, Throwable e)
Report an error.
void error(String error)
Report an error.
void info(String info, Throwable e)
Report valuable information for JIRA admin
void info(String info)
Report valuable information for JIRA admin
void warning(String warning)
Report a warning
void warning(String warning, Throwable e)
Report a warning

Public Methods

public void error (String error, Throwable e)

Report an error.

Parameters
error a serious problem which usually makes further handling of given message pointless
e associated throwable or null

public void error (String error)

Report an error.

Parameters
error a serious problem which usually makes further handling of given message pointless

public void info (String info, Throwable e)

Report valuable information for JIRA admin

Parameters
info information message (something expected, OK, normal)
e associated throwable or null

public void info (String info)

Report valuable information for JIRA admin

Parameters
info information message (something expected, OK, normal)

public void warning (String warning)

Report a warning

Parameters
warning a warning, but nothing critical for the handler

public void warning (String warning, Throwable e)

Report a warning

Parameters
warning a warning, but nothing critical for the handler
e associated throwable or null