Package io.dropwizard.jetty.setup

Class ServletEnvironment

java.lang.Object
io.dropwizard.jetty.setup.ServletEnvironment
public class ServletEnvironment extends Object

  • Constructor Details

  • Method Details

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(String name, jakarta.servlet.Servlet servlet)
      Add a servlet instance.
      Parameters:
      name - the servlet's name
      servlet - the servlet instance
      Returns:
      a ServletRegistration.Dynamic instance allowing for further configuration

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(String name, Class<? extends jakarta.servlet.Servlet> klass)
      Add a servlet class.
      Parameters:
      name - the servlet's name
      klass - the servlet class
      Returns:
      a ServletRegistration.Dynamic instance allowing for further configuration

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(String name, jakarta.servlet.Filter filter)
      Add a filter instance.
      Parameters:
      name - the filter's name
      filter - the filter instance
      Returns:
      a FilterRegistration.Dynamic instance allowing for further configuration

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(String name, Class<? extends jakarta.servlet.Filter> klass)
      Add a filter class.
      Parameters:
      name - the filter's name
      klass - the filter class
      Returns:
      a FilterRegistration.Dynamic instance allowing for further configuration

    • addServletListeners

      public void addServletListeners(EventListener... listeners)
      Add one or more servlet event listeners.
      Parameters:
      listeners - one or more listener instances that implement ServletContextListener, ServletContextAttributeListener, ServletRequestListener or ServletRequestAttributeListener

    • setProtectedTargets

      public void setProtectedTargets(String... targets)
      Set protected targets.
      Parameters:
      targets - Array of URL prefix. Each prefix is in the form /path and will match either /path exactly or /path/anything

    • setBaseResource

      public void setBaseResource(org.eclipse.jetty.util.resource.Resource baseResource)
      Sets the base resource for this context.
      Parameters:
      baseResource - The resource to be used as the base for all static content of this context.

    • setBaseResource

      public void setBaseResource(org.eclipse.jetty.util.resource.Resource... baseResources)
      Sets the base resources for this context.
      Parameters:
      baseResources - The list of resources to be used as the base for all static content of this context.

    • setBaseResource

      public void setBaseResource(String... resources)
      Sets the base resources for this context.
      Parameters:
      resources - A list of strings representing the base resources to serve static content for the context. Any string accepted by Resource.newResource(String) may be passed and the call is equivalent to setBaseResource(Resource...)}

    • setResourceBase

      public void setResourceBase(String resourceBase)
      Sets the base resource for this context.
      Parameters:
      resourceBase - A string representing the base resource for the context. Any string accepted by Resource.newResource(String) may be passed and the call is equivalent to setBaseResource(Resource)}

    • setInitParameter

      public void setInitParameter(String name, String value)
      Set an initialization parameter.
      Parameters:
      name - Parameter name
      value - Parameter value

    • setSessionHandler

      public void setSessionHandler(org.eclipse.jetty.ee10.servlet.SessionHandler sessionHandler)
      Set the session handler.
      Parameters:
      sessionHandler - The sessionHandler to set.

    • setSecurityHandler

      public void setSecurityHandler(org.eclipse.jetty.security.SecurityHandler securityHandler)
      Set the security handler.
      Parameters:
      securityHandler - The securityHandler to set.

    • addMimeMapping

      public void addMimeMapping(String extension, String type)
      Set a mime mapping.
      Parameters:
      extension - Extension
      type - Mime type