io.undertow.predicate.PathPrefixPredicate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of undertow-core Show documentation
There is a newer version: 2.3.18.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package io.undertow.predicate;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.stream.Collectors;

import io.undertow.server.HttpServerExchange;
import io.undertow.util.PathMatcher;
import io.undertow.UndertowLogger;

/**
 * @author Stuart Douglas
 */
public class PathPrefixPredicate implements Predicate {

    public static final String PREFIX_MATCH_RECORD = "PREFIX_MATCH_RECORD";
    private final PathMatcher pathMatcher;
    private static final boolean traceEnabled;

    static {
        traceEnabled = UndertowLogger.PREDICATE_LOGGER.isTraceEnabled();
    }

    PathPrefixPredicate(final String... paths) {
        PathMatcher matcher = new PathMatcher<>();
        for(String path : paths) {
            if(!path.startsWith("/")) {
                matcher.addPrefixPath("/" + path, Boolean.TRUE);
            } else {
                matcher.addPrefixPath(path, Boolean.TRUE);
            }
        }
        this.pathMatcher = matcher;
    }

    @Override
    public boolean resolve(final HttpServerExchange value) {
        final String relativePath = value.getRelativePath();
        PathMatcher.PathMatch result = pathMatcher.match(relativePath);

        boolean matches = Boolean.TRUE.equals(result.getValue());

        if (traceEnabled) {
            UndertowLogger.PREDICATE_LOGGER.tracef("Path prefix(s) [%s] %s input [%s] for %s.", pathMatcher.getPathMatchesSet().stream().collect(Collectors.joining(", ")), (matches ? "MATCH" : "DO NOT MATCH" ), relativePath, value);
        }
        if(matches) {
            Map context = value.getAttachment(PREDICATE_CONTEXT);
            if(context == null) {
                value.putAttachment(PREDICATE_CONTEXT, context = new TreeMap<>());
            }
            if (traceEnabled && result.getRemaining().length() > 0 ) {
                UndertowLogger.PREDICATE_LOGGER.tracef("Storing \"remaining\" string of [%s] for %s.", result.getRemaining(), value);
            }
            context.put("remaining", result.getRemaining());
            final PathPrefixMatchRecord transformer = new PathPrefixMatchRecord();
            transformer.setRemaining(result.getRemaining());
            transformer.setPrefix(result.getMatched());
            context.put(PREFIX_MATCH_RECORD, transformer);
        }
        return matches;
    }

    public String toString() {
        Set matches = pathMatcher.getPathMatchesSet();
        if( matches.size() == 1 ) {
            return "path-prefix( '" + matches.toArray()[0] +  "' )";
        } else {
            return "path-prefix( { '" + matches.stream().collect(Collectors.joining("', '")) +  "' } )";
        }
    }

    public static class Builder implements PredicateBuilder {

        @Override
        public String name() {
            return "path-prefix";
        }

        @Override
        public Map> parameters() {
            return Collections.>singletonMap("path", String[].class);
        }

        @Override
        public Set requiredParameters() {
            return Collections.singleton("path");
        }

        @Override
        public String defaultParameter() {
            return "path";
        }

        @Override
        public Predicate build(final Map config) {
            String[] path = (String[]) config.get("path");
            return new PathPrefixPredicate(path);
        }
    }

    public static class PathPrefixMatchRecord {

        private String prefix;
        private String remaining;
        private boolean overWritten;

        public void setPrefix(final String prefix) {
            this.prefix = prefix;
        }

        public void setRemaining(final String remaining) {
            this.remaining = remaining;
        }

        public void overWritten() {
            this.overWritten = true;
        }

        public boolean isOverWritten() {
            return this.overWritten;
        }

        public String getPrefix() {
            return prefix;
        }

        public String getRemaining() {
            return remaining;
        }

    }
}