org.jaxrx.core

Class ResourcePath

java.lang.Object

org.jaxrx.core.ResourcePath

public final class ResourcePath
extends Object

This class contains information on the resource path and query parameters of a JAX-RX request.

Author:

Sebastian Graf, Christian Gruen, Lukas Lewandowski, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
ResourcePath(String resourcePath) Constructs a new ResourcePath.
ResourcePath(String resourcePath, javax.ws.rs.core.HttpHeaders httpHeaders) Constructs a new ResourcePath with an additional QueryParameter map.
ResourcePath(String resourcePath, Map<QueryParameter,String> queryParameters) Constructs a new ResourcePath with an additional QueryParameter map.
ResourcePath(String resourcePath, Map<QueryParameter,String> queryParameters, javax.ws.rs.core.HttpHeaders httpHeaders) Constructs a new ResourcePath with an additional QueryParameter map.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDepth() Returns the depth of the resource path.
javax.ws.rs.core.HttpHeaders	getHttpHeaders() Return HTTP headers from user request.
Map<QueryParameter,String>	getQueryParameter() This map return all available query parameters.
String	getResource(int level) Returns the resource at the specified level.
String	getResourcePath() Returns the complete resource path string.
String	getValue(QueryParameter key) Returns the value of the specified query parameter, or null if no value is mapped.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcePath

public ResourcePath(String resourcePath)

Constructs a new ResourcePath.

Parameters:

resourcePath - resource path string

ResourcePath

public ResourcePath(String resourcePath,
            Map<QueryParameter,String> queryParameters)

Constructs a new ResourcePath with an additional QueryParameter map.

Parameters:

resourcePath - resource path string

queryParameters - query parameters

ResourcePath

public ResourcePath(String resourcePath,
            javax.ws.rs.core.HttpHeaders httpHeaders)

Constructs a new ResourcePath with an additional QueryParameter map.

Parameters:

resourcePath - resource path string

httpHeaders - HTTP header attributes.

ResourcePath

public ResourcePath(String resourcePath,
            Map<QueryParameter,String> queryParameters,
            javax.ws.rs.core.HttpHeaders httpHeaders)

Constructs a new ResourcePath with an additional QueryParameter map.

Parameters:

resourcePath - resource path string

queryParameters - query parameters

httpHeaders - HTTP header attributes.

Method Detail

getResourcePath

public String getResourcePath()

Returns the complete resource path string.

Returns:

resource path string

getResource

public String getResource(int level)

Returns the resource at the specified level.

Parameters:

level - resource level

Returns:

resource

getDepth

public int getDepth()

Returns the depth of the resource path.

Returns:

resource depth

getValue

public String getValue(QueryParameter key)

Returns the value of the specified query parameter, or null if no value is mapped.

Parameters:

key - query key

Returns:

value

getQueryParameter

public Map<QueryParameter,String> getQueryParameter()

This map return all available query parameters.

Returns:

The parameter map.

getHttpHeaders

public javax.ws.rs.core.HttpHeaders getHttpHeaders()

Return HTTP headers from user request.

Returns:

HTTP headers.

toString

public String toString()

Overrides:

toString in class Object