com.vaadin.server.SystemError Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import com.vaadin.shared.ui.ErrorLevel;
/**
* SystemError is an error message for a problem caused by error in
* system, not the user application code. The system error can contain technical
* information such as stack trace and exception.
*
* SystemError does not support HTML in error messages or stack traces. If HTML
* messages are required, use {@link UserError} or a custom implementation of
* {@link ErrorMessage}.
*
* @author Vaadin Ltd.
* @since 3.0
*/
@SuppressWarnings("serial")
public class SystemError extends AbstractErrorMessage {
/**
* Constructor for SystemError with error message specified.
*
* @param message
* the Textual error description.
*/
public SystemError(String message) {
super(message);
setErrorLevel(ErrorLevel.SYSTEM);
setMode(ContentMode.HTML);
setMessage(getHtmlMessage());
}
/**
* Constructor for SystemError with causing exception and error message.
*
* @param message
* the Textual error description.
* @param cause
* the throwable causing the system error.
*/
public SystemError(String message, Throwable cause) {
this(message);
addCause(AbstractErrorMessage.getErrorMessageForException(cause));
}
/**
* Constructor for SystemError with cause.
*
* @param cause
* the throwable causing the system error.
*/
public SystemError(Throwable cause) {
this(null, cause);
}
/**
* Returns the message of the error in HTML.
*
* Note that this API may change in future versions.
*/
protected String getHtmlMessage() {
// TODO wrapping div with namespace? See the old code:
// target.addXMLSection("div", message,
// "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd");
StringBuilder sb = new StringBuilder();
if (getMessage() != null) {
sb.append("");
sb.append(VaadinServlet.safeEscapeForHtml(getMessage()));
sb.append("
");
}
return sb.toString();
}
}