Class UserActionRequiredException

  • All Implemented Interfaces:
    java.io.Serializable

    @API(src=PUBLIC,
         type=NOT_EXTENDABLE)
    public class UserActionRequiredException
    extends java.io.IOException
    Class that extends an IOException with an WebappMessage that should be sent to the client-side code.
    Since:
    17
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      WebappMessage getUserMessage()
      The message to be sent to the client-side code.
      UserActionRequiredMessage getUserMessage​(java.net.URL url)
      The message to be sent to the client-side code.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • UserActionRequiredException

        public UserActionRequiredException​(WebappMessage webappMessage)
        Constructor.
        Parameters:
        webappMessage - The webapp message.
    • Method Detail

      • getUserMessage

        public WebappMessage getUserMessage()
        The message to be sent to the client-side code.
        Returns:
        The webapp message.
      • getUserMessage

        public UserActionRequiredMessage getUserMessage​(java.net.URL url)
        The message to be sent to the client-side code.
        Parameters:
        url - The URL of the resource for which the user action required exception is thrown.
        Returns:
        The webapp message.