org.glassfish.jersey.server.ContainerFilteringStage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Show all versions of jersey-server Show documentation
Jersey core server implementation
/*
* Copyright (c) 2012, 2020 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;
import java.util.ArrayList;
import jakarta.ws.rs.container.ContainerRequestFilter;
import jakarta.ws.rs.container.ContainerResponseFilter;
import jakarta.ws.rs.core.Response;
import org.glassfish.jersey.internal.inject.Providers;
import org.glassfish.jersey.message.internal.TracingLogger;
import org.glassfish.jersey.model.internal.RankedComparator;
import org.glassfish.jersey.model.internal.RankedProvider;
import org.glassfish.jersey.process.internal.AbstractChainableStage;
import org.glassfish.jersey.process.internal.Stages;
import org.glassfish.jersey.server.internal.ServerTraceEvent;
import org.glassfish.jersey.server.internal.process.Endpoint;
import org.glassfish.jersey.server.internal.process.MappableException;
import org.glassfish.jersey.server.internal.process.RequestProcessingContext;
import org.glassfish.jersey.server.monitoring.RequestEvent;
/**
* Container filtering stage responsible for execution of request and response filters
* on each request-response message exchange.
*
* @author Marek Potociar
* @author Martin Matula
*/
class ContainerFilteringStage extends AbstractChainableStage {
private final Iterable> requestFilters;
private final Iterable> responseFilters;
/**
* Create a new container filtering stage specifying global request and response filters. This stage class
* is reused for both pre and post match filtering phases.
*
* All global response filters are passed in the pre-match stage, since if a pre-match filter aborts,
* response filters should still be executed. For the post-match filter stage creation, {@code null} is passed
* to the responseFilters parameter.
*
*
* @param requestFilters list of global (unbound) request filters (either pre or post match - depending on the
* stage being created).
* @param responseFilters list of global response filters (for pre-match stage) or {@code null} (for post-match
* stage).
*/
ContainerFilteringStage(
Iterable> requestFilters,
Iterable> responseFilters) {
this.requestFilters = requestFilters;
this.responseFilters = responseFilters;
}
@Override
@SuppressWarnings("unchecked")
public Continuation apply(RequestProcessingContext context) {
Iterable sortedRequestFilters;
final boolean postMatching = responseFilters == null;
final ContainerRequest request = context.request();
final TracingLogger tracingLogger = TracingLogger.getInstance(request);
if (postMatching) {
// post-matching
final ArrayList>> rankedProviders =
new ArrayList<>(2);
rankedProviders.add(requestFilters);
rankedProviders.add(request.getRequestFilters());
sortedRequestFilters = Providers.mergeAndSortRankedProviders(
new RankedComparator(), rankedProviders);
context.monitoringEventBuilder().setContainerRequestFilters(sortedRequestFilters);
context.triggerEvent(RequestEvent.Type.REQUEST_MATCHED);
} else {
// pre-matching (response filter stage is pushed in pre-matching phase, so that if pre-matching filter
// throws exception, response filters get still invoked)
context.push(new ResponseFilterStage(context, responseFilters, tracingLogger));
sortedRequestFilters = Providers.sortRankedProviders(new RankedComparator(), requestFilters);
}
final TracingLogger.Event summaryEvent =
(postMatching ? ServerTraceEvent.REQUEST_FILTER_SUMMARY : ServerTraceEvent.PRE_MATCH_SUMMARY);
final long timestamp = tracingLogger.timestamp(summaryEvent);
int processedCount = 0;
try {
final TracingLogger.Event filterEvent = (postMatching ? ServerTraceEvent.REQUEST_FILTER : ServerTraceEvent.PRE_MATCH);
for (ContainerRequestFilter filter : sortedRequestFilters) {
final long filterTimestamp = tracingLogger.timestamp(filterEvent);
try {
filter.filter(request);
} catch (Exception exception) {
throw new MappableException(exception);
} finally {
processedCount++;
tracingLogger.logDuration(filterEvent, filterTimestamp, filter);
}
final Response abortResponse = request.getAbortResponse();
if (abortResponse != null) {
// abort accepting & return response
return Continuation.of(context, Stages.asStage(
new Endpoint() {
@Override
public ContainerResponse apply(
final RequestProcessingContext requestContext) {
return new ContainerResponse(requestContext.request(), abortResponse);
}
}));
}
}
} finally {
if (postMatching) {
context.triggerEvent(RequestEvent.Type.REQUEST_FILTERED);
}
tracingLogger.logDuration(summaryEvent, timestamp, processedCount);
}
return Continuation.of(context, getDefaultNext());
}
private static class ResponseFilterStage extends AbstractChainableStage {
// TODO remove the field - processing context should be made available on the response chain directly.
private final RequestProcessingContext processingContext;
private final Iterable> filters;
private final TracingLogger tracingLogger;
private ResponseFilterStage(final RequestProcessingContext processingContext,
final Iterable> filters,
final TracingLogger tracingLogger) {
this.processingContext = processingContext;
this.filters = filters;
this.tracingLogger = tracingLogger;
}
@Override
@SuppressWarnings("unchecked")
public Continuation apply(ContainerResponse responseContext) {
final ArrayList>> rankedProviders = new ArrayList<>(2);
rankedProviders.add(filters);
rankedProviders.add(responseContext.getRequestContext().getResponseFilters());
Iterable sortedResponseFilters = Providers.mergeAndSortRankedProviders(
new RankedComparator(RankedComparator.Order.DESCENDING), rankedProviders);
final ContainerRequest request = responseContext.getRequestContext();
processingContext.monitoringEventBuilder().setContainerResponseFilters(sortedResponseFilters);
processingContext.triggerEvent(RequestEvent.Type.RESP_FILTERS_START);
final long timestamp = tracingLogger.timestamp(ServerTraceEvent.RESPONSE_FILTER_SUMMARY);
int processedCount = 0;
try {
for (ContainerResponseFilter filter : sortedResponseFilters) {
final long filterTimestamp = tracingLogger.timestamp(ServerTraceEvent.RESPONSE_FILTER);
try {
filter.filter(request, responseContext);
} catch (Exception ex) {
throw new MappableException(ex);
} finally {
processedCount++;
tracingLogger.logDuration(ServerTraceEvent.RESPONSE_FILTER, filterTimestamp, filter);
}
}
} finally {
processingContext.triggerEvent(RequestEvent.Type.RESP_FILTERS_FINISHED);
tracingLogger.logDuration(ServerTraceEvent.RESPONSE_FILTER_SUMMARY, timestamp, processedCount);
}
return Continuation.of(responseContext, getDefaultNext());
}
}
}