Package org.kohsuke.stapler

Class Stapler

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.kohsuke.stapler.Stapler
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public class Stapler extends jakarta.servlet.http.HttpServlet
Maps an HTTP request to a method call / JSP invocation against a model object by evaluating the request URL in a EL-ish way.

This servlet should be used as the default servlet.

Author:
Kohsuke Kawaguchi
See Also:

  • Field Details

    • CONVERT_UTILS

      public static final org.apache.commons.beanutils.ConvertUtilsBean CONVERT_UTILS
      This is the Converter registry that Stapler uses, primarily for form-to-JSON binding in StaplerRequest2.bindJSON(Class, JSONObject) and its family of methods.

  • Constructor Details

    • Stapler

      public Stapler()

  • Method Details

    • init

      public void init(jakarta.servlet.ServletConfig servletConfig) throws jakarta.servlet.ServletException
      Specified by:
      init in interface jakarta.servlet.Servlet
      Overrides:
      init in class jakarta.servlet.GenericServlet
      Throws:
      jakarta.servlet.ServletException

    • buildResourcePaths

      public void buildResourcePaths()
      Rebuild the internal cache for static resources.

    • getWebApp

      public WebApp getWebApp()

    • service

      protected void service(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse rsp) throws jakarta.servlet.ServletException, IOException
      Overrides:
      service in class jakarta.servlet.http.HttpServlet
      Throws:
      jakarta.servlet.ServletException
      IOException

    • invoke

      public void invoke(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse rsp, Object root, String url) throws IOException, jakarta.servlet.ServletException
      Performs stapler processing on the given root object and request URL.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • isSocketException

      public static boolean isSocketException(Throwable x)
      Used to detect exceptions thrown when writing content that seem to be due merely to a closed socket.
      Parameters:
      x - an exception that got caught
      Returns:
      true if this looks like a closed stream, false for some real problem
      Since:
      1.222

    • forward

      public void forward(jakarta.servlet.RequestDispatcher dispatcher, StaplerRequest2 req, jakarta.servlet.http.HttpServletResponse rsp) throws jakarta.servlet.ServletException, IOException
      Throws:
      jakarta.servlet.ServletException
      IOException

    • getViewURL

      public static String getViewURL(Class clazz, String jspName)
      Gets the URL (e.g., "/WEB-INF/side-files/fully/qualified/class/name/jspName") from a class and the JSP name.

    • setRoot

      public static void setRoot(jakarta.servlet.ServletContextEvent event, Object rootApp)
      Sets the specified object as the root of the web application.

      This method should be invoked from your implementation of ServletContextListener.contextInitialized(ServletContextEvent).

      This is just a convenience method to invoke servletContext.setAttribute("app",rootApp).

      The root object is bound to the URL '/' and used to resolve all the requests to this web application.

    • setClassLoader

      @Deprecated public static void setClassLoader(jakarta.servlet.ServletContext context, ClassLoader classLoader)
      Deprecated.
      Use WebApp.setClassLoader(ClassLoader)
      Sets the classloader used by StaplerRequest2.bindJSON(Class, JSONObject) and its sibling methods.

    • getClassLoader

      @Deprecated public static ClassLoader getClassLoader(jakarta.servlet.ServletContext context)
      Deprecated.
      Use WebApp.getClassLoader()

    • getClassLoader

      @Deprecated public ClassLoader getClassLoader()
      Deprecated.
      Use WebApp.getClassLoader()

    • getCurrentRequest2

      public static StaplerRequest2 getCurrentRequest2()
      Gets the current StaplerRequest2 that the calling thread is associated with.
      Returns:
      null, if called from outside an HTTP handling thread

    • getCurrentRequest

      @Deprecated public static StaplerRequest getCurrentRequest()
      Deprecated.
      use getCurrentRequest2()

    • getCurrentResponse2

      public static StaplerResponse2 getCurrentResponse2()
      Gets the current StaplerResponse2 that the calling thread is associated with.
      Returns:
      null, if called from outside an HTTP handling thread

    • getCurrentResponse

      @Deprecated public static StaplerResponse getCurrentResponse()
      Deprecated.
      use getCurrentResponse2()

    • getCurrent

      public static Stapler getCurrent()
      Gets the current Stapler that the calling thread is associated with.
      Returns:
      null, if called from outside an HTTP handling thread

    • lookupConverter

      public static org.apache.commons.beanutils.Converter lookupConverter(Class type)

    • escape

      public static String escape(String v)
      Escapes HTML/XML unsafe characters for the PCDATA section. This method does not handle whitespace-preserving escape, nor attribute escapes.

    • htmlSafeArguments

      public static Object[] htmlSafeArguments(Object[] args)

    • htmlSafeArgument

      public static Object htmlSafeArgument(Object o)
      For XSS prevention, escape unsafe characters in String by default, unless it's specifically wrapped in RawHtmlArgument.