org.eclipse.jetty.server.Dispatcher Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.server;
import java.io.IOException;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import javax.servlet.DispatcherType;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.http.BadMessageException;
import org.eclipse.jetty.http.HttpCompliance;
import org.eclipse.jetty.http.HttpURI;
import org.eclipse.jetty.io.Connection;
import org.eclipse.jetty.server.handler.ContextHandler;
import org.eclipse.jetty.util.Attributes;
import org.eclipse.jetty.util.MultiMap;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
// @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
@Deprecated(since = "2021-05-27")
public class Dispatcher implements RequestDispatcher {
private static final Logger LOG = Log.getLogger(Dispatcher.class);
/**
* Dispatch include attribute names
*/
public static final String __INCLUDE_PREFIX = "javax.servlet.include.";
/**
* Dispatch include attribute names
*/
public static final String __FORWARD_PREFIX = "javax.servlet.forward.";
private final ContextHandler _contextHandler;
private final HttpURI _uri;
private final String _pathInContext;
private final String _named;
public Dispatcher(ContextHandler contextHandler, HttpURI uri, String pathInContext) {
_contextHandler = contextHandler;
_uri = uri;
_pathInContext = pathInContext;
_named = null;
}
public Dispatcher(ContextHandler contextHandler, String name) throws IllegalStateException {
_contextHandler = contextHandler;
_uri = null;
_pathInContext = null;
_named = name;
}
@Override
public void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException {
forward(request, response, DispatcherType.FORWARD);
}
public void error(ServletRequest request, ServletResponse response) throws ServletException, IOException {
forward(request, response, DispatcherType.ERROR);
}
@Override
public void include(ServletRequest request, ServletResponse response) throws ServletException, IOException {
Request baseRequest = Objects.requireNonNull(Request.getBaseRequest(request));
if (!(request instanceof HttpServletRequest))
request = new ServletRequestHttpWrapper(request);
if (!(response instanceof HttpServletResponse))
response = new ServletResponseHttpWrapper(response);
final DispatcherType old_type = baseRequest.getDispatcherType();
final Attributes old_attr = baseRequest.getAttributes();
final MultiMap old_query_params = baseRequest.getQueryParameters();
try {
baseRequest.setDispatcherType(DispatcherType.INCLUDE);
baseRequest.getResponse().include();
if (_named != null) {
_contextHandler.handle(_named, baseRequest, (HttpServletRequest) request, (HttpServletResponse) response);
} else {
Objects.requireNonNull(_uri);
// Check any URI violations against the compliance for this request
checkUriViolations(_uri, baseRequest);
IncludeAttributes attr = new IncludeAttributes(old_attr);
attr._requestURI = _uri.getPath();
attr._contextPath = _contextHandler.getRequestContextPath();
// set by ServletHandler
attr._servletPath = null;
attr._pathInfo = _pathInContext;
attr._query = _uri.getQuery();
if (attr._query != null)
baseRequest.mergeQueryParameters(baseRequest.getQueryString(), attr._query, false);
baseRequest.setAttributes(attr);
_contextHandler.handle(_pathInContext, baseRequest, (HttpServletRequest) request, (HttpServletResponse) response);
}
} finally {
baseRequest.setAttributes(old_attr);
baseRequest.getResponse().included();
baseRequest.setQueryParameters(old_query_params);
baseRequest.resetParameters();
baseRequest.setDispatcherType(old_type);
}
}
protected void forward(ServletRequest request, ServletResponse response, DispatcherType dispatch) throws ServletException, IOException {
Request baseRequest = Objects.requireNonNull(Request.getBaseRequest(request));
Response baseResponse = baseRequest.getResponse();
baseResponse.resetForForward();
if (!(request instanceof HttpServletRequest))
request = new ServletRequestHttpWrapper(request);
if (!(response instanceof HttpServletResponse))
response = new ServletResponseHttpWrapper(response);
final HttpURI old_uri = baseRequest.getHttpURI();
final String old_context_path = baseRequest.getContextPath();
final String old_servlet_path = baseRequest.getServletPath();
final String old_path_info = baseRequest.getPathInfo();
final MultiMap old_query_params = baseRequest.getQueryParameters();
final Attributes old_attr = baseRequest.getAttributes();
final DispatcherType old_type = baseRequest.getDispatcherType();
try {
baseRequest.setDispatcherType(dispatch);
if (_named != null) {
_contextHandler.handle(_named, baseRequest, (HttpServletRequest) request, (HttpServletResponse) response);
} else {
Objects.requireNonNull(_uri);
// Check any URI violations against the compliance for this request
checkUriViolations(_uri, baseRequest);
ForwardAttributes attr = new ForwardAttributes(old_attr);
// If we have already been forwarded previously, then keep using the established
// original value. Otherwise, this is the first forward and we need to establish the values.
// Note: the established value on the original request for pathInfo and
// for queryString is allowed to be null, but cannot be null for the other values.
if (old_attr.getAttribute(FORWARD_REQUEST_URI) != null) {
attr._pathInfo = (String) old_attr.getAttribute(FORWARD_PATH_INFO);
attr._query = (String) old_attr.getAttribute(FORWARD_QUERY_STRING);
attr._requestURI = (String) old_attr.getAttribute(FORWARD_REQUEST_URI);
attr._contextPath = (String) old_attr.getAttribute(FORWARD_CONTEXT_PATH);
attr._servletPath = (String) old_attr.getAttribute(FORWARD_SERVLET_PATH);
} else {
attr._pathInfo = old_path_info;
attr._query = old_uri.getQuery();
attr._requestURI = old_uri.getPath();
attr._contextPath = old_context_path;
attr._servletPath = old_servlet_path;
}
// Combine old and new URIs.
HttpURI uri = new HttpURI(old_uri, _uri);
baseRequest.setHttpURI(uri);
baseRequest.setContextPath(_contextHandler.getContextPath());
baseRequest.setServletPath(null);
baseRequest.setPathInfo(_pathInContext);
if (_uri.getQuery() != null || old_uri.getQuery() != null) {
try {
baseRequest.mergeQueryParameters(old_uri.getQuery(), _uri.getQuery(), true);
} catch (BadMessageException e) {
// Only throw BME if not in Error Dispatch Mode
// This allows application ErrorPageErrorHandler to handle BME messages
if (dispatch != DispatcherType.ERROR) {
throw e;
} else {
LOG.warn("Ignoring Original Bad Request Query String: " + old_uri, e);
}
}
}
baseRequest.setAttributes(attr);
_contextHandler.handle(_pathInContext, baseRequest, (HttpServletRequest) request, (HttpServletResponse) response);
// If we are not async and not closed already, then close via the possibly wrapped response.
if (!baseRequest.getHttpChannelState().isAsync() && !baseResponse.getHttpOutput().isClosed()) {
try {
response.getOutputStream().close();
} catch (IllegalStateException e) {
response.getWriter().close();
}
}
}
} finally {
baseRequest.setHttpURI(old_uri);
baseRequest.setContextPath(old_context_path);
baseRequest.setServletPath(old_servlet_path);
baseRequest.setPathInfo(old_path_info);
baseRequest.setQueryParameters(old_query_params);
baseRequest.resetParameters();
baseRequest.setAttributes(old_attr);
baseRequest.setDispatcherType(old_type);
}
}
private static void checkUriViolations(HttpURI uri, Request baseRequest) {
if (uri.hasViolations()) {
HttpChannel channel = baseRequest.getHttpChannel();
Connection connection = channel == null ? null : channel.getConnection();
HttpCompliance compliance = connection instanceof HttpConnection ? ((HttpConnection) connection).getHttpCompliance() : channel != null ? channel.getConnector().getBean(HttpCompliance.class) : null;
String illegalState = HttpCompliance.checkUriCompliance(compliance, uri);
if (illegalState != null)
throw new IllegalStateException(illegalState);
}
}
@Override
public String toString() {
return String.format("Dispatcher@0x%x{%s,%s}", hashCode(), _named, _uri);
}
// @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
@Deprecated(since = "2021-05-27")
private class ForwardAttributes extends Attributes.Wrapper {
private String _requestURI;
private String _contextPath;
private String _servletPath;
private String _pathInfo;
private String _query;
ForwardAttributes(Attributes attributes) {
super(attributes);
}
@Override
public Object getAttribute(String key) {
if (Dispatcher.this._named == null) {
switch(key) {
case FORWARD_PATH_INFO:
return _pathInfo;
case FORWARD_REQUEST_URI:
return _requestURI;
case FORWARD_SERVLET_PATH:
return _servletPath;
case FORWARD_CONTEXT_PATH:
return _contextPath;
case FORWARD_QUERY_STRING:
return _query;
default:
break;
}
}
// TODO: should this be __FORWARD_PREFIX?
if (key.startsWith(__INCLUDE_PREFIX))
return null;
return _attributes.getAttribute(key);
}
@Override
public Set getAttributeNameSet() {
HashSet set = new HashSet<>();
super.getAttributeNameSet().stream().filter(name -> !name.startsWith(__INCLUDE_PREFIX)).filter(name -> !name.startsWith(__FORWARD_PREFIX)).forEach(set::add);
if (_named == null) {
if (_pathInfo != null)
set.add(FORWARD_PATH_INFO);
if (_requestURI != null)
set.add(FORWARD_REQUEST_URI);
if (_servletPath != null)
set.add(FORWARD_SERVLET_PATH);
if (_contextPath != null)
set.add(FORWARD_CONTEXT_PATH);
if (_query != null)
set.add(FORWARD_QUERY_STRING);
}
return set;
}
@Override
public void setAttribute(String key, Object value) {
if (_named == null && key.startsWith("javax.servlet.")) {
switch(key) {
case FORWARD_PATH_INFO:
_pathInfo = (String) value;
break;
case FORWARD_REQUEST_URI:
_requestURI = (String) value;
break;
case FORWARD_SERVLET_PATH:
_servletPath = (String) value;
break;
case FORWARD_CONTEXT_PATH:
_contextPath = (String) value;
break;
case FORWARD_QUERY_STRING:
_query = (String) value;
break;
default:
if (value == null)
_attributes.removeAttribute(key);
else
_attributes.setAttribute(key, value);
break;
}
} else if (value == null)
_attributes.removeAttribute(key);
else
_attributes.setAttribute(key, value);
}
@Override
public String toString() {
return "FORWARD+" + _attributes.toString();
}
@Override
public void clearAttributes() {
throw new IllegalStateException();
}
@Override
public void removeAttribute(String name) {
setAttribute(name, null);
}
}
// @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
@Deprecated(since = "2021-05-27")
private class IncludeAttributes extends Attributes.Wrapper {
private String _requestURI;
private String _contextPath;
private String _servletPath;
private String _pathInfo;
private String _query;
IncludeAttributes(Attributes attributes) {
super(attributes);
}
@Override
public Object getAttribute(String key) {
if (Dispatcher.this._named == null) {
switch(key) {
case INCLUDE_PATH_INFO:
return _pathInfo;
case INCLUDE_SERVLET_PATH:
return _servletPath;
case INCLUDE_CONTEXT_PATH:
return _contextPath;
case INCLUDE_QUERY_STRING:
return _query;
case INCLUDE_REQUEST_URI:
return _requestURI;
default:
break;
}
} else if (key.startsWith(__INCLUDE_PREFIX))
return null;
return _attributes.getAttribute(key);
}
@Override
public Set getAttributeNameSet() {
HashSet set = new HashSet<>();
super.getAttributeNameSet().stream().filter(name -> !name.startsWith(__INCLUDE_PREFIX)).forEach(set::add);
if (_named == null) {
if (_pathInfo != null)
set.add(INCLUDE_PATH_INFO);
if (_requestURI != null)
set.add(INCLUDE_REQUEST_URI);
if (_servletPath != null)
set.add(INCLUDE_SERVLET_PATH);
if (_contextPath != null)
set.add(INCLUDE_CONTEXT_PATH);
if (_query != null)
set.add(INCLUDE_QUERY_STRING);
}
return set;
}
@Override
public void setAttribute(String key, Object value) {
if (_named == null && key.startsWith("javax.servlet.")) {
switch(key) {
case INCLUDE_PATH_INFO:
_pathInfo = (String) value;
break;
case INCLUDE_REQUEST_URI:
_requestURI = (String) value;
break;
case INCLUDE_SERVLET_PATH:
_servletPath = (String) value;
break;
case INCLUDE_CONTEXT_PATH:
_contextPath = (String) value;
break;
case INCLUDE_QUERY_STRING:
_query = (String) value;
break;
default:
if (value == null)
_attributes.removeAttribute(key);
else
_attributes.setAttribute(key, value);
break;
}
} else if (value == null)
_attributes.removeAttribute(key);
else
_attributes.setAttribute(key, value);
}
@Override
public String toString() {
return "INCLUDE+" + _attributes.toString();
}
@Override
public void clearAttributes() {
throw new IllegalStateException();
}
@Override
public void removeAttribute(String name) {
setAttribute(name, null);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy