PathComparator.java

/*
 * Copyright 2015 Petr Bouda
 *
 * 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 org.joyrest.routing;

import java.util.List;
import java.util.function.BiPredicate;

import org.joyrest.exception.type.RestException;
import org.joyrest.model.RoutePart;
import org.joyrest.model.request.InternalRequest;

import com.codepoetics.protonpack.StreamUtils;

/**
 * Class is able compare the equality of a configured route's {@link Route} path and the path from the incoming model.
 *
 * @author pbouda
 */
public class PathComparator implements BiPredicate<InternalRoute, InternalRequest<?>> {

    /**
     * Compares the route part (part which is configured) and the path part (part which is gained from the client).
     *
     * If it is just string path, so this method will compare the value of the strings.
     * <p>
     * If it is param path, so method will find out whether is possible to cast the object or not.
     *
     * @param routePart configured part
     * @param pathPart path from a client's call
     * @return returns true if the parts are equal
     * @throws RestException is not possible to cast the param type
     **/
    private static boolean compareParts(RoutePart<?> routePart, String pathPart) {
        switch (routePart.getType()) {
            case PATH:
                return routePart.getValue().equals(pathPart);
            case PARAM:
                return routePart.getVariableType().isAssignableFromString(pathPart);
            default:
                return false;
        }
    }

    /**
     * Compares a configured route with the given path which comes from the client call.
     *
     * @param route configured route
     * @param request incoming model
     * @return returns true if all parts are equal
     **/
    @Override
    public boolean test(InternalRoute route, InternalRequest<?> request) {
        List<String> pathParts = request.getPathParts();
        List<RoutePart<?>> routeParts = route.getRouteParts();

        if (routeParts.size() != pathParts.size()) {
            return false;
        }

        request.setSelectedRoute(route);
        return StreamUtils.zip(routeParts.stream(), pathParts.stream(), PathComparator::compareParts)
            .allMatch(result -> result);
    }
}