org.eclipse.jetty.server.handler.PathMappingsHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-server Show documentation
Show all versions of jetty-server Show documentation
The core jetty server artifact.
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.server.handler;
import java.io.IOException;
import java.util.List;
import org.eclipse.jetty.http.pathmap.MappedResource;
import org.eclipse.jetty.http.pathmap.MatchedResource;
import org.eclipse.jetty.http.pathmap.PathMappings;
import org.eclipse.jetty.http.pathmap.PathSpec;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.Response;
import org.eclipse.jetty.util.Callback;
import org.eclipse.jetty.util.component.Dumpable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A Handler that delegates to other handlers through a configured {@link PathMappings}.
*/
public class PathMappingsHandler extends Handler.AbstractContainer
{
private static final Logger LOG = LoggerFactory.getLogger(PathMappingsHandler.class);
private final PathMappings mappings = new PathMappings<>();
public PathMappingsHandler()
{
this(true);
}
public PathMappingsHandler(boolean dynamic)
{
super(dynamic);
}
@Override
public List getHandlers()
{
return mappings.streamResources().map(MappedResource::getResource).toList();
}
public void addMapping(PathSpec pathSpec, Handler handler)
{
if (isStarted())
throw new IllegalStateException("Cannot add mapping: " + this);
// check that self isn't present
if (handler == this)
throw new IllegalStateException("Unable to addHandler of self: " + handler);
// check for loops
if (handler instanceof Handler.Container container && container.getDescendants().contains(this))
throw new IllegalStateException("loop detected: " + handler);
// add new mapping and remove any old
Handler old = mappings.get(pathSpec);
mappings.put(pathSpec, handler);
updateBean(old, handler);
}
@Override
public void dump(Appendable out, String indent) throws IOException
{
Dumpable.dumpObjects(out, indent, this, mappings);
}
@Override
public boolean handle(Request request, Response response, Callback callback) throws Exception
{
String pathInContext = Request.getPathInContext(request);
MatchedResource matchedResource = mappings.getMatched(pathInContext);
if (matchedResource == null)
{
if (LOG.isDebugEnabled())
LOG.debug("No mappings matched {}", pathInContext);
return false;
}
Handler handler = matchedResource.getResource();
if (LOG.isDebugEnabled())
LOG.debug("Matched {} to {} -> {}", pathInContext, matchedResource.getPathSpec(), handler);
boolean handled = handler.handle(request, response, callback);
if (LOG.isDebugEnabled())
LOG.debug("Handled {} {} by {}", handled, pathInContext, handler);
return handled;
}
}