org.glassfish.jersey.server.internal.routing.Routing Maven / Gradle / Ivy
/*
* Copyright (c) 2015, 2019 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.server.internal.routing;
import java.util.Collection;
import java.util.function.Function;
import javax.ws.rs.core.Configuration;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.process.internal.ChainableStage;
import org.glassfish.jersey.process.internal.Stage;
import org.glassfish.jersey.server.internal.JerseyResourceContext;
import org.glassfish.jersey.server.internal.ProcessingProviders;
import org.glassfish.jersey.server.internal.process.RequestProcessingContext;
import org.glassfish.jersey.server.model.ModelProcessor;
import org.glassfish.jersey.server.model.ResourceMethodInvoker;
import org.glassfish.jersey.server.model.RuntimeResourceModel;
import org.glassfish.jersey.server.spi.internal.ValueParamProvider;
/**
* Jersey routing entry point.
*
* @author Marek Potociar
*/
public final class Routing {
private Routing() {
throw new AssertionError("No instances allowed.");
}
/**
* Create a new request pre-processing stage that extracts a matched endpoint from a routing context,
* where it was previously stored by the request routing stage and
* (if available) returns the endpoint wrapped in a next terminal stage.
*
* This request pre-processing stage should be a final stage in the request processing chain.
*
* @return new matched endpoint extractor request pre-processing stage.
*/
public static Stage matchedEndpointExtractor() {
return new MatchedEndpointExtractorStage();
}
/**
* Create a routing stage builder for a given runtime resource model.
*
* @param resourceModel runtime resource model
* @return new routing stage builder.
*/
public static Builder forModel(RuntimeResourceModel resourceModel) {
return new Builder(resourceModel);
}
/**
* Resource routing builder.
*/
public static final class Builder {
private final RuntimeResourceModel resourceModel;
private JerseyResourceContext resourceContext;
private Configuration config;
private MessageBodyWorkers entityProviders;
private Collection valueSuppliers;
private Iterable modelProcessors;
private Function, ?> createServiceFunction;
private ProcessingProviders processingProviders;
private ResourceMethodInvoker.Builder resourceMethodInvokerBuilder;
private Builder(RuntimeResourceModel resourceModel) {
if (resourceModel == null) {
// No L10N - internally used class
throw new NullPointerException("Resource model must not be null.");
}
this.resourceModel = resourceModel;
}
/**
* Set resource context.
*
* @param resourceContext resource context.
* @return updated routing builder.
*/
public Builder resourceContext(JerseyResourceContext resourceContext) {
this.resourceContext = resourceContext;
return this;
}
/**
* Set runtime configuration.
*
* @param config runtime configuration.
* @return updated routing builder.
*/
public Builder configuration(Configuration config) {
this.config = config;
return this;
}
/**
* Set entity providers.
*
* @param workers entity providers.
* @return updated routing builder.
*/
public Builder entityProviders(MessageBodyWorkers workers) {
this.entityProviders = workers;
return this;
}
/**
* Set value suppliers.
*
* @param valueSuppliers all registered value suppliers.
* @return updated routing builder.
*/
public Builder valueSupplierProviders(Collection valueSuppliers) {
this.valueSuppliers = valueSuppliers;
return this;
}
/**
* Set request/response processing providers.
*
* @param processingProviders request/response processing providers.
* @return updated routing builder.
*/
public Builder processingProviders(ProcessingProviders processingProviders) {
this.processingProviders = processingProviders;
return this;
}
/**
* Set model processors.
*
* @param modelProcessors all registered model processors.
* @return updated routing builder.
*/
public Builder modelProcessors(Iterable modelProcessors) {
this.modelProcessors = modelProcessors;
return this;
}
/**
* Set model processors.
*
* @param createServiceFunction all registered model processors.
* @return updated routing builder.
*/
public Builder createService(Function, ?> createServiceFunction) {
this.createServiceFunction = createServiceFunction;
return this;
}
/**
* Set builder of ResourceMethodInvoker.
*
* @param resourceMethodInvokerBuilder resource method invoker builder.
* @return updated routing builder.
*/
public Builder resourceMethodInvokerBuilder(ResourceMethodInvoker.Builder resourceMethodInvokerBuilder) {
this.resourceMethodInvokerBuilder = resourceMethodInvokerBuilder;
return this;
}
/**
* Build routing stage.
*
* @return routing stage for the runtime resource model.
*/
public ChainableStage buildStage() {
// No L10N - internally used class
if (resourceContext == null) {
throw new NullPointerException("Resource context is not set.");
}
if (config == null) {
throw new NullPointerException("Runtime configuration is not set.");
}
if (entityProviders == null) {
throw new NullPointerException("Entity providers are not set.");
}
if (valueSuppliers == null) {
throw new NullPointerException("Value supplier providers are not set.");
}
if (modelProcessors == null) {
throw new NullPointerException("Model processors are not set.");
}
if (createServiceFunction == null) {
throw new NullPointerException("Create function is not set.");
}
if (processingProviders == null) {
throw new NullPointerException("Processing providers are not set.");
}
if (resourceMethodInvokerBuilder == null) {
throw new NullPointerException("ResourceMethodInvokerBuilder is not set.");
}
final RuntimeModelBuilder runtimeModelBuilder = new RuntimeModelBuilder(
resourceContext,
config,
entityProviders,
valueSuppliers,
processingProviders,
resourceMethodInvokerBuilder,
modelProcessors,
createServiceFunction);
return new RoutingStage(runtimeModelBuilder.buildModel(resourceModel, false));
}
}
}