public class AdministrativeError extends AdministrativeMonitor
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
.
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
Throwable |
details |
String |
message |
String |
title |
id
Constructor and Description |
---|
AdministrativeError(String id,
String title,
String message,
Throwable details) |
Modifier and Type | Method and Description |
---|---|
boolean |
isActivated()
Returns true if this monitor is activated and
wants to produce a warning message.
|
all, disable, doDisable, getDisplayName, getRequiredPermission, getSearchUrl, getTarget, getUrl, isEnabled, isSecurity
getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError
public final String message
public final String title
public final Throwable details
public AdministrativeError(String id, String title, String message, Throwable details)
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".public boolean isActivated()
AdministrativeMonitor
This method is called from the HTML rendering thread, so it should run efficiently.
isActivated
in class AdministrativeMonitor
Copyright © 2004–2021. All rights reserved.