/*
* 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://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/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 glassfish/bootstrap/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.
*/
/* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package javax.security.jacc;
/**
*
* @see
*
* @author Ron Monzillo
*
* @serial exclude
*/
class URLPattern extends Object implements Comparable
{
private static String DEFAULT_PATTERN = "/";
private int patternType = -1;
private final String pattern;
public URLPattern ()
{
this.pattern = DEFAULT_PATTERN;
this.patternType = PT_DEFAULT;
}
// note tht the EMPTY_STRING is legitimte URL_PATTERN
public URLPattern (String p)
{
if (p == null) {
this.pattern = DEFAULT_PATTERN;
this.patternType = PT_DEFAULT;
}
else this.pattern = p;
}
/* changed to order default pattern / below extension */
public static final int PT_DEFAULT = 0;
public static final int PT_EXTENSION = 1;
public static final int PT_PREFIX = 2;
public static final int PT_EXACT = 3;
public int patternType() {
if (this.patternType < 0) {
if (this.pattern.startsWith("*."))
this.patternType = PT_EXTENSION;
else if (this.pattern.startsWith("/") &&
this.pattern.endsWith("/*")) this.patternType = PT_PREFIX;
else if (this.pattern.equals(DEFAULT_PATTERN))
this.patternType = PT_DEFAULT;
else this.patternType = PT_EXACT;
}
return this.patternType;
}
public int compareTo(Object o) {
if (!(o instanceof URLPattern))
throw new ClassCastException("argument must be URLPattern");
URLPattern p = (URLPattern) o;
if (p == null) p = new URLPattern(null);
int refPatternType = this.patternType();
/* The comparison yields increasing sort order
* by pattern type. That is, prefix patterns sort before exact
* patterns. Also shorter length patterns precede longer
* length patterns. This is important for the URLPatternList
* canonicalization done by URLPatternSpec.setURLPatternArray
*/
int result = refPatternType - p.patternType();
if (result == 0) {
if (refPatternType == PT_PREFIX || refPatternType == PT_EXACT) {
result = this.getPatternDepth() - p.getPatternDepth();
if (result == 0) result = this.pattern.compareTo(p.pattern);
}
else result = this.pattern.compareTo(p.pattern);
}
return (result > 0 ? 1 : (result < 0 ? -1 : 0));
}
/**
* Does this pattern imply (that is, match) the argument pattern?
* This method follows the same rules (in the same order) as those used
* for mapping requests to servlets.
*<P>
* Two URL patterns match if they are related as follows: <p>
* <ul>
* <li> their pattern values are String equivalent, or
* <li> this pattern is the path-prefix pattern "/*", or
* <li> this pattern is a path-prefix pattern (that is, it starts with
* "/" and ends with "/*") and the argument pattern starts with the
* substring of this pattern, minus its last 2 characters, and the
* next character of the argument pattern, if there is one, is "/", or
* <li> this pattern is an extension pattern (that is, it starts with
* "*.") and the argument pattern ends with this pattern, or
* <li> the reference pattern is the special default pattern, "/",
* which matches all argument patterns.
* </ul>
* @param p URLPattern to determine if implied by (matched by)
* this URLPattern to
*/
public boolean implies(URLPattern p) {
// Normalize the argument
if (p == null) p = new URLPattern(null);
String path = p.pattern;
String pattern = this.pattern;
// Check for exact match
if (pattern.equals(path))
return (true);
// Check for path prefix matching
if (pattern.startsWith("/") && pattern.endsWith("/*")) {
pattern = pattern.substring(0, pattern.length() - 2);
int length = pattern.length();
if (length == 0) return (true); // "/*" is the same as the DEFAULT_PATTERN
return (path.startsWith(pattern) &&
(path.length() == length ||
path.substring(length).startsWith("/")));
}
// Check for suffix matching
if (pattern.startsWith("*.")) {
int slash = path.lastIndexOf('/');
int period = path.lastIndexOf('.');
if ((slash >= 0) && (period > slash) &&
path.endsWith(pattern.substring(1))) {
return (true);
}
return (false);
}
// Check for universal mapping
if (pattern.equals(DEFAULT_PATTERN))
return (true);
return (false);
}
public boolean equals(Object obj) {
if (! (obj instanceof URLPattern)) return false;
return this.pattern.equals(((URLPattern) obj).pattern);
}
public String toString() {
return this.pattern;
}
public int getPatternDepth() {
int i = 0;
int depth = 1;
while (i >= 0) {
i = this.pattern.indexOf("/",i);
if (i >= 0 ) {
if (i == 0 && depth != 1)
throw new IllegalArgumentException("// in pattern");
i += 1;
}
}
return depth;
}
}
|
