All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.jersey.server.ApplicationHandler Maven / Gradle / Ivy

Go to download

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.8
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.jersey.server;

import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.security.Principal;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.ws.rs.HttpMethod;
import javax.ws.rs.NameBinding;
import javax.ws.rs.RuntimeType;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.container.DynamicFeature;
import javax.ws.rs.container.PreMatching;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Configuration;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MultivaluedHashMap;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.WriterInterceptor;

import javax.inject.Singleton;

import org.glassfish.jersey.CommonProperties;
import org.glassfish.jersey.internal.Errors;
import org.glassfish.jersey.internal.ServiceConfigurationError;
import org.glassfish.jersey.internal.ServiceFinder;
import org.glassfish.jersey.internal.Version;
import org.glassfish.jersey.internal.inject.Injections;
import org.glassfish.jersey.internal.inject.JerseyClassAnalyzer;
import org.glassfish.jersey.internal.inject.ProviderBinder;
import org.glassfish.jersey.internal.inject.Providers;
import org.glassfish.jersey.internal.util.PropertiesHelper;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.internal.util.collection.Ref;
import org.glassfish.jersey.message.internal.NullOutputStream;
import org.glassfish.jersey.model.ContractProvider;
import org.glassfish.jersey.model.internal.ComponentBag;
import org.glassfish.jersey.model.internal.RankedComparator;
import org.glassfish.jersey.model.internal.RankedComparator.Order;
import org.glassfish.jersey.model.internal.RankedProvider;
import org.glassfish.jersey.process.internal.Stage;
import org.glassfish.jersey.process.internal.Stages;
import org.glassfish.jersey.server.internal.ConfigHelper;
import org.glassfish.jersey.server.internal.JerseyRequestTimeoutHandler;
import org.glassfish.jersey.server.internal.JerseyResourceContext;
import org.glassfish.jersey.server.internal.LocalizationMessages;
import org.glassfish.jersey.server.internal.ProcessingProviders;
import org.glassfish.jersey.server.internal.monitoring.ApplicationEventImpl;
import org.glassfish.jersey.server.internal.monitoring.CompositeApplicationEventListener;
import org.glassfish.jersey.server.internal.monitoring.MonitoringContainerListener;
import org.glassfish.jersey.server.internal.routing.RoutedInflectorExtractorStage;
import org.glassfish.jersey.server.internal.routing.Router;
import org.glassfish.jersey.server.internal.routing.RoutingStage;
import org.glassfish.jersey.server.internal.routing.RuntimeModelBuilder;
import org.glassfish.jersey.server.model.ComponentModelValidator;
import org.glassfish.jersey.server.model.ModelProcessor;
import org.glassfish.jersey.server.model.ModelValidationException;
import org.glassfish.jersey.server.model.Resource;
import org.glassfish.jersey.server.model.ResourceModel;
import org.glassfish.jersey.server.model.internal.ModelErrors;
import org.glassfish.jersey.server.monitoring.ApplicationEvent;
import org.glassfish.jersey.server.monitoring.ApplicationEventListener;
import org.glassfish.jersey.server.spi.ComponentProvider;
import org.glassfish.jersey.server.spi.ContainerResponseWriter;

import org.glassfish.hk2.api.DynamicConfiguration;
import org.glassfish.hk2.api.Factory;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.hk2.utilities.Binder;
import org.glassfish.hk2.utilities.binding.AbstractBinder;

import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.google.common.util.concurrent.AbstractFuture;

/**
 * Jersey server-side application handler.
 * 

* Container implementations use the {@code ApplicationHandler} API to process requests * by invoking the {@link #handle(ContainerRequest) handle(requestContext)} * method on a configured application handler instance. *

*

* {@code ApplicationHandler} provides two implementations of {@link javax.ws.rs.core.Configuration config} that can be injected * into the application classes. The first is {@link ResourceConfig resource config} which implements {@code Configuration} itself * and is configured by the user. The resource config is not modified by this application handler so the future reloads of the * application is not disrupted by providers found on a classpath. This config can * be injected only as {@code ResourceConfig} or {@code Application}. The second one can be injected into the * {@code Configuration} parameters / fields and contains info about all the properties / provider classes / provider instances * from the resource config and also about all the providers found during processing classes registered under * {@link ServerProperties server properties}. After the application handler is initialized both configurations are marked as * read-only. *

* * @author Pavel Bucek (pavel.bucek at oracle.com) * @author Jakub Podlesak (jakub.podlesak at oracle.com) * @author Marek Potociar (marek.potociar at oracle.com) * @author Libor Kramolis (libor.kramolis at oracle.com) * @see ResourceConfig * @see javax.ws.rs.core.Configuration * @see org.glassfish.jersey.server.spi.ContainerProvider */ public final class ApplicationHandler { private static final Logger LOGGER = Logger.getLogger(ApplicationHandler.class.getName()); /** * Default dummy security context. */ private static final SecurityContext DEFAULT_SECURITY_CONTEXT = new SecurityContext() { @Override public boolean isUserInRole(String role) { return false; } @Override public boolean isSecure() { return false; } @Override public Principal getUserPrincipal() { return null; } @Override public String getAuthenticationScheme() { return null; } }; private class ApplicationBinder extends AbstractBinder { private class JaxrsApplicationProvider implements Factory { @Override public Application provide() { return ApplicationHandler.this.application; } @Override public void dispose(Application instance) { //not used } } private class RuntimeConfigProvider implements Factory { @Override public ServerConfig provide() { return ApplicationHandler.this.runtimeConfig; } @Override public void dispose(ServerConfig instance) { //not used } } @Override protected void configure() { bindFactory(new RuntimeConfigProvider()).to(ServerConfig.class).to(Configuration.class).in(Singleton.class); bindFactory(new JaxrsApplicationProvider()).to(Application.class).in(Singleton.class); bind(ApplicationHandler.this).to(ApplicationHandler.class); } } private final Application application; private final ResourceConfig runtimeConfig; private final ServiceLocator locator; private ServerRuntime runtime; /** * Create a new Jersey application handler using a default configuration. */ public ApplicationHandler() { this(new Application()); } /** * Create a new Jersey server-side application handler configured by a * {@link Application JAX-RS Application (sub-)class}. * * @param jaxrsApplicationClass JAX-RS {@code Application} (sub-)class that will be * instantiated and used to configure the new Jersey * application handler. */ public ApplicationHandler(Class jaxrsApplicationClass) { this.locator = Injections.createLocator(new ServerBinder(null), new ApplicationBinder()); locator.setDefaultClassAnalyzerName(JerseyClassAnalyzer.NAME); this.application = createApplication(jaxrsApplicationClass); this.runtimeConfig = ResourceConfig.createRuntimeConfig(application); Errors.processWithException(new Runnable() { @Override public void run() { initialize(); } }); } /** * Create a new Jersey server-side application handler configured by an instance * of a {@link Application JAX-RS Application sub-class}. * * @param application an instance of a JAX-RS {@code Application} (sub-)class that * will be used to configure the new Jersey application handler. */ public ApplicationHandler(Application application) { this(application, null); } /** * Create a new Jersey server-side application handler configured by an instance * of a {@link ResourceConfig} and a custom {@link Binder}. * * @param application an instance of a JAX-RS {@code Application} (sub-)class that * will be used to configure the new Jersey application handler. * @param customBinder additional custom bindings used during {@link ServiceLocator} creation */ public ApplicationHandler(Application application, Binder customBinder) { if (customBinder == null) { this.locator = Injections.createLocator(new ServerBinder(application.getProperties()), new ApplicationBinder()); } else { this.locator = Injections.createLocator(new ServerBinder(application.getProperties()), new ApplicationBinder(), customBinder); } locator.setDefaultClassAnalyzerName(JerseyClassAnalyzer.NAME); this.application = application; if (application instanceof ResourceConfig) { final ResourceConfig rc = (ResourceConfig) application; if (rc.getApplicationClass() != null) { rc.setApplication(createApplication(rc.getApplicationClass())); } } this.runtimeConfig = ResourceConfig.createRuntimeConfig(application); Errors.processWithException(new Runnable() { @Override public void run() { initialize(); } }); } private Application createApplication(Class applicationClass) { // need to handle ResourceConfig and Application separately as invoking forContract() on these // will trigger the factories which we don't want at this point if (applicationClass == ResourceConfig.class) { return new ResourceConfig(); } else if (applicationClass == Application.class) { return new Application(); } else { Application app = locator.createAndInitialize(applicationClass); if (app instanceof ResourceConfig) { final ResourceConfig _rc = (ResourceConfig) app; final Class innerAppClass = _rc.getApplicationClass(); if (innerAppClass != null) { final Application innerApp = createApplication(innerAppClass); _rc.setApplication(innerApp); } } return app; } } /** * Assumes the configuration field is initialized with a valid ResourceConfig. */ private void initialize() { LOGGER.info(LocalizationMessages.INIT_MSG(Version.getBuildId())); // Lock original ResourceConfig. if (application instanceof ResourceConfig) { ((ResourceConfig) application).lock(); } final boolean ignoreValidationErrors = PropertiesHelper.getValue(runtimeConfig.getProperties(), ServerProperties.RESOURCE_VALIDATION_IGNORE_ERRORS, Boolean.FALSE, Boolean.class); final boolean disableValidation = PropertiesHelper.getValue(runtimeConfig.getProperties(), ServerProperties.RESOURCE_VALIDATION_DISABLE, Boolean.FALSE, Boolean.class); final ResourceBag resourceBag; final ProcessingProviders processingProviders; final List componentProviders; final ComponentBag componentBag; ResourceModel resourceModel; CompositeApplicationEventListener compositeListener = null; Errors.mark(); // mark begin of validation phase try { // AutoDiscoverable. if (!PropertiesHelper.getValue(runtimeConfig.getProperties(), RuntimeType.SERVER, CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE, Boolean.FALSE, Boolean.class)) { runtimeConfig.configureAutoDiscoverableProviders(locator); } // Configure binders and features. runtimeConfig.configureMetaProviders(locator); final ResourceBag.Builder resourceBagBuilder = new ResourceBag.Builder(); // Adding programmatic resource models for (Resource programmaticResource : runtimeConfig.getResources()) { resourceBagBuilder.registerProgrammaticResource(programmaticResource); } // Introspecting classes & instances for (Class c : runtimeConfig.getClasses()) { try { Resource resource = Resource.from(c, disableValidation); if (resource != null) { resourceBagBuilder.registerResource(c, resource); } } catch (IllegalArgumentException ex) { LOGGER.warning(ex.getMessage()); } } for (Object o : runtimeConfig.getSingletons()) { try { Resource resource = Resource.from(o.getClass(), disableValidation); if (resource != null) { resourceBagBuilder.registerResource(o, resource); } } catch (IllegalArgumentException ex) { LOGGER.warning(ex.getMessage()); } } resourceBag = resourceBagBuilder.build(); runtimeConfig.lock(); // Registering Injection Bindings componentProviders = new LinkedList(); // Registering Injection Bindings for (RankedProvider rankedProvider : getRankedComponentProviders()) { final ComponentProvider provider = rankedProvider.getProvider(); provider.initialize(locator); componentProviders.add(provider); } componentBag = runtimeConfig.getComponentBag(); bindProvidersAndResources(componentProviders, componentBag, resourceBag.classes, resourceBag.instances); for (ComponentProvider componentProvider : componentProviders) { componentProvider.done(); } final List appEventListeners = locator.getAllServices(ApplicationEventListener.class); if (!appEventListeners.isEmpty()) { compositeListener = new CompositeApplicationEventListener( appEventListeners); compositeListener.onEvent(new ApplicationEventImpl(ApplicationEvent.Type.INITIALIZATION_START, this.runtimeConfig, componentBag.getRegistrations(), resourceBag.classes, resourceBag.instances, null)); } processingProviders = getProcessingProviders(componentBag); // initialize processing provider reference final GenericType> refGenericType = new GenericType>() { }; final Ref refProcessingProvider = locator.getService(refGenericType.getType()); refProcessingProvider.set(processingProviders); resourceModel = new ResourceModel.Builder(resourceBag.getRootResources(), false).build(); resourceModel = processResourceModel(resourceModel); if (!disableValidation) { final ComponentModelValidator validator = new ComponentModelValidator(locator); validator.validate(resourceModel); } if (Errors.fatalIssuesFound() && !ignoreValidationErrors) { throw new ModelValidationException(LocalizationMessages.RESOURCE_MODEL_VALIDATION_FAILED_AT_INIT(), ModelErrors.getErrorsAsResourceModelIssues(true)); } } finally { if (ignoreValidationErrors) { Errors.logErrors(true); Errors.reset(); // reset errors to the state before validation phase } else { Errors.unmark(); } } bindEnhancingResourceClasses(resourceModel, resourceBag, componentProviders); // initiate resource model into JerseyResourceContext JerseyResourceContext jerseyResourceContext = locator.getService(JerseyResourceContext.class); jerseyResourceContext.setResourceModel(resourceModel); final RuntimeModelBuilder runtimeModelBuilder = locator.getService(RuntimeModelBuilder.class); runtimeModelBuilder.setProcessingProviders(processingProviders); // assembly request processing chain /** * Root hierarchical request matching acceptor. * Invoked in a single linear stage as part of the main linear accepting chain. */ final Router resourceRoutingRoot = runtimeModelBuilder.buildModel(resourceModel.getRuntimeResourceModel(), false); final ContainerFilteringStage preMatchRequestFilteringStage = locator.createAndInitialize(ContainerFilteringStage.Builder.class).build(processingProviders.getPreMatchFilters(), processingProviders.getGlobalResponseFilters()); final RoutingStage routingStage = locator.createAndInitialize(RoutingStage.Builder.class).build(resourceRoutingRoot); final ContainerFilteringStage resourceFilteringStage = locator.createAndInitialize(ContainerFilteringStage.Builder.class) .build(processingProviders.getGlobalRequestFilters(), null); final RoutedInflectorExtractorStage routedInflectorExtractorStage = locator.createAndInitialize(RoutedInflectorExtractorStage.class); /** * Root linear request acceptor. This is the main entry point for the whole request processing. */ final Stage rootStage = Stages .chain(locator.createAndInitialize(ReferencesInitializer.class)) .to(locator.createAndInitialize(ContainerMessageBodyWorkersInitializer.class)) .to(preMatchRequestFilteringStage) .to(routingStage) .to(resourceFilteringStage) .build(routedInflectorExtractorStage); // Inject instances. for (Object instance : componentBag.getInstances(ComponentBag.EXCLUDE_META_PROVIDERS)) { locator.inject(instance); } for (Object instance : resourceBag.instances) { locator.inject(instance); } this.runtime = locator.createAndInitialize(ServerRuntime.Builder.class).build(rootStage, compositeListener); // inject self locator.inject(this); if (LOGGER.isLoggable(Level.CONFIG)) { final StringBuilder sb = new StringBuilder(LocalizationMessages.LOGGING_APPLICATION_INITIALIZED()).append('\n'); final List rootResourceClasses = resourceBag.getRootResources(); if (!rootResourceClasses.isEmpty()) { sb.append(LocalizationMessages.LOGGING_ROOT_RESOURCE_CLASSES()).append(":"); for (Resource r : rootResourceClasses) { for (Class clazz : r.getHandlerClasses()) { sb.append('\n').append(" ").append(clazz.getName()); } } } sb.append('\n'); Set messageBodyReaders; Set messageBodyWriters; if (LOGGER.isLoggable(Level.FINE)) { messageBodyReaders = Sets.newHashSet(Providers.getAllProviders(locator, MessageBodyReader.class)); messageBodyWriters = Sets.newHashSet(Providers.getAllProviders(locator, MessageBodyWriter.class)); } else { messageBodyReaders = Providers.getCustomProviders(locator, MessageBodyReader.class); messageBodyWriters = Providers.getCustomProviders(locator, MessageBodyWriter.class); } printProviders(LocalizationMessages.LOGGING_PRE_MATCH_FILTERS(), processingProviders.getPreMatchFilters(), sb); printProviders(LocalizationMessages.LOGGING_GLOBAL_REQUEST_FILTERS(), processingProviders.getGlobalRequestFilters(), sb); printProviders(LocalizationMessages.LOGGING_GLOBAL_RESPOSE_FILTERS(), processingProviders.getGlobalResponseFilters(), sb); printProviders(LocalizationMessages.LOGGING_GLOBAL_READER_INTERCEPTORS(), processingProviders.getGlobalReaderInterceptors(), sb); printProviders(LocalizationMessages.LOGGING_GLOBAL_WRITER_INTERCEPTORS(), processingProviders.getGlobalWriterInterceptors(), sb); printNameBoundProviders(LocalizationMessages.LOGGING_NAME_BOUND_REQUEST_FILTERS(), processingProviders.getNameBoundRequestFilters(), sb); printNameBoundProviders(LocalizationMessages.LOGGING_NAME_BOUND_RESPOSE_FILTERS(), processingProviders.getNameBoundResponseFilters(), sb); printNameBoundProviders(LocalizationMessages.LOGGING_NAME_BOUND_READER_INTERCEPTORS(), processingProviders.getNameBoundReaderInterceptors(), sb); printNameBoundProviders(LocalizationMessages.LOGGING_NAME_BOUND_WRITER_INTERCEPTORS(), processingProviders.getNameBoundWriterInterceptors(), sb); printProviders(LocalizationMessages.LOGGING_DYNAMIC_FEATURES(), processingProviders.getDynamicFeatures(), sb); printProviders(LocalizationMessages.LOGGING_MESSAGE_BODY_READERS(), Collections2.transform(messageBodyReaders, new WorkersToStringTransform()), sb); printProviders(LocalizationMessages.LOGGING_MESSAGE_BODY_WRITERS(), Collections2.transform(messageBodyWriters, new WorkersToStringTransform()), sb); LOGGER.log(Level.CONFIG, sb.toString()); } if (compositeListener != null) { final ApplicationEvent initFinishedEvent = new ApplicationEventImpl( ApplicationEvent.Type.INITIALIZATION_APP_FINISHED, runtimeConfig, componentBag.getRegistrations(), resourceBag.classes, resourceBag.instances, resourceModel); compositeListener.onEvent(initFinishedEvent); final MonitoringContainerListener containerListener = locator.getService(MonitoringContainerListener.class); containerListener.init(compositeListener, initFinishedEvent); } } private class WorkersToStringTransform implements Function { @Override public String apply(T t) { if (t != null) { return t.getClass().getName(); } return null; } } private void printNameBoundProviders(String title, Map, List>> providers, StringBuilder sb) { if (!providers.isEmpty()) { sb.append(title).append(":").append('\n'); for (Map.Entry, List>> entry : providers.entrySet()) { for (RankedProvider rankedProvider : entry.getValue()) { sb.append(" ").append(LocalizationMessages.LOGGING_PROVIDER_BOUND(rankedProvider, entry.getKey())).append('\n'); } } } } private void printProviders(String title, Iterable providers, StringBuilder sb) { final Iterator iterator = providers.iterator(); boolean first = true; while (iterator.hasNext()) { if (first) { sb.append(title).append(":").append('\n'); first = false; } final T provider = iterator.next(); sb.append(" ").append(provider).append('\n'); } } private Iterable> getRankedComponentProviders() throws ServiceConfigurationError { final List> result = new LinkedList>(); final boolean enableMetainfServicesLookup = !PropertiesHelper.getValue(application.getProperties(), RuntimeType.SERVER, CommonProperties.METAINF_SERVICES_LOOKUP_DISABLE, false, Boolean.class); if (enableMetainfServicesLookup) { for (ComponentProvider provider : ServiceFinder.find(ComponentProvider.class)) { result.add(new RankedProvider(provider)); } Collections.sort(result, new RankedComparator(Order.DESCENDING)); } return result; } private ProcessingProviders getProcessingProviders(ComponentBag componentBag) { // scan for NameBinding annotations attached to the application class Collection> applicationNameBindings = ReflectionHelper.getAnnotationTypes(ConfigHelper.getWrappedApplication(runtimeConfig).getClass(), NameBinding.class); // find all filters, interceptors and dynamic features final Iterable> responseFilters = Providers.getAllRankedProviders(locator, ContainerResponseFilter.class); MultivaluedMap, Class> nameBoundResponseFiltersInverse = new MultivaluedHashMap, Class>(); MultivaluedMap, Class> nameBoundRequestFiltersInverse = new MultivaluedHashMap, Class>(); MultivaluedMap, Class> nameBoundReaderInterceptorsInverse = new MultivaluedHashMap, Class>(); MultivaluedMap, Class> nameBoundWriterInterceptorsInverse = new MultivaluedHashMap, Class>(); final MultivaluedMap, RankedProvider> nameBoundResponseFilters = filterNameBound(responseFilters, null, componentBag, applicationNameBindings, nameBoundResponseFiltersInverse); final Iterable> requestFilters = Providers.getAllRankedProviders(locator, ContainerRequestFilter.class); final List> preMatchFilters = Lists.newArrayList(); final MultivaluedMap, RankedProvider> nameBoundRequestFilters = filterNameBound(requestFilters, preMatchFilters, componentBag, applicationNameBindings, nameBoundRequestFiltersInverse); final Iterable> readerInterceptors = Providers.getAllRankedProviders(locator, ReaderInterceptor.class); final MultivaluedMap, RankedProvider> nameBoundReaderInterceptors = filterNameBound(readerInterceptors, null, componentBag, applicationNameBindings, nameBoundReaderInterceptorsInverse); final Iterable> writerInterceptors = Providers.getAllRankedProviders(locator, WriterInterceptor.class); final MultivaluedMap, RankedProvider> nameBoundWriterInterceptors = filterNameBound(writerInterceptors, null, componentBag, applicationNameBindings, nameBoundWriterInterceptorsInverse); final Iterable dynamicFeatures = Providers.getAllProviders(locator, DynamicFeature.class); return new ProcessingProviders(nameBoundRequestFilters, nameBoundRequestFiltersInverse, nameBoundResponseFilters, nameBoundResponseFiltersInverse, nameBoundReaderInterceptors, nameBoundReaderInterceptorsInverse, nameBoundWriterInterceptors, nameBoundWriterInterceptorsInverse, requestFilters, preMatchFilters, responseFilters, readerInterceptors, writerInterceptors, dynamicFeatures); } private ResourceModel processResourceModel(ResourceModel resourceModel) { final Iterable> allRankedProviders = Providers.getAllRankedProviders(locator, ModelProcessor.class); final Iterable modelProcessors = Providers.sortRankedProviders(new RankedComparator(), allRankedProviders); for (ModelProcessor modelProcessor : modelProcessors) { resourceModel = modelProcessor.processResourceModel(resourceModel, getConfiguration()); } return resourceModel; } private void bindEnhancingResourceClasses( ResourceModel resourceModel, ResourceBag resourceBag, Iterable componentProviders) { Set> newClasses = Sets.newHashSet(); Set newInstances = Sets.newHashSet(); for (Resource res : resourceModel.getRootResources()) { newClasses.addAll(res.getHandlerClasses()); newInstances.addAll(res.getHandlerInstances()); } newClasses.removeAll(resourceBag.classes); newInstances.removeAll(resourceBag.instances); ComponentBag emptyComponentBag = ComponentBag.newInstance(new Predicate() { @Override public boolean apply(ContractProvider input) { return false; } }); bindProvidersAndResources(componentProviders, emptyComponentBag, newClasses, newInstances); } /** * Takes collection of all filters/interceptors (either request/reader or response/writer) * and separates out all name-bound filters/interceptors, returns them as a separate MultivaluedMap, * mapping the name-bound annotation to the list of name-bound filters/interceptors. The same key values * are also added into the inverse map passed in {@code inverseNameBoundMap}. *

* Note, the name-bound filters/interceptors are removed from the original filters/interceptors collection. * If non-null collection is passed in the postMatching parameter (applicable for filters only), * this method also removes all the global * postMatching filters from the original collection and adds them to the collection passed in the postMatching * parameter. * * @param all Collection of all filters to be processed. * @param preMatching Collection into which pre-matching filters should be added. * @param componentBag Component bag * @param applicationNameBindings Collection of name binding annotations attached to the JAX-RS application. * @param inverseNameBoundMap Inverse name bound map into which the name bound providers should be inserted. The keys * are providers (filters, interceptor) * @return {@link MultivaluedMap} of all name-bound filters. */ private static MultivaluedMap, RankedProvider> filterNameBound( final Iterable> all, final Collection> preMatching, final ComponentBag componentBag, final Collection> applicationNameBindings, final MultivaluedMap, Class> inverseNameBoundMap) { final MultivaluedMap, RankedProvider> result = new MultivaluedHashMap, RankedProvider>(); for (Iterator> it = all.iterator(); it.hasNext(); ) { RankedProvider provider = it.next(); final Class providerClass = provider.getProvider().getClass(); ContractProvider model = componentBag.getModel(providerClass); if (model == null) { // the provider was (most likely) bound in HK2 externally model = ComponentBag.modelFor(providerClass); } if (preMatching != null && providerClass.getAnnotation(PreMatching.class) != null) { it.remove(); preMatching.add(new RankedProvider((ContainerRequestFilter) provider.getProvider(), model.getPriority(ContainerRequestFilter.class))); } boolean nameBound = model.isNameBound(); if (nameBound && !applicationNameBindings.isEmpty() && applicationNameBindings.containsAll(model.getNameBindings())) { // override the name-bound flag nameBound = false; } if (nameBound) { // not application-bound it.remove(); for (Class binding : model.getNameBindings()) { result.add(binding, provider); inverseNameBoundMap.add(provider, binding); } } } return result; } private void bindProvidersAndResources( final Iterable componentProviders, final ComponentBag componentBag, final Collection> resourceClasses, final Collection resourceInstances) { final JerseyResourceContext resourceContext = locator.getService(JerseyResourceContext.class); final DynamicConfiguration dc = Injections.getConfiguration(locator); final Set> registeredClasses = runtimeConfig.getRegisteredClasses(); // Merge programmatic resource classes with component classes. Set> classes = Sets.newIdentityHashSet(); classes.addAll(Sets.filter(componentBag.getClasses(ComponentBag.EXCLUDE_META_PROVIDERS), new Predicate>() { @Override public boolean apply(Class componentClass) { return Providers.checkProviderRuntime( componentClass, componentBag.getModel(componentClass), RuntimeType.SERVER, !registeredClasses.contains(componentClass), resourceClasses.contains(componentClass)); } })); classes.addAll(resourceClasses); // Bind classes. for (Class componentClass : classes) { ContractProvider model = componentBag.getModel(componentClass); if (bindWithComponentProvider(componentClass, model, componentProviders)) { continue; } if (resourceClasses.contains(componentClass)) { if (!Resource.isAcceptable(componentClass)) { LOGGER.warning(LocalizationMessages.NON_INSTANTIABLE_COMPONENT(componentClass)); continue; } if (model != null && !Providers.checkProviderRuntime( componentClass, model, RuntimeType.SERVER, !registeredClasses.contains(componentClass), true)) { model = null; } resourceContext.unsafeBindResource(componentClass, model, dc); } else { ProviderBinder.bindProvider(componentClass, model, dc); } } // Merge programmatic resource instances with other component instances. Set instances = Sets.newHashSet(); instances.addAll(Sets.filter(componentBag.getInstances(ComponentBag.EXCLUDE_META_PROVIDERS), new Predicate() { @Override public boolean apply(Object component) { final Class componentClass = component.getClass(); return Providers.checkProviderRuntime( componentClass, componentBag.getModel(componentClass), RuntimeType.SERVER, !registeredClasses.contains(componentClass), resourceInstances.contains(component)); } })); instances.addAll(resourceInstances); // Bind instances. for (Object component : instances) { ContractProvider model = componentBag.getModel(component.getClass()); if (resourceInstances.contains(component)) { if (model != null && !Providers.checkProviderRuntime( component.getClass(), model, RuntimeType.SERVER, !registeredClasses.contains(component.getClass()), true)) { model = null; } resourceContext.unsafeBindResource(component, model, dc); } else { ProviderBinder.bindProvider(component, model, dc); } } dc.commit(); } private boolean bindWithComponentProvider( final Class component, final ContractProvider providerModel, final Iterable componentProviders) { final Set> contracts = providerModel == null ? Collections.>emptySet() : providerModel.getContracts(); for (ComponentProvider provider : componentProviders) { if (provider.bind(component, contracts)) { return true; } } return false; } /** * Registers HK2 binders into the HK2 service register. * * @param binders binders to be registered. */ public void registerAdditionalBinders(final Iterable binders) { final DynamicConfiguration dc = Injections.getConfiguration(locator); for (Binder binder : binders) { binder.bind(dc); } dc.commit(); } /** * Invokes a request and returns the {@link Future response future}. * * @param requestContext request data. * @return response future. */ public Future apply(final ContainerRequest requestContext) { return apply(requestContext, new NullOutputStream()); } /** * Invokes a request and returns the {@link Future response future}. * * @param request request data. * @param outputStream response output stream. * @return response future. */ public Future apply(final ContainerRequest request, final OutputStream outputStream) { final FutureResponseWriter responseFuture = new FutureResponseWriter(request.getMethod(), outputStream, runtime.getBackgroundScheduler()); request.setSecurityContext(DEFAULT_SECURITY_CONTEXT); request.setWriter(responseFuture); handle(request); return responseFuture; } private static class FutureResponseWriter extends AbstractFuture implements ContainerResponseWriter { private ContainerResponse response = null; private final String requestMethodName; private final OutputStream outputStream; private final JerseyRequestTimeoutHandler requestTimeoutHandler; private FutureResponseWriter(String requestMethodName, OutputStream outputStream, ScheduledExecutorService backgroundScheduler) { this.requestMethodName = requestMethodName; this.outputStream = outputStream; this.requestTimeoutHandler = new JerseyRequestTimeoutHandler(this, backgroundScheduler); } @Override public OutputStream writeResponseStatusAndHeaders(long contentLength, ContainerResponse response) { this.response = response; if (contentLength >= 0) { response.getHeaders().putSingle(HttpHeaders.CONTENT_LENGTH, Long.toString(contentLength)); } return outputStream; } @Override public boolean suspend(long time, TimeUnit unit, final TimeoutHandler handler) { return requestTimeoutHandler.suspend(time, unit, handler); } @Override public void setSuspendTimeout(long time, TimeUnit unit) { requestTimeoutHandler.setSuspendTimeout(time, unit); } @Override public void commit() { final ContainerResponse current = response; if (current != null) { if (HttpMethod.HEAD.equals(requestMethodName) && current.hasEntity()) { // for testing purposes: // need to also strip the object entity as it was stripped when writing to output current.setEntity(null); } super.set(current); } } @Override public void failure(Throwable error) { super.setException(error); } @Override public boolean enableResponseBuffering() { return true; } @Override protected void interruptTask() { // TODO implement cancellation logic. } } /** * The main request/response processing entry point for Jersey container implementations. *

* The method invokes the request processing of the provided * {@link ContainerRequest container request context} and uses the * {@link ContainerResponseWriter container response writer} to suspend & resume the processing * as well as write the response back to the container. *

*

* The the {@link SecurityContext security context} stored in the container request context * is bound as an injectable instance in the scope of the processed request context. * Also, any {@link org.glassfish.jersey.server.spi.RequestScopedInitializer custom scope injections} * are initialized in the current request scope. *

* * @param requestContext container request context of the current request. */ public void handle(final ContainerRequest requestContext) { runtime.process(requestContext); } /** * Returns {@link ServiceLocator} relevant to current application. * * @return {@link ServiceLocator} instance. */ public ServiceLocator getServiceLocator() { return locator; } /** * Get the application configuration. * * @return application configuration. */ public ResourceConfig getConfiguration() { return runtimeConfig; } }