Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converted PathMappings to be an AbstractMap #9213

Merged
merged 2 commits into from
Jan 30, 2023
Merged

Converted PathMappings to be an AbstractMap #9213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb931a2
Converted PathMappings to be an AbstractMap
gregw Jan 26, 2023
cec2520
Converted PathMappings to be an AbstractMap
gregw Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/MappedResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@

package org.eclipse.jetty.http.pathmap;

import java.util.Map;

import org.eclipse.jetty.util.annotation.ManagedAttribute;
import org.eclipse.jetty.util.annotation.ManagedObject;

@ManagedObject("Mapped Resource")
public class MappedResource<E> implements Comparable<MappedResource<E>>
public class MappedResource<E> implements Comparable<MappedResource<E>>, Map.Entry<PathSpec, E>
{
private final PathSpec pathSpec;
private final E resource;
Expand Down Expand Up @@ -90,6 +92,24 @@ else if (!pathSpec.equals(other.pathSpec))
return true;
}

@Override
public PathSpec getKey()
{
return getPathSpec();
}

@Override
public E getValue()
{
return getResource();
}

@Override
public E setValue(E value)
{
throw new UnsupportedOperationException();
}

@ManagedAttribute(value = "path spec", readonly = true)
public PathSpec getPathSpec()
{
Expand Down
226 changes: 125 additions & 101 deletions jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/PathMappings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
package org.eclipse.jetty.http.pathmap;

import java.io.IOException;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
Expand All @@ -41,10 +41,11 @@
* @param <E> the type of mapping endpoint
*/
@ManagedObject("Path Mappings")
public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
public class PathMappings<E> extends AbstractMap<PathSpec, E> implements Iterable<MappedResource<E>>, Dumpable
{
private static final Logger LOG = LoggerFactory.getLogger(PathMappings.class);
private final Set<MappedResource<E>> _mappings = new TreeSet<>(Comparator.comparing(MappedResource::getPathSpec));

private final Set<MappedResource<E>> _mappings = new TreeSet<>(Map.Entry.comparingByKey());

/**
* When _orderIsSignificant is true, the order of the MappedResources is significant and a match needs to be iteratively
Expand All @@ -67,6 +68,14 @@ public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
private MappedResource<E> _servletRoot;
private MappedResource<E> _servletDefault;

@Override
public Set<Entry<PathSpec, E>> entrySet()
{
@SuppressWarnings("unchecked")
Set<Map.Entry<PathSpec, E>> entries = (Set<Map.Entry<PathSpec, E>>)(Set<? extends Map.Entry<PathSpec, E>>)_mappings;
return entries;
}

@Override
public String dump()
{
Expand Down Expand Up @@ -108,9 +117,9 @@ public Stream<MappedResource<E>> streamResources()
return _mappings.stream();
}

public void removeIf(Predicate<MappedResource<E>> predicate)
public boolean removeIf(Predicate<MappedResource<E>> predicate)
{
_mappings.removeIf(predicate);
return _mappings.removeIf(predicate);
}

/**
Expand Down Expand Up @@ -352,130 +361,145 @@ public Iterator<MappedResource<E>> iterator()
return _mappings.iterator();
}

public E get(PathSpec spec)
@Override
public E get(Object key)
{
return _mappings.stream()
.filter(mappedResource -> mappedResource.getPathSpec().equals(spec))
.map(MappedResource::getResource)
.findFirst()
.orElse(null);
return key instanceof PathSpec pathSpec ? get(pathSpec) : null;
}

public E get(PathSpec pathSpec)
{
if (pathSpec == null)
return null;

for (MappedResource<E> mr : _mappings)
{
if (pathSpec.equals(mr.getKey()))
return mr.getValue();
}
return null;
}

public boolean put(String pathSpecString, E resource)
public E put(String pathSpecString, E resource)
{
return put(PathSpec.from(pathSpecString), resource);
}

public boolean put(PathSpec pathSpec, E resource)
@Override
public E put(PathSpec pathSpec, E resource)
{
E old = remove(pathSpec);
MappedResource<E> entry = new MappedResource<>(pathSpec, resource);
boolean added = _mappings.add(entry);
_mappings.add(entry);
if (LOG.isDebugEnabled())
LOG.debug("{} {} to {}", added ? "Added" : "Ignored", entry, this);
LOG.debug("Added {} replacing {} to {}", entry, old, this);

if (added)
switch (pathSpec.getGroup())
{
switch (pathSpec.getGroup())
{
case EXACT:
if (pathSpec instanceof ServletPathSpec)
{
String exact = pathSpec.getDeclaration();
if (exact != null)
_exactMap.put(exact, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Exact
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example exact in Regex that can cause problems `^/a\Q/b\E/` (which is only ever matching `/a/b/`)
// Note: UriTemplate can handle exact easily enough
_optimizedExact = false;
_orderIsSignificant = true;
}
break;
case PREFIX_GLOB:
if (pathSpec instanceof ServletPathSpec)
{
String prefix = pathSpec.getPrefix();
if (prefix != null)
_prefixMap.put(prefix, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Prefix
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example Prefix in Regex that can cause problems `^/a/b+` or `^/a/bb*` ('b' one or more times)
// Note: Example Prefix in UriTemplate that might cause problems `/a/{b}/{c}`
_optimizedPrefix = false;
_orderIsSignificant = true;
}
break;
case SUFFIX_GLOB:
if (pathSpec instanceof ServletPathSpec)
{
String suffix = pathSpec.getSuffix();
if (suffix != null)
_suffixMap.put(suffix, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Suffix
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example suffix in Regex that can cause problems `^.*/path/name.ext` or `^/a/.*(ending)`
// Note: Example suffix in UriTemplate that can cause problems `/{a}/name.ext`
_optimizedSuffix = false;
_orderIsSignificant = true;
}
break;
case ROOT:
if (pathSpec instanceof ServletPathSpec)
{
if (_servletRoot == null)
_servletRoot = entry;
}
else
{
_orderIsSignificant = true;
}
break;
case DEFAULT:
if (pathSpec instanceof ServletPathSpec)
{
if (_servletDefault == null)
_servletDefault = entry;
}
else
{
_orderIsSignificant = true;
}
break;
default:
}
case EXACT:
if (pathSpec instanceof ServletPathSpec)
{
String exact = pathSpec.getDeclaration();
if (exact != null)
_exactMap.put(exact, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Exact
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example exact in Regex that can cause problems `^/a\Q/b\E/` (which is only ever matching `/a/b/`)
// Note: UriTemplate can handle exact easily enough
_optimizedExact = false;
_orderIsSignificant = true;
}
break;
case PREFIX_GLOB:
if (pathSpec instanceof ServletPathSpec)
{
String prefix = pathSpec.getPrefix();
if (prefix != null)
_prefixMap.put(prefix, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Prefix
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example Prefix in Regex that can cause problems `^/a/b+` or `^/a/bb*` ('b' one or more times)
// Note: Example Prefix in UriTemplate that might cause problems `/a/{b}/{c}`
_optimizedPrefix = false;
_orderIsSignificant = true;
}
break;
case SUFFIX_GLOB:
if (pathSpec instanceof ServletPathSpec)
{
String suffix = pathSpec.getSuffix();
if (suffix != null)
_suffixMap.put(suffix, entry);
}
else
{
// This is not a Servlet mapping, turn off optimization on Suffix
// TODO: see if we can optimize all Regex / UriTemplate versions here too.
// Note: Example suffix in Regex that can cause problems `^.*/path/name.ext` or `^/a/.*(ending)`
// Note: Example suffix in UriTemplate that can cause problems `/{a}/name.ext`
_optimizedSuffix = false;
_orderIsSignificant = true;
}
break;
case ROOT:
if (pathSpec instanceof ServletPathSpec)
{
if (_servletRoot == null)
_servletRoot = entry;
}
else
{
_orderIsSignificant = true;
}
break;
case DEFAULT:
if (pathSpec instanceof ServletPathSpec)
{
if (_servletDefault == null)
_servletDefault = entry;
}
else
{
_orderIsSignificant = true;
}
break;
default:
}

return added;
return old;
}

@Override
public E remove(Object key)
{
return key instanceof PathSpec pathSpec ? remove(pathSpec) : null;
}

@SuppressWarnings("incomplete-switch")
public boolean remove(PathSpec pathSpec)
public E remove(PathSpec pathSpec)
{
Iterator<MappedResource<E>> iter = _mappings.iterator();
boolean removed = false;
E removed = null;
while (iter.hasNext())
{
if (iter.next().getPathSpec().equals(pathSpec))
MappedResource<E> entry = iter.next();
if (entry.getPathSpec().equals(pathSpec))
{
removed = true;
removed = entry.getResource();
iter.remove();
break;
}
}

if (LOG.isDebugEnabled())
LOG.debug("{} {} to {}", removed ? "Removed" : "Ignored", pathSpec, this);
LOG.debug("Removed {} at {} from {}", removed, pathSpec, this);

if (removed)
if (removed != null)
{
switch (pathSpec.getGroup())
{
Expand Down
4 changes: 2 additions & 2 deletions jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/PathSpecSet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ private PathSpec asPathSpec(Object o)
@Override
public boolean add(String s)
{
return specs.put(PathSpec.from(s), Boolean.TRUE);
return specs.put(PathSpec.from(s), Boolean.TRUE) == null;
}

@Override
public boolean remove(Object o)
{
return specs.remove(asPathSpec(o));
return specs.remove(asPathSpec(o)) != null;
}

@Override
Expand Down
Loading