io.undertow.servlet.ServletExtension Java Examples

/**
 * Add the default Thorntail {@code favicon.ico} handler.
 *
 * @return This archive.
 */
@SuppressWarnings("unchecked")
default T addFaviconExceptionHandler() throws IOException {
    // Add FaviconServletExtension
    String path = "WEB-INF/classes/" + FaviconServletExtension.EXTENSION_NAME.replace('.', '/') + ".class";
    byte[] generatedExtension;
    generatedExtension = FaviconFactory.createFaviconServletExtension(FaviconServletExtension.EXTENSION_NAME);
    add(new ByteArrayAsset(generatedExtension), path);

    // Add FaviconErrorHandler
    path = "WEB-INF/classes/" + FaviconServletExtension.HANDLER_NAME.replace('.', '/') + ".class";
    byte[] generatedHandler;
    generatedHandler = FaviconFactory.createFaviconErrorHandler(FaviconServletExtension.HANDLER_NAME);
    add(new ByteArrayAsset(generatedHandler), path);

    // Add services entry for FaviconServletExtension
    this.addAsServiceProvider(ServletExtension.class.getName(), FaviconServletExtension.EXTENSION_NAME);

    return (T) this;
}
 

/**
 * Sets up a simple servlet deployment with the provided servlets.
 *
 * This is just a convenience method for simple deployments
 *
 * @param servlets The servlets to add
 */
public static Deployment setupServlet(final ServletExtension servletExtension, final ServletInfo... servlets) {

    final PathHandler pathHandler = new PathHandler();
    final ServletContainer container = ServletContainer.Factory.newInstance();
    DeploymentInfo builder = new DeploymentInfo()
            .setClassLoader(SimpleServletTestCase.class.getClassLoader())
            .setContextPath("/servletContext")
            .setClassIntrospecter(TestClassIntrospector.INSTANCE)
            .setDeploymentName("servletContext.war")
            .addServlets(servlets);
    if(servletExtension != null) {
        builder.addServletExtension(servletExtension);
    }
    DeploymentManager manager = container.addDeployment(builder);
    manager.deploy();
    try {
        pathHandler.addPrefixPath(builder.getContextPath(), manager.start());
    } catch (ServletException e) {
        throw new RuntimeException(e);
    }
    DefaultServer.setRootHandler(pathHandler);

    return manager.getDeployment();

}
 

@BeforeClass
public static void setup() throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
        @Override
        public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
            deploymentInfo.setIgnoreFlush(false);
        }
    },
            new ServletInfo(BLOCKING_SERVLET, BlockingOutputStreamServlet.class)
                    .addMapping("/" + BLOCKING_SERVLET),
            new ServletInfo(ASYNC_SERVLET, AsyncOutputStreamServlet.class)
                    .addMapping("/" + ASYNC_SERVLET)
                    .setAsyncSupported(true),
            new ServletInfo(CONTENT_LENGTH_SERVLET, ContentLengthCloseFlushServlet.class)
                    .addMapping("/" + CONTENT_LENGTH_SERVLET),
            new ServletInfo(RESET, ResetBufferServlet.class).addMapping("/" + RESET));
}
 

@BeforeClass
public static void setup() {
    DeploymentUtils.setupServlet(
            new ServletExtension() {
                @Override
                public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                    throw new RuntimeException("NYI");
                    //deploymentInfo.addInitialHandlerChainWrapper(new RequestBufferingHandler.Wrapper(1));
                }
            },
            new ServletInfo(BLOCKING_SERVLET, BlockingInputStreamServlet.class)
                    .addMapping("/" + BLOCKING_SERVLET),
            new ServletInfo(ASYNC_SERVLET, AsyncInputStreamServlet.class)
                    .addMapping("/" + ASYNC_SERVLET)
                    .setAsyncSupported(true));
}
 

/**
 * Registers a servlet with two filters, one mapped by servlet name and one mapped by url pattern
 */
private void setupServlet() {
    DeploymentUtils.setupServlet(new ServletExtension() {
                                     @Override
                                     public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                                         servletContext
                                                 .addFilter("MyFilter1", filterMappedByServletName)
                                                 .addMappingForServletNames(null, false, SERVLET);

                                         servletContext
                                                 .addFilter("MyFilter2", filterMappedByUrlPattern)
                                                 .addMappingForUrlPatterns(null, false, "/");
                                     }
                                 },
            new ServletInfo(SERVLET, NullServlet.class)
                    .addMapping("/" + SERVLET));
}
 

@BeforeClass
public static void setup() throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
                                     @Override
                                     public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                                         deploymentInfo.addOuterHandlerChainWrapper(new HandlerWrapper() {
                                             @Override
                                             public HttpHandler wrap(HttpHandler handler) {

                                                 byte[] data = "RewriteRule /foo1 /bar1".getBytes(StandardCharsets.UTF_8);
                                                 RewriteConfig config = RewriteConfigFactory.build(new ByteArrayInputStream(data));

                                                 return new RewriteHandler(config, handler);
                                             }
                                         });
                                     }
                                 },
            new ServletInfo("servlet", PathTestServlet.class)
                    .addMapping("/"));
}
 

@BeforeClass
public static void setup() throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
                                     @Override
                                     public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                                         deploymentInfo.addListener(Servlets.listener(AddMultipartServetListener.class));
                                         deploymentInfo.setExceptionHandler(LoggingExceptionHandler.builder().add(RuntimeException.class, "io.undertow", Logger.Level.DEBUG).build());

                                     }
                                 },
            servlet("mp0", MultiPartServlet.class)
                    .addMapping("/0"),
            servlet("mp1", MultiPartServlet.class)
                    .addMapping("/1")
                    .setMultipartConfig(multipartConfig(null, 0, 0, 0)),
            servlet("mp2", MultiPartServlet.class)
                    .addMapping("/2")
                    .setMultipartConfig(multipartConfig(null, 0, 3, 0)),
            servlet("mp3", MultiPartServlet.class)
                    .addMapping("/3")
                    .setMultipartConfig(multipartConfig(null, 3, 0, 0)));
}
 

@BeforeClass
public static void setup() throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
                                     @Override
                                     public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                                         deploymentInfo.setDefaultEncoding("UTF-8");
                                     }
                                 },
            servlet("servlet", DefaultCharsetServlet.class)
                    .addMapping("/writer"),
            servlet("form", DefaultCharsetFormParserServlet.class)
                    .addMapping("/form"));
}
 

@BeforeClass
public static void setup() throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
        @Override
        public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
            deploymentInfo.addErrorPages(new ErrorPage("/500", StatusCodes.INTERNAL_SERVER_ERROR));
        }
    },
            servlet("messageServlet", MessageServlet.class)
                    .addInitParam(MessageServlet.MESSAGE, HELLO_WORLD)
                    .setAsyncSupported(true)
                    .addMapping("/message"),
            servlet("500", MessageServlet.class)
                    .addInitParam(MessageServlet.MESSAGE, "500")
                    .setAsyncSupported(true)
                    .addMapping("/500"),
            servlet("asyncServlet", AsyncServlet.class)
                    .addInitParam(MessageServlet.MESSAGE, HELLO_WORLD)
                    .setAsyncSupported(true)
                    .addMapping("/async"),
            servlet("asyncServlet2", AnotherAsyncServlet.class)
                    .setAsyncSupported(true)
                    .addMapping("/async2"),
            servlet("error", AsyncErrorServlet.class)
                    .setAsyncSupported(true)
                    .addMapping("/error"),
            servlet("dispatch", AsyncDispatchServlet.class)
                    .setAsyncSupported(true)
                    .addMapping("/dispatch"),
            servlet("doubleCompleteServlet", AsyncDoubleCompleteServlet.class)
                    .setAsyncSupported(true)
                    .addMapping("/double-complete"));

}
 

private void setup(final String defaultEncoding) throws ServletException {
    DeploymentUtils.setupServlet(new ServletExtension() {
                                     @Override
                                     public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
                                         if (defaultEncoding != null) {
                                             deploymentInfo.setDefaultEncoding(defaultEncoding);
                                         }
                                     }
                                 },
            Servlets.servlet("servlet", DefaultCharacterEncodingServlet.class)
                    .addMapping("/"));
}
 

@BeforeClass
public static void setup() {
    DeploymentUtils.setupServlet(new ServletExtension() {
        @Override
        public void handleDeployment(DeploymentInfo deploymentInfo, ServletContext servletContext) {
            deploymentInfo.setServletSessionConfig(new ServletSessionConfig().setSessionTrackingModes(Collections.singleton(SessionTrackingMode.URL)));
        }
    }, Servlets.servlet(URLRewritingServlet.class).addMapping("/foo"));
}
 

public ServletExtension getValue() {
    return value;
}
 

public List<ServletExtension> getServletExtensions() {
    return servletExtensions;
}
 

public static List<ServletExtension> getServletExtensions() {
    return extensions;
}
 

@Override
public void removedService(ServiceReference<ServletExtension> reference, ServletExtension service) {
    ServletExtensionHolder.getServletExtensions().remove(service);
}
 

@Override
public void modifiedService(ServiceReference<ServletExtension> reference, ServletExtension service) {
    ServletExtensionHolder.getServletExtensions().add(service);
}
 

@Override
public ServletExtension addingService(ServiceReference<ServletExtension> reference) {
    return null;
}
 

@Override
public void start(BundleContext context) throws Exception {
    tracker = new ServiceTracker<>(context, ServletExtension.class, this);
    tracker.open();
}
 

public List<ServletExtension> getServletExtensions() {
    return servletExtensions;
}
 

public void addServletExtension(RuntimeValue<DeploymentInfo> deployment, ServletExtension extension) {
    deployment.getValue().addServletExtension(extension);
}
 

public ServletExtensionBuildItem(ServletExtension value) {
    this.value = value;
}
 

@Override
public void start(BundleContext context) throws Exception {
    // Register the service in the OSGi registry.
    registration = context.registerService(ServletExtension.class, new Bootstrap(), null);
}
 

@Override
public void start(BundleContext context) throws Exception {
    tracker = new ServiceTracker<>(context, ServletExtension.class, this);
    tracker.open();
}
 

@Override
public ServletExtension addingService(ServiceReference<ServletExtension> reference) {
    return null;
}
 

@Override
public void modifiedService(ServiceReference<ServletExtension> reference, ServletExtension service) {
    ServletExtensionHolder.getServletExtensions().add(service);
}
 

@Override
public void removedService(ServiceReference<ServletExtension> reference, ServletExtension service) {
    ServletExtensionHolder.getServletExtensions().remove(service);
}
 

public static List<ServletExtension> getServletExtensions() {
    return extensions;
}
 

/**
 * Adds an additional servlet extension to the deployment. Servlet extensions are generally discovered
 * using META-INF/services entries, however this may not be practical in all environments.
 * @param servletExtension The servlet extension
 * @return this
 */
public DeploymentInfo addServletExtension(final ServletExtension servletExtension) {
    this.servletExtensions.add(servletExtension);
    return this;
}
 

/**
 * Adds an additional servlet extension to the deployment. Servlet extensions are generally discovered
 * using META-INF/services entries, however this may not be practical in all environments.
 * @param servletExtension The servlet extension
 * @return this
 */
public DeploymentInfo addServletExtension(final ServletExtension servletExtension) {
    this.servletExtensions.add(servletExtension);
    return this;
}