org.apache.tomee.catalina.security

Class URLPattern

java.lang.Object

org.apache.tomee.catalina.security.URLPattern

public class URLPattern
extends Object

Utility class for ModuleConfiguration. This class is used to generate qualified patterns, HTTP method sets, complements of HTTP method sets, and HTTP method sets w/ transport restrictions for URL patterns that are found in the web deployment descriptor.

Version:

$Rev$ $Date$

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIDENTIAL
static int	INTEGRAL
static int	NA

Constructor Summary

Constructors

Constructor and Description
URLPattern(String pat, Set<String> methods, boolean isHttpMethodExcluded) Construct an instance of the utility class for WebModuleConfiguration.

Method Summary

Modifier and Type	Method and Description
void	addMethods(Set<String> methods, boolean isExcluded) Add a method to the union of HTTP methods associated with this URL pattern.
boolean	equals(Object obj) TODO this is kinda weird without an explanation
HTTPMethods	getComplementedHTTPMethods()
String	getComplementedMethods()
HTTPMethods	getHTTPMethods()
String	getMethods() Return the set of HTTP methods that have been associated with this URL pattern.
String	getMethodsWithTransport()
static String	getMethodsWithTransport(HTTPMethods methods, int transport)
String	getQualifiedPattern(Set<URLPattern> patterns) Get a qualifed URL pattern relative to a particular set of URL patterns.
int	getTransport()
int	hashCode()
boolean	removeMethods(URLPattern other)
void	setTransport(String trans)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NA

public static final int NA

See Also:

Constant Field Values

INTEGRAL

public static final int INTEGRAL

See Also:

Constant Field Values

CONFIDENTIAL

public static final int CONFIDENTIAL

See Also:

Constant Field Values

Constructor Detail

URLPattern

public URLPattern(String pat,
                  Set<String> methods,
                  boolean isHttpMethodExcluded)

Construct an instance of the utility class for WebModuleConfiguration.

Parameters:

pat - the URL pattern that this instance is to collect information on

See Also:

"JSR 115, section 3.1.3" Translating Servlet Deployment Descriptors

Method Detail

getQualifiedPattern

public String getQualifiedPattern(Set<URLPattern> patterns)

Get a qualifed URL pattern relative to a particular set of URL patterns. This algorithm is described in JSR 115, section 3.1.3.1 "Qualified URL Pattern Names".

Parameters:

patterns - the set of possible URL patterns that could be used to qualify this pattern

Returns:

a qualifed URL pattern

addMethods

public void addMethods(Set<String> methods,
                       boolean isExcluded)

Add a method to the union of HTTP methods associated with this URL pattern. An empty Set is short hand for the set of all HTTP methods.

Parameters:

methods - the HTTP methods to be added to the set.

removeMethods

public boolean removeMethods(URLPattern other)

getMethods

public String getMethods()

Return the set of HTTP methods that have been associated with this URL pattern.

Returns:

a set of HTTP methods

getComplementedMethods

public String getComplementedMethods()

getHTTPMethods

public HTTPMethods getHTTPMethods()

getComplementedHTTPMethods

public HTTPMethods getComplementedHTTPMethods()

getMethodsWithTransport

public String getMethodsWithTransport()

getMethodsWithTransport

public static String getMethodsWithTransport(HTTPMethods methods,
                                             int transport)

setTransport

public void setTransport(String trans)

getTransport

public int getTransport()

equals

public boolean equals(Object obj)

TODO this is kinda weird without an explanation

Overrides:

equals in class Object

Parameters:

obj - object to compare with

Returns:

if this equals obj

hashCode

public int hashCode()

Overrides:

hashCode in class Object