org.springframework.extensions.surf.uri

Class UriUtils

java.lang.Object

org.springframework.extensions.surf.uri.UriUtils

public final class UriUtils
extends Object

Utility functions for dealing with URI and token replacement.

Author:

Kevin Roast

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	pattern

Method Summary

Methods

Modifier and Type	Method and Description
static List<Map<String,String>>	getTokenMaps(RequestContext context) Builds a list of all the maps that can be used for performing token substitution.
static String	relativeUri(String uri) Return the relative section of a URI from a complete URI
static String	replaceTokens(String s, RequestContext context, Pattern tokenPattern, Integer groupNumber, String missingTokenString) Replaces tokens in using all available properties built from the getTokenMaps() method.
static String	replaceUriTokens(String s, Map<String,String> tokens) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

pattern

public static Pattern pattern

Method Detail

getTokenMaps

public static List<Map<String,String>> getTokenMaps(RequestContext context)

Builds a list of all the maps that can be used for performing token substitution. The list will be populated as follows (assuming that each token map is available).

1. URI tokens
2. Request context parameters

3. Page URL arguments
4. Template URL arguments
5. Page properties
6. Template properties

Parameters:

context - The current RequestContext.

Returns:

List

replaceTokens

public static String replaceTokens(String s,
                   RequestContext context,
                   Pattern tokenPattern,
                   Integer groupNumber,
                   String missingTokenString)

Replaces tokens in using all available properties built from the getTokenMaps() method.

Parameters:

s - The String to replace the tokens in.

context - The current RequestContext

tokenPattern - An alternative token pattern to process (if null, uses the default)

groupNumber - The group number to use as the token key (if null, defaults to 1)

missingTokenString - TODO

Returns:

The String with all tokens replaced.

replaceUriTokens

public static String replaceUriTokens(String s,
                      Map<String,String> tokens)

Deprecated.

Helper to replace tokens in a string with values from a map of token->value. Token names in the string are delimited by '{' and '}' - the entire token name plus the delimiters are replaced by the value found in the supplied replacement map. If no replacement value is found for the token name, it is replaced by the empty string.

Parameters:

s - String to work on - cannot be null

tokens - Map of token name -> token value for replacements

Returns:

the replaced string or the original if no tokens found or a failure occurs

relativeUri

public static String relativeUri(String uri)

Return the relative section of a URI from a complete URI

Parameters:

uri - URI to process

Returns:

relative part of the URI