hudson.util

Class AdministrativeError

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.AdministrativeMonitor

hudson.util.AdministrativeError

All Implemented Interfaces:

ExtensionPoint, ModelObject, SearchableModelObject, SearchItem, org.kohsuke.stapler.StaplerProxy

public class AdministrativeError
extends AdministrativeMonitor

A convenient AdministrativeMonitor implementations that show an error message and optional stack trace. This is useful for notifying a non-fatal error to the administrator.

These errors are registered when instances are created. No need to use Extension.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
Throwable	details
String	message
String	title

Fields inherited from class hudson.model.AdministrativeMonitor

id

Constructor Summary

Constructors

Constructor and Description
AdministrativeError(String id, String title, String message, Throwable details)

Method Summary

Modifier and Type	Method and Description
boolean	isActivated() Returns true if this monitor is activated and wants to produce a warning message.

Methods inherited from class hudson.model.AdministrativeMonitor

all, disable, doDisable, getDisplayName, getRequiredPermission, getSearchUrl, getTarget, getUrl, isEnabled

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Field Detail

message

public final String message

title

public final String title

details

public final Throwable details

Constructor Detail

AdministrativeError

public AdministrativeError(String id,
                           String title,
                           String message,
                           Throwable details)

Parameters:

id - Unique ID that distinguishes this error from other errors. Must remain the same across Hudson executions. Use a caller class name, or something like that.

title - A title of the problem. This is used as the HTML title of the details page. Should be just one sentence, like "ZFS migration error."

message - A short description of the problem. This is used in the "/manage" page, and can include HTML, but it should be still short.

details - An exception indicating the problem. The administrator can see this once they click "more details".

Method Detail

isActivated

public boolean isActivated()

Description copied from class: AdministrativeMonitor

Returns true if this monitor is activated and wants to produce a warning message.

This method is called from the HTML rendering thread, so it should run efficiently.

Specified by:

isActivated in class AdministrativeMonitor