winstone

Class Mapping

java.lang.Object

winstone.Mapping

All Implemented Interfaces:

Comparator

public class Mapping
extends Object
implements Comparator

Encapsulates the parsing of URL patterns, as well as the mapping of a url pattern to a servlet instance

Version:

$Id: Mapping.java,v 1.9 2007/04/23 02:55:35 rickknowles Exp $

Author:

Rick Knowles

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SERVLET
static int	EXACT_PATTERN
static int	EXTENSION_PATTERN
static int	FOLDER_PATTERN
static String	SLASH
static String	STAR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Mapping(String mappedTo)

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(Object objOne, Object objTwo) Used to compare two url patterns.
static Mapping	createFromLink(String mappedTo, String linkName) Factory constructor method - this turns a servlet name into a mapping element
static Mapping	createFromURL(String mappedTo, String pattern) Factory constructor method - this parses the url pattern into pieces we can use to match against incoming URLs.
String	getLinkName()
String	getMappedTo()
int	getPatternType()
String	getUrlPattern()
boolean	match(String inputPattern, StringBuffer servletPath, StringBuffer pathInfo) Try to match this pattern against the incoming url
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals

Field Detail

EXACT_PATTERN

public static final int EXACT_PATTERN

See Also:

Constant Field Values

FOLDER_PATTERN

public static final int FOLDER_PATTERN

See Also:

Constant Field Values

EXTENSION_PATTERN

public static final int EXTENSION_PATTERN

See Also:

Constant Field Values

DEFAULT_SERVLET

public static final int DEFAULT_SERVLET

See Also:

Constant Field Values

STAR

public static final String STAR

See Also:

Constant Field Values

SLASH

public static final String SLASH

See Also:

Constant Field Values

Constructor Detail

Mapping

protected Mapping(String mappedTo)

Method Detail

createFromURL

public static Mapping createFromURL(String mappedTo,
                    String pattern)

Factory constructor method - this parses the url pattern into pieces we can use to match against incoming URLs.

createFromLink

public static Mapping createFromLink(String mappedTo,
                     String linkName)

Factory constructor method - this turns a servlet name into a mapping element

getPatternType

public int getPatternType()

getUrlPattern

public String getUrlPattern()

getMappedTo

public String getMappedTo()

getLinkName

public String getLinkName()

match

public boolean match(String inputPattern,
            StringBuffer servletPath,
            StringBuffer pathInfo)

Try to match this pattern against the incoming url

Parameters:

inputPattern - The URL we want to check for a match

servletPath - An empty stringbuffer for the servletPath of a successful match

pathInfo - An empty stringbuffer for the pathInfo of a successful match

Returns:

true if the match is successful

compare

public int compare(Object objOne,
          Object objTwo)

Used to compare two url patterns. Always sorts so that lowest pattern type then longest path come first.

Specified by:

compare in interface Comparator

toString

public String toString()

Overrides:

toString in class Object