org.apache.juneau

Class UriContext

java.lang.Object

org.apache.juneau.UriContext

@Bean
public class UriContext
extends Object

Represents a URL broken into authority/context-root/servlet-path/path-info parts.

A typical request against a URL takes the following form:

http://host:port/context-root/servlet-path/path-info | authority | context | resource | path | +--------------------------------------------------+

This class allows you to convert URL strings to absolute (e.g. "http://host:port/foo/bar") or root-relative (e.g. "/foo/bar") URLs.

Field Summary

Fields

Modifier and Type	Field and Description
String	authority
String	contextRoot
static UriContext	DEFAULT Default URI context.
String	parentPath
String	pathInfo
String	servletPath

Constructor Summary

Constructors

Constructor and Description
UriContext() Default constructor.
UriContext(String s) String constructor.
UriContext(String authority, String contextRoot, String servletPath, String pathInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAbsoluteAuthority() Returns the absolute URI of just the authority portion of this URI context.
String	getAbsoluteContextRoot() Returns the absolute URI of the context-root portion of this URI context.
String	getAbsolutePathInfo() Returns the absolute URI of the path portion of this URI context.
String	getAbsolutePathInfoParent() Returns the parent of the URL returned by getAbsolutePathInfo().
String	getAbsoluteServletPath() Returns the absolute URI of the resource portion of this URI context.
String	getAbsoluteServletPathParent() Returns the parent of the URL returned by getAbsoluteServletPath().
String	getRootRelativeContextRoot() Returns the root-relative URI of the context portion of this URI context.
String	getRootRelativePathInfo() Returns the root-relative URI of the path portion of this URI context.
String	getRootRelativePathInfoParent() Returns the parent of the URL returned by getRootRelativePathInfo().
String	getRootRelativeServletPath() Returns the root-relative URI of the resource portion of this URI context.
String	getRootRelativeServletPathParent() Returns the parent of the URL returned by getRootRelativeServletPath().
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final UriContext DEFAULT

Default URI context.

No information about authority, servlet-root, context-root, or path-info is known.

authority

public final String authority

contextRoot

public final String contextRoot

servletPath

public final String servletPath

pathInfo

public final String pathInfo

parentPath

public final String parentPath

Constructor Detail

UriContext

@BeanConstructor(properties="authority,contextRoot,servletPath,pathInfo")
public UriContext(String authority,
                                                                                            String contextRoot,
                                                                                            String servletPath,
                                                                                            String pathInfo)

Constructor.

Leading and trailing slashes are trimmed of all parameters.

Any parameter can be null. Blanks and nulls are equivalent.

Parameters:

authority - The authority portion of URL (e.g. "http://hostname:port")

contextRoot - The context root of the application (e.g. "/context-root", or "context-root")

servletPath - The servlet path (e.g. "/servlet-path", or "servlet-path")

pathInfo - The path info (e.g. "/path-info", or "path-info")

UriContext

public UriContext()

Default constructor.

All null values.

UriContext

public UriContext(String s)
           throws ParseException

String constructor.

Input string is a JSON object with the following format: {authority:'xxx',contextRoot:'xxx',servletPath:'xxx',pathInfo:'xxx'}

Parameters:

s - The input string.
Example: {authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}

Throws:

ParseException - If input string is not a valid JSON object.

Method Detail

getAbsoluteAuthority

public String getAbsoluteAuthority()

Returns the absolute URI of just the authority portion of this URI context.

Example: "http://hostname:port"

If the authority is null/empty, returns "/".

Returns:

The absolute URI of just the authority portion of this URI context. Never null.

getAbsoluteContextRoot

public String getAbsoluteContextRoot()

Returns the absolute URI of the context-root portion of this URI context.

Example: "http://hostname:port/context-root"

Returns:

The absolute URI of the context-root portion of this URI context. Never null.

getRootRelativeContextRoot

public String getRootRelativeContextRoot()

Returns the root-relative URI of the context portion of this URI context.

Example: "/context-root"

Returns:

The root-relative URI of the context portion of this URI context. Never null.

getAbsoluteServletPath

public String getAbsoluteServletPath()

Returns the absolute URI of the resource portion of this URI context.

Example: "http://hostname:port/context-root/servlet-path"

Returns:

The absolute URI of the resource portion of this URI context. Never null.

getRootRelativeServletPath

public String getRootRelativeServletPath()

Returns the root-relative URI of the resource portion of this URI context.

Example: "/context-root/servlet-path"

Returns:

The root-relative URI of the resource portion of this URI context. Never null.

getAbsoluteServletPathParent

public String getAbsoluteServletPathParent()

Returns the parent of the URL returned by getAbsoluteServletPath().

Returns:

The parent of the URL returned by getAbsoluteServletPath().

getRootRelativeServletPathParent

public String getRootRelativeServletPathParent()

Returns the parent of the URL returned by getRootRelativeServletPath().

Returns:

The parent of the URL returned by getRootRelativeServletPath().

getAbsolutePathInfo

public String getAbsolutePathInfo()

Returns the absolute URI of the path portion of this URI context.

Example: "http://hostname:port/context-root/servlet-path/path-info"

Returns:

The absolute URI of the path portion of this URI context. Never null.

getRootRelativePathInfo

public String getRootRelativePathInfo()

Returns the root-relative URI of the path portion of this URI context.

Example: "/context-root/servlet-path/path-info"

Returns:

The root-relative URI of the path portion of this URI context. Never null.

getAbsolutePathInfoParent

public String getAbsolutePathInfoParent()

Returns the parent of the URL returned by getAbsolutePathInfo().

Returns:

The parent of the URL returned by getAbsolutePathInfo().

getRootRelativePathInfoParent

public String getRootRelativePathInfoParent()

Returns the parent of the URL returned by getRootRelativePathInfo().

Returns:

The parent of the URL returned by getRootRelativePathInfo().

toString

public String toString()

Overrides:

toString in class Object