Contact us
Create app
com.vaadin.server.

Class CustomizedSystemMessages

  • All Implemented Interfaces:

    Serializable

    public class CustomizedSystemMessages
extends SystemMessages

    Contains the system messages used to notify the user about various critical situations that can occur.

    Vaadin gets the SystemMessages from your application by calling a static getSystemMessages() method. By default the Application.getSystemMessages() is used. You can customize this by defining a static MyApplication.getSystemMessages() and returning CustomizedSystemMessages. Note that getSystemMessages() is static - changing the system messages will by default change the message for all users of the application.

    The default behavior is to show a notification, and restart the application if the user clicks the message.
    Instead of restarting the application, you can set a specific URL that the user is taken to.
    Setting both caption and message to null will restart the application (or go to the specified URL) without displaying a notification. set*NotificationEnabled(false) will achieve the same thing.

    The situations are:
    • Session expired: the user session has expired, usually due to inactivity.
    • Authentication error: the client received a 401 (Unauthorized) response from the server.
    • Communication error: the client failed to contact the server, or the server returned an invalid response.
    • Internal error: unhandled critical server error (e.g out of memory, database crash)
    • Cookies disabled: the browser does not support cookies

    See Also:

    Serialized Form

    • Constructor Detail

      • CustomizedSystemMessages

        public CustomizedSystemMessages()

    • Method Detail

      • setSessionExpiredURL

        public void setSessionExpiredURL​(String sessionExpiredURL)

        Sets the URL to go to when the session has expired.

        Parameters:

        sessionExpiredURL - the URL to go to, or null to reload current

      • setSessionExpiredNotificationEnabled

        public void setSessionExpiredNotificationEnabled​(boolean sessionExpiredNotificationEnabled)

        Enables or disables the notification. If disabled, the set URL (or current) is loaded directly when next transaction between server and client happens.

        Parameters:

        sessionExpiredNotificationEnabled - true = enabled, false = disabled

      • setSessionExpiredCaption

        public void setSessionExpiredCaption​(String sessionExpiredCaption)

        Sets the caption of the notification. Set to null for no caption. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()

        Parameters:

        sessionExpiredCaption - the caption

      • setSessionExpiredMessage

        public void setSessionExpiredMessage​(String sessionExpiredMessage)

        Sets the message of the notification. Set to null for no message. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()

        Parameters:

        sessionExpiredMessage - the message

      • setAuthenticationErrorURL

        public void setAuthenticationErrorURL​(String authenticationErrorURL)

        Sets the URL to go to when there is a authentication error.

        Parameters:

        authenticationErrorURL - the URL to go to, or null to reload current

      • setAuthenticationErrorNotificationEnabled

        public void setAuthenticationErrorNotificationEnabled​(boolean authenticationErrorNotificationEnabled)

        Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

        Parameters:

        authenticationErrorNotificationEnabled - true = enabled, false = disabled

      • setAuthenticationErrorCaption

        public void setAuthenticationErrorCaption​(String authenticationErrorCaption)

        Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

        Parameters:

        authenticationErrorCaption - the caption

      • setAuthenticationErrorMessage

        public void setAuthenticationErrorMessage​(String authenticationErrorMessage)

        Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

        Parameters:

        authenticationErrorMessage - the message

      • setCommunicationErrorURL

        public void setCommunicationErrorURL​(String communicationErrorURL)

        Sets the URL to go to when there is a communication error.

        Parameters:

        communicationErrorURL - the URL to go to, or null to reload current

      • setCommunicationErrorNotificationEnabled

        public void setCommunicationErrorNotificationEnabled​(boolean communicationErrorNotificationEnabled)

        Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

        Parameters:

        communicationErrorNotificationEnabled - true = enabled, false = disabled

      • setCommunicationErrorCaption

        public void setCommunicationErrorCaption​(String communicationErrorCaption)

        Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

        Parameters:

        communicationErrorCaption - the caption

      • setCommunicationErrorMessage

        public void setCommunicationErrorMessage​(String communicationErrorMessage)

        Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

        Parameters:

        communicationErrorMessage - the message

      • setInternalErrorURL

        public void setInternalErrorURL​(String internalErrorURL)

        Sets the URL to go to when an internal error occurs.

        Parameters:

        internalErrorURL - the URL to go to, or null to reload current

      • setInternalErrorNotificationEnabled

        public void setInternalErrorNotificationEnabled​(boolean internalErrorNotificationEnabled)

        Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.

        Parameters:

        internalErrorNotificationEnabled - true = enabled, false = disabled

      • setInternalErrorCaption

        public void setInternalErrorCaption​(String internalErrorCaption)

        Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;

        Parameters:

        internalErrorCaption - the caption

      • setInternalErrorMessage

        public void setInternalErrorMessage​(String internalErrorMessage)

        Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;

        Parameters:

        internalErrorMessage - the message

      • setCookiesDisabledURL

        public void setCookiesDisabledURL​(String cookiesDisabledURL)

        Sets the URL to redirect to when the browser has cookies disabled.

        Parameters:

        cookiesDisabledURL - the URL to redirect to, or null to reload the current URL

      • setCookiesDisabledNotificationEnabled

        public void setCookiesDisabledNotificationEnabled​(boolean cookiesDisabledNotificationEnabled)

        Enables or disables the notification for "cookies disabled" messages. If disabled, the URL returned by SystemMessages.getCookiesDisabledURL() is loaded directly.

        Parameters:

        cookiesDisabledNotificationEnabled - true to enable "cookies disabled" messages, false otherwise

      • setCookiesDisabledCaption

        public void setCookiesDisabledCaption​(String cookiesDisabledCaption)

        Sets the caption of the "cookies disabled" notification. Set to null for no caption. If both caption and message is null, the notification is disabled.

        Parameters:

        cookiesDisabledCaption - the caption for the "cookies disabled" notification

      • setCookiesDisabledMessage

        public void setCookiesDisabledMessage​(String cookiesDisabledMessage)

        Sets the message of the "cookies disabled" notification. Set to null for no message. If both caption and message is null, the notification is disabled.

        Parameters:

        cookiesDisabledMessage - the message for the "cookies disabled" notification