Interface OptingServlet

  • All Superinterfaces:
    Servlet
    All Known Subinterfaces:
    NonExistingResourceServlet
    All Known Implementing Classes:
    NonExistingDispatcherServlet, ProxyServlet

    @ConsumerType
    public interface OptingServlet
    extends Servlet
    The OptingServlet interface may be implemented by Servlets used by Sling which may choose to not handle all requests for which they would be selected based on their registration properties. Note that servlets implementing this interface can have an impact on system performance, as their resolution cannot be cached: the resolver has no insight into which parts of the request cause accepts(org.apache.sling.api.SlingHttpServletRequest) to return true.
    • Method Detail

      • accepts

        boolean accepts​(@NotNull
                        @NotNull SlingHttpServletRequest request)
        Examines the request, and return true if this servlet is willing to handle the request. If false is returned, the request will be ignored by this servlet, and may be handled by other servlets.
        Parameters:
        request - The request to examine
        Returns:
        true if this servlet will handle the request, false otherwise