org.apache.juneau.rest

Class RequestPathMatch

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<String,String>

org.apache.juneau.rest.RequestPathMatch

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>, NavigableMap<String,String>, SortedMap<String,String>

public class RequestPathMatch
extends TreeMap<String,String>

Contains information about the matched path on the HTTP request.

Provides access to the matched path variables and path match remainder.

See Also:

• Overview > juneau-rest-server > RequestPathMatch

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Modifier and Type	Method and Description
<T> T	get(HttpPartParser parser, String name, Class<T> type) Same as get(String, Class) but allows you to override the part parser.
<T> T	get(HttpPartParser parser, String name, Type type, Type... args) Same as get(String, Type, Type...) but allows you to override the part parser.
<T> T	get(String name, Class<T> type) Returns the specified path parameter value converted to a POJO using the HttpPartParser registered with the resource.
<T> T	get(String name, Type type, Type... args) Returns the specified query parameter value converted to a POJO using the HttpPartParser registered with the resource.
boolean	getBoolean(String name) Returns the specified path parameter converted to a boolean.
int	getInt(String name) Returns the specified path parameter converted to an integer.
String	getPattern() Returns the path pattern that matched this request.
String	getRemainder() Returns the decoded remainder of the URL following any path pattern matches.
String	getRemainderUndecoded() Same as getRemainder() but doesn't decode characters.
String	getString(String name) Returns the specified path parameter converted to a String.
void	put(String name, Object value) Sets a request query parameter value.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Method Detail

put

public void put(String name,
                Object value)

Sets a request query parameter value.

Parameters:

name - The parameter name.

value - The parameter value.

getString

public String getString(String name)
                 throws ParseException

Returns the specified path parameter converted to a String.

Parameters:

name - The path variable name.

Returns:

The parameter value.

Throws:

ParseException

getInt

public int getInt(String name)
           throws ParseException

Returns the specified path parameter converted to an integer.

Parameters:

name - The path variable name.

Returns:

The parameter value.

Throws:

ParseException

getBoolean

public boolean getBoolean(String name)
                   throws ParseException

Returns the specified path parameter converted to a boolean.

Parameters:

name - The path variable name.

Returns:

The parameter value.

Throws:

ParseException

get

public <T> T get(String name,
                 Class<T> type)
          throws ParseException

Returns the specified path parameter value converted to a POJO using the HttpPartParser registered with the resource.

Examples:

// Parse into an integer. int myparam = path.get("myparam", int.class); // Parse into an int array. int[] myparam = path.get("myparam", int[].class); // Parse into a bean. MyBean myparam = path.get("myparam", MyBean.class); // Parse into a linked-list of objects. List myparam = path.get("myparam", LinkedList.class); // Parse into a map of object keys/values. Map myparam = path.get("myparam", TreeMap.class);

See Also:

• RestContext.REST_partParser

Type Parameters:

T - The class type to convert the attribute value to.

Parameters:

name - The attribute name.

type - The class type to convert the attribute value to.

Returns:

The attribute value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(HttpPartParser parser,
                 String name,
                 Class<T> type)
          throws ParseException

Same as get(String, Class) but allows you to override the part parser.

Type Parameters:

T - The class type to convert the attribute value to.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The attribute name.

type - The class type to convert the attribute value to.

Returns:

The attribute value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(String name,
                 Type type,
                 Type... args)
          throws ParseException

Returns the specified query parameter value converted to a POJO using the HttpPartParser registered with the resource.

Similar to get(String,Class) but allows for complex collections of POJOs to be created.

Use this method if you want to parse into a parameterized Map/Collection object.

Examples:

// Parse into a linked-list of strings. List<String> myparam = req.getPathParameter("myparam", LinkedList.class, String.class); // Parse into a linked-list of linked-lists of strings. List<List<String>> myparam = req.getPathParameter("myparam", LinkedList.class, LinkedList.class, String.class); // Parse into a map of string keys/values. Map<String,String> myparam = req.getPathParameter("myparam", TreeMap.class, String.class, String.class); // Parse into a map containing string keys and values of lists containing beans. Map<String,List<MyBean>> myparam = req.getPathParameter("myparam", TreeMap.class, String.class, List.class, MyBean.class);

Notes:

• Collections must be followed by zero or one parameter representing the value type.
• Maps must be followed by zero or two parameters representing the key and value types.

See Also:

• RestContext.REST_partParser

Type Parameters:

T - The class type to convert the attribute value to.

Parameters:

name - The attribute name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The attribute value converted to the specified class type.

Throws:

ParseException

get

public <T> T get(HttpPartParser parser,
                 String name,
                 Type type,
                 Type... args)
          throws ParseException

Same as get(String, Type, Type...) but allows you to override the part parser.

Type Parameters:

T - The class type to convert the attribute value to.

Parameters:

parser - The parser to use for parsing the string value.
If null, uses the part parser defined on the resource/method.

name - The attribute name.

type - The type of object to create.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The attribute value converted to the specified class type.

Throws:

ParseException

getRemainder

public String getRemainder()

Returns the decoded remainder of the URL following any path pattern matches.

The behavior of path remainder is shown below given the path pattern "/foo/*":

URL	Path Remainder
/foo	null
/foo/	""
/foo//	"/"
/foo///	"//"
/foo/a/b	"a/b"
/foo//a/b/	"/a/b/"
/foo/a%2Fb	"a/b"

Example:

// REST method @RestMethod(name=GET,path="/foo/{bar}/*") public String doGetById(RequestPathMatch path, int bar) { return path.getRemainder(); }

Returns:

The path remainder string.

getRemainderUndecoded

public String getRemainderUndecoded()

Same as getRemainder() but doesn't decode characters.

Returns:

The un-decoded path remainder.

getPattern

public String getPattern()

Returns the path pattern that matched this request.

Returns:

The path pattern that matched this request.