pathtemplate.java

来自「resetful样式的ws样例,一种面向资源的webservices服务」· Java 代码 · 共 88 行

/*
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://jersey.dev.java.net/CDDL+GPL.html
 * or jersey/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at jersey/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.jersey.impl.uri;

import com.sun.jersey.api.uri.UriTemplate;
import com.sun.jersey.api.uri.UriComponent;

/**
 * A URI template for a URI path.
 * 
 * @author [e-mail]
 */
public final class PathTemplate extends UriTemplate {
    
    /**
     * Create a URI path template and encode (percent escape) any characters 
     * of the template that are not valid URI characters.
     * 
     * @param template the URI path template
     */
    public PathTemplate(String template) {
        this(template, false);
    }
    
    /**
     * Create a URI path template and encode (percent escape) any characters 
     * of the template that are not valid URI characters.
     * 
     * @param template the URI path template. The template is prefixed with
     *        a '/' if the template does not start with a '/'.
     * @param encode if true encode (percent escape) any characters of the 
     *       template that are not valid URI path characters (excluding template
     *       specific characters), otherwise validate the characters.
     * @throws IllegalArgumentException if the template is validated and it
     *         contains illegal characters. 
     */
    public PathTemplate(String template, boolean encode) {
        super(encodeOrValidate(prefixWithSlash(template), encode));
    }
    
    private static String encodeOrValidate(String path, boolean encode) {
        if (encode) {
            return UriComponent.encode(path, UriComponent.Type.PATH, true);
        } else {
            UriComponent.validate(path, UriComponent.Type.PATH, true);
            return path;
        }
    }
    
    private static String prefixWithSlash(String regex) {
        return (!regex.startsWith("/")) ? "/" + regex : regex;
    }
}