com.paypal.springboot.resteasy.ResteasyApplicationBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resteasy-spring-boot-starter Show documentation
A Spring Boot starter for RESTEasy
There is a newer version: 2.3.4-RELEASE
Show newest version
package com.paypal.springboot.resteasy;

import java.util.Set;

import javax.servlet.Servlet;
import javax.servlet.ServletContainerInitializer;

import org.jboss.resteasy.plugins.server.servlet.HttpServlet30Dispatcher;
import org.jboss.resteasy.plugins.server.servlet.ResteasyContextParameters;
import org.jboss.resteasy.plugins.servlet.ResteasyServletInitializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.servlet.ServletRegistrationBean;

/**
 * This class is the Spring Boot equivalent of {@link ResteasyServletInitializer},
 * which implements the Servlet API {@link ServletContainerInitializer} interface
 * to find all JAX-RS Application, Provider and Path classes in the classpath.
 *
 * As we all know, in Spring Boot we use an embedded servlet container. However,
 * the Servlet spec does not support embedded containers, and many portions of it
 * do not apply to embedded containers, and ServletContainerInitializer is one of them.
 *
 * This class fills in this gap.
 *
 * Notice that the JAX-RS Application classes are found in this RESTEasy starter by class
 * ResteasyEmbeddedServletInitializer, and that is done by scanning the classpath.
 *
 * The Path and Provider annotated classes are found by using Spring framework (instead of
 * scanning the classpath), since it is assumed those classes are ALWAYS necessarily
 * Spring beans (this starter is meant for Spring Boot applications that use RESTEasy
 * as the JAX-RS implementation)
 *
 * @author Fabio Carvalho ([email protected] or [email protected])
 */
public class ResteasyApplicationBuilder {

	public static final String BEAN_NAME = "JaxrsApplicationServletBuilder";

	private static final Logger logger = LoggerFactory.getLogger(ResteasyApplicationBuilder.class);

	public ServletRegistrationBean build(String applicationClassName, String path, Set> resources, Set> providers) {
		Servlet servlet = new HttpServlet30Dispatcher();

		ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(servlet);

		servletRegistrationBean.setName(applicationClassName);
		servletRegistrationBean.setLoadOnStartup(1);
		servletRegistrationBean.setAsyncSupported(true);
		servletRegistrationBean.addInitParameter("javax.ws.rs.Application", applicationClassName);

		if (path != null) {
			String mapping = path;
			if (!mapping.startsWith("/"))
				mapping = "/" + mapping;
			String prefix = mapping;
			if (!"/".equals(prefix) && prefix.endsWith("/"))
				prefix = prefix.substring(0, prefix.length() - 1);
			if (mapping.endsWith("/"))
				mapping += "*";
			else
				mapping += "/*";
			// resteasy.servlet.mapping.prefix
			servletRegistrationBean.addInitParameter("resteasy.servlet.mapping.prefix", prefix);
			servletRegistrationBean.addUrlMappings(mapping);
		}

		if (resources.size() > 0) {
			StringBuilder builder = new StringBuilder();
			boolean first = true;
			for (Class resource : resources) {
				if (first) {
					first = false;
				} else {
					builder.append(",");
				}

				builder.append(resource.getName());
			}
			servletRegistrationBean.addInitParameter(ResteasyContextParameters.RESTEASY_SCANNED_RESOURCES, builder.toString());
		}
		if (providers.size() > 0) {
			StringBuilder builder = new StringBuilder();
			boolean first = true;
			for (Class provider : providers) {
				if (first) {
					first = false;
				} else {
					builder.append(",");
				}
				builder.append(provider.getName());
			}
			servletRegistrationBean.addInitParameter(ResteasyContextParameters.RESTEASY_SCANNED_PROVIDERS, builder.toString());
		}

		logger.debug("ServletRegistrationBean has just bean created for JAX-RS class" + applicationClassName);

		return servletRegistrationBean;
	}

}