org.jboss.resteasy.plugins.servlet.ResteasyServletInitializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resteasy-servlet-initializer Show documentation
There is a newer version: 7.0.0.Alpha3
Show newest version
package org.jboss.resteasy.plugins.servlet;

import java.util.HashSet;
import java.util.Set;

import jakarta.servlet.MultipartConfigElement;
import jakarta.servlet.ServletContainerInitializer;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRegistration;
import jakarta.servlet.annotation.HandlesTypes;
import jakarta.servlet.annotation.MultipartConfig;
import jakarta.ws.rs.ApplicationPath;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.core.Application;
import jakarta.ws.rs.ext.Provider;

import org.jboss.resteasy.core.AsynchronousDispatcher;
import org.jboss.resteasy.plugins.server.servlet.HttpServlet30Dispatcher;
import org.jboss.resteasy.plugins.server.servlet.ResteasyContextParameters;
import org.jboss.resteasy.plugins.servlet.i18n.Messages;
import org.jboss.resteasy.spi.NotImplementedYetException;

/**
 * @author Bill Burke
 * @version $Revision: 1 $
 */
@HandlesTypes({ Application.class, Path.class, Provider.class })
public class ResteasyServletInitializer implements ServletContainerInitializer {
    private static final String RESTEASY_MAPPING_PREFIX = "resteasy.servlet.mapping.prefix";
    private static final String APPLICATION = "jakarta.ws.rs.Application";
    static final Set ignoredPackages = new HashSet();

    static {
        ignoredPackages.add(AsynchronousDispatcher.class.getPackage().getName());
    }

    @Override
    public void onStartup(Set> classes, ServletContext servletContext) throws ServletException {
        if (classes == null || classes.size() == 0)
            return;
        Set> appClasses = new HashSet>();
        Set> providers = new HashSet>();
        Set> resources = new HashSet>();

        for (Class clazz : classes) {
            if (clazz.isInterface() || ignoredPackages.contains(clazz.getPackage().getName()))
                continue;
            if (clazz.isAnnotationPresent(Path.class))
                resources.add(clazz);
            else if (clazz.isAnnotationPresent(Provider.class))
                providers.add(clazz);
            else if (Application.class.isAssignableFrom(clazz))
                appClasses.add(clazz);
        }
        if (appClasses.size() == 0 && resources.size() == 0)
            return;

        if (appClasses.size() == 0) {
            // todo make sure we can do this on all servlet containers
            // handleNoApplicationClass(providers, resources, servletContext);
            return;
        }

        for (Class app : appClasses) {
            register(app, providers, resources, servletContext);
        }
    }

    protected void handleNoApplicationClass(Set> providers, Set> resources, ServletContext servletContext) {
        ServletRegistration defaultApp = null;
        for (ServletRegistration reg : servletContext.getServletRegistrations().values()) {
            if (reg.getName().equals(Application.class.getName())) {
                defaultApp = reg;
            }
        }
        if (defaultApp == null)
            return;
        throw new NotImplementedYetException(Messages.MESSAGES.defaultApplicationNotImplemented());

    }

    private Set getServletsForApplication(Class applicationClass, ServletContext servletContext) {
        Set set = new HashSet<>();
        ServletRegistration reg = servletContext.getServletRegistration(applicationClass.getName());
        if (reg != null && reg.getMappings().size() == 1)
            set.add(reg);

        for (ServletRegistration sr : servletContext.getServletRegistrations().values()) {
            String appClassName = sr.getInitParameter(APPLICATION);
            if (applicationClass.getName().equals(appClassName) && sr.getMappings().size() == 1)
                set.add(sr);
        }
        return set;
    }

    protected void register(Class applicationClass, Set> providers, Set> resources,
            ServletContext servletContext) {
        Set servletsForApp = getServletsForApplication(applicationClass, servletContext);
        // ignore @ApplicationPath if application is already mapped in web.xml
        if (!servletsForApp.isEmpty()) {
            for (ServletRegistration servletReg : servletsForApp) {
                String servletClassName = servletReg.getClassName();
                if (servletClassName == null)
                    servletContext.addServlet(servletReg.getName(), HttpServlet30Dispatcher.class);
                String prefix = servletReg.getMappings().iterator().next();
                if (prefix.endsWith("*"))
                    prefix = prefix.substring(0, prefix.length() - 1);
                if (prefix.length() > 1 && prefix.endsWith("/"))
                    prefix = prefix.substring(0, prefix.length() - 1);
                registerResourcesAndProviders(servletReg, providers, resources, applicationClass, prefix);
            }
            return;
        }
        ApplicationPath path = applicationClass.getAnnotation(ApplicationPath.class);
        if (path == null) {
            // Application subclass has no @ApplicationPath and no declared mappings to use
            // TODO: add debug message indicating that an Application was detected but could
            // not be mapped
            return;
        }
        ServletRegistration.Dynamic reg;
        String mapping = path.value();
        String prefix;

        if (!mapping.startsWith("/"))
            mapping = "/" + mapping;
        prefix = mapping;
        if (!prefix.equals("/") && prefix.endsWith("/"))
            prefix = prefix.substring(0, prefix.length() - 1);
        if (!mapping.endsWith("/*")) {
            if (mapping.endsWith("/"))
                mapping += "*";
            else
                mapping += "/*";
        }

        reg = servletContext.addServlet(applicationClass.getName(), HttpServlet30Dispatcher.class);
        reg.setLoadOnStartup(1);
        reg.setAsyncSupported(true);
        reg.addMapping(mapping);
        final MultipartConfig multipartConfig = applicationClass.getAnnotation(MultipartConfig.class);
        if (multipartConfig != null) {
            reg.setMultipartConfig(new MultipartConfigElement(multipartConfig));
        }

        registerResourcesAndProviders(reg, providers, resources, applicationClass, prefix);
    }

    private void registerResourcesAndProviders(ServletRegistration reg, Set> providers, Set> resources,
            Class appClass, String prefix) {
        reg.setInitParameter(APPLICATION, appClass.getName());
        // resteasy.servlet.mapping.prefix
        reg.setInitParameter(RESTEASY_MAPPING_PREFIX, prefix);
        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());
            }
            reg.setInitParameter(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());
            }
            reg.setInitParameter(ResteasyContextParameters.RESTEASY_SCANNED_PROVIDERS, builder.toString());
        }
    }
}