All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.bootique.jersey.JerseyModule Maven / Gradle / Ivy

    There is a newer version: 3.0.M2
    Show newest version
    package io.bootique.jersey;

import com.google.inject.Binder;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Provides;
import com.google.inject.Singleton;
import com.google.inject.multibindings.Multibinder;
import io.bootique.ConfigModule;
import io.bootique.config.ConfigurationFactory;
import io.bootique.jetty.JettyModule;
import io.bootique.jetty.MappedServlet;
import org.glassfish.jersey.server.ResourceConfig;

import javax.ws.rs.container.DynamicFeature;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Feature;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

public class JerseyModule extends ConfigModule {

	private String urlPattern = "/*";
	private Class application;
	private Collection> resources = new HashSet<>();
	private Collection packageRoots = new HashSet<>();

	/**
	 * @param binder
	 *            DI binder passed to the Module that invokes this method.
	 * @since 0.11
	 * @return returns a {@link Multibinder} for JAX-RS Features.
	 */
	public static Multibinder contributeFeatures(Binder binder) {
		return Multibinder.newSetBinder(binder, Feature.class);
	}

	/**
	 * @param binder
	 *            DI binder passed to the Module that invokes this method.
	 * @since 0.12
	 * @return returns a {@link Multibinder} for JAX-RS DynamicFeatures.
	 */
	public static Multibinder contributeDynamicFeatures(Binder binder) {
		return Multibinder.newSetBinder(binder, DynamicFeature.class);
	}

	/**
	 * @param binder
	 *            DI binder passed to the Module that invokes this method.
	 * @since 0.15
	 * @return returns a {@link Multibinder} for explicitly registered JAX-RS
	 *         resource types.
	 */
	public static Multibinder contributeResources(Binder binder) {
		return Multibinder.newSetBinder(binder, Key.get(Object.class, JerseyResource.class));
	}

	/**
	 * @param binder
	 *            DI binder passed to the Module that invokes this method.
	 * @since 0.15
	 * @return returns a {@link Multibinder} for packages that contain JAX-RS
	 *         resource classes.
	 */
	public static Multibinder contributePackages(Binder binder) {
		return Multibinder.newSetBinder(binder, Package.class);
	}

	/**
	 * Creates a builder of {@link JerseyModule}.
	 * 
	 * @since 0.11
	 * @deprecated since 0.15 use {@link #contributePackages(Binder)} and
	 *             {@link #contributeResources(Binder)}.
	 */
	public static Builder builder() {
		return new Builder();
	}

	@Override
	public void configure(Binder binder) {

		JettyModule.contributeMappedServlets(binder)
				.addBinding().to(Key.get(MappedServlet.class, JerseyServlet.class));

		// trigger extension points creation and provide default contributions
		JerseyModule.contributeFeatures(binder);
		JerseyModule.contributeDynamicFeatures(binder);
		JerseyModule.contributePackages(binder);
		JerseyModule.contributeResources(binder);
	}

	@Singleton
	@Provides
	private ResourceConfig createResourceConfig(Injector injector, Set features,
			Set dynamicFeatures, @JerseyResource Set resources, Set packages) {

		ResourceConfig config = application != null ? ResourceConfig.forApplicationClass(application)
				: new ResourceConfig();

		// loaded deprecated configs provided via the builder
		this.packageRoots.forEach(p -> config.packages(true, p));
		this.resources.forEach(r -> config.register(r));
		
		packages.forEach(p -> config.packages(true, p.getName()));
		resources.forEach(r -> config.register(r));

		features.forEach(f -> config.register(f));
		dynamicFeatures.forEach(df -> config.register(df));

		// TODO: make this pluggable?
		config.register(ResourceModelDebugger.class);

		// register Guice Injector as a service in Jersey HK2, and
		// GuiceBridgeFeature as a
		GuiceBridgeFeature.register(config, injector);

		return config;
	}

	@JerseyServlet
	@Provides
	@Singleton
	private MappedServlet createJerseyServlet(ConfigurationFactory configFactory, ResourceConfig config) {
		return configFactory.config(JerseyServletFactory.class, configPrefix).initUrlPatternIfNotSet(urlPattern)
				.createJerseyServlet(config);
	}

	/**
	 * @deprecated since 0.15 use {@link #contributePackages(Binder)} and
	 *             {@link #contributeResources(Binder)}.
	 */
	public static class Builder {

		private JerseyModule module;

		private Builder() {
			this.module = new JerseyModule();
		}

		public JerseyModule build() {
			return module;
		}

		/**
		 * @since 0.11
		 * @param urlPattern
		 *            a URL pattern for the Jersey servlet within Jetty app
		 *            context.
		 * @return self
		 */
		public Builder urlPattern(String urlPattern) {
			module.urlPattern = urlPattern;
			return this;
		}

		public Builder resource(Class resourceType) {
			module.resources.add(resourceType);
			return this;
		}

		public Builder packageRoot(Package aPackage) {
			module.packageRoots.add(aPackage.getName());
			return this;
		}

		public Builder packageRoot(Class classFromPackage) {
			// TODO: test with inner classes
			String name = classFromPackage.getName();
			int dot = name.lastIndexOf('.');
			if (dot <= 0) {
				throw new IllegalArgumentException("Class is in default package - unsupported");
			}

			module.packageRoots.add(name.substring(0, dot));
			return this;
		}

		public  Builder application(Class application) {
			module.application = application;
			return this;
		}

	}
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy