org.apache.cxf.jaxrs.model.URITemplate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cxf-rt-frontend-jaxrs Show documentation
Apache CXF Runtime JAX-RS Frontend
There is a newer version: 4.1.1
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.cxf.jaxrs.model;


import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.ws.rs.Path;
import javax.ws.rs.core.MultivaluedMap;

public final class URITemplate {
    
    public static final String TEMPLATE_PARAMETERS = "jaxrs.template.parameters";
    
    public static final String LIMITED_REGEX_SUFFIX = "(/.*)?";
    public static final String UNLIMITED_REGEX_SUFFIX = "(/)?";
    public static final String FINAL_MATCH_GROUP = "FINAL_MATCH_GROUP";
    
    /**
     * The regular expression for matching URI templates and names.
     */
    private static final Pattern TEMPLATE_NAMES_PATTERN = Pattern.compile("\\{([\\w-\\._~]+?)\\}");

    /**
     * A URI template is converted into a regular expression by substituting
     * (.*?) for each occurrence of {\([w- 14 \. ]+?\)} within the URL
     * template
     */
    private static final String URITEMPLATE_VARIABLE_REGEX = "(.*?)";

    private final String template;
    private final String regexSuffix;
    private final boolean endsWithSlash;
    private final List templateVariables;
    private final String templateRegex;
    private final Pattern templateRegexPattern;

    public URITemplate(String theTemplate) {
        this(theTemplate, null);
    }
    
    public URITemplate(String theTemplate, String theRegexSuffix) {
        this.template = theTemplate;
        this.regexSuffix = theRegexSuffix;

        StringBuilder stringBuilder = new StringBuilder();
        List names = new ArrayList();

        // compute a regular expression from URI template
        Matcher matcher = TEMPLATE_NAMES_PATTERN.matcher(template);
        int i = 0;
        while (matcher.find()) {
            copyURITemplateCharacters(template, i, matcher.start(), stringBuilder);
            stringBuilder.append(URITEMPLATE_VARIABLE_REGEX);
            names.add(matcher.group(1));
            i = matcher.end();
        }
        copyURITemplateCharacters(template, i, template.length(), stringBuilder);

        templateVariables = Collections.unmodifiableList(names);

        int endPos = stringBuilder.length() - 1;
        this.endsWithSlash = (endPos >= 0) ? stringBuilder.charAt(endPos) == '/' : false;
        if (regexSuffix != null) {
            if (endsWithSlash) {
                stringBuilder.deleteCharAt(endPos);
            }
            stringBuilder.append(regexSuffix);
        }

        templateRegex = stringBuilder.toString();
        //System.out.println("----" + theTemplate + ": " + templateRegex);
        templateRegexPattern = Pattern.compile(templateRegex);
    }

    public String getValue() {
        return template;
    }
    
    private void copyURITemplateCharacters(String templateValue, int start, int end, StringBuilder b) {
        for (int i = start; i < end; i++) {
            char c = templateValue.charAt(i);
            if (c == '?') {
                b.append("\\?");
            } else {
                b.append(c);
            }
        }
    }

    public boolean match(String uri, MultivaluedMap templateVariableToValue) {

        if (uri == null) {
            return (templateRegexPattern == null) ? true : false;
        }

        if (templateRegexPattern == null) {
            return false;
        }

        Matcher m = templateRegexPattern.matcher(uri);
        if (!m.matches()) {
            return false;
        }

        // Assign the matched template values to template variables
        int i = 1;
        for (String name : templateVariables) {
            String value = m.group(i++);
            templateVariableToValue.add(name, value);
        }

        // The right hand side value, might be used to further resolve sub-resources.
        if (regexSuffix != null) {
            String finalGroup = m.group(i);
            templateVariableToValue.putSingle(FINAL_MATCH_GROUP, finalGroup == null ? "/" : finalGroup);
        }

        return true;
    }
    
    public static URITemplate createTemplate(ClassResourceInfo cri,
                                             Path path) {
        
        if (path == null) {
            return new URITemplate("/", URITemplate.UNLIMITED_REGEX_SUFFIX);
        }
        
        String pathValue = path.value();
        if (!pathValue.startsWith("/")) {
            pathValue = "/" + pathValue;
        }
        
        String suffixPattern = (path.limited())
            ? URITemplate.LIMITED_REGEX_SUFFIX : URITemplate.UNLIMITED_REGEX_SUFFIX;
        
        return new URITemplate(pathValue, suffixPattern);
    }
}