com.boomi.restlet

Class RestletUtil

java.lang.Object

com.boomi.restlet.RestletUtil

public class RestletUtil
extends Object

Utilities for working with restlets.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_HEADERS the attribute key for the HTTP headers in a restlet request
static List<String>	FORMAT_RFC_822_Z Common date formats (RFC 822).

Method Summary

Modifier and Type	Method and Description
static String	getHttpHeader(org.restlet.data.Message msg, String headerName) Returns the HTTP header with the given name from the given msg.
static String	getHttpHeader(org.restlet.data.Message msg, String headerName, String defaultValue) Returns the HTTP header with the given name from the given msg.
static String	getHttpHeader(org.restlet.data.Request request, String headerName) Returns the HTTP header with the given name from the given request.
static String	getHttpHeader(org.restlet.data.Request request, String headerName, String defaultValue) Returns the HTTP header with the given name from the given request.
static String	getHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers, String headerName) Returns the HTTP header with the given name from the given header list.
static String	getHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers, String headerName, String defaultValue) Returns the HTTP header with the given name from the given header list.
static org.restlet.util.Series<org.restlet.data.Parameter>	getHttpHeaders(org.restlet.data.Message msg) Returns the HTTP headers from the given msg.
static org.restlet.util.Series<org.restlet.data.Parameter>	getHttpHeaders(org.restlet.data.Request request) Returns the HTTP headers from the given request.
static org.restlet.util.Series<org.restlet.data.Parameter>	getHttpHeadersForUpdate(org.restlet.data.Message msg) Returns the HTTP headers from the given message, adding a new headers collection if none is found.
static org.restlet.util.Series<org.restlet.data.Parameter>	getHttpHeadersForUpdate(org.restlet.data.Request request) Returns the HTTP headers from the given request, adding a new headers collection if none is found.
static void	setHttpHeader(org.restlet.data.Message msg, String headerName, String value) Sets the HTTP header with the given name to the given value in the given message.
static void	setHttpHeader(org.restlet.data.Request request, String headerName, String value) Sets the HTTP header with the given name to the given value in the given request.
static void	setHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers, String headerName, String value) Sets the HTTP header with the given name to the given value in the given header list (and removes any other header with the same name).

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_HEADERS

public static final String ATTRIBUTE_HEADERS

the attribute key for the HTTP headers in a restlet request

See Also:

Constant Field Values

FORMAT_RFC_822_Z

public static final List<String> FORMAT_RFC_822_Z

Common date formats (RFC 822).

Method Detail

getHttpHeaders

public static org.restlet.util.Series<org.restlet.data.Parameter> getHttpHeaders(org.restlet.data.Request request)

Returns the HTTP headers from the given request.

Parameters:

request - the restlet request

Returns:

HTTP headers, may be null

getHttpHeaders

public static org.restlet.util.Series<org.restlet.data.Parameter> getHttpHeaders(org.restlet.data.Message msg)

Returns the HTTP headers from the given msg.

Parameters:

msg - the restlet message (e.g. a Request or Response)

Returns:

HTTP headers, may be null

getHttpHeadersForUpdate

public static org.restlet.util.Series<org.restlet.data.Parameter> getHttpHeadersForUpdate(org.restlet.data.Request request)

Returns the HTTP headers from the given request, adding a new headers collection if none is found.

Parameters:

request - the restlet request

Returns:

HTTP headers, will not be null

getHttpHeadersForUpdate

public static org.restlet.util.Series<org.restlet.data.Parameter> getHttpHeadersForUpdate(org.restlet.data.Message msg)

Returns the HTTP headers from the given message, adding a new headers collection if none is found.

Parameters:

msg - the restlet message

Returns:

HTTP headers, will not be null

getHttpHeader

public static String getHttpHeader(org.restlet.data.Request request,
                                   String headerName)

Returns the HTTP header with the given name from the given request.

Parameters:

request - restlet request

headerName - the name of the desired header

Returns:

the header value (trimmed) if non-blank, null otherwise

getHttpHeader

public static String getHttpHeader(org.restlet.data.Request request,
                                   String headerName,
                                   String defaultValue)

Returns the HTTP header with the given name from the given request.

Parameters:

request - restlet request

headerName - the name of the desired header

defaultValue - the defaultValue if the header value is blank

Returns:

the header value (trimmed) if non-blank, defaultValue otherwise

getHttpHeader

public static String getHttpHeader(org.restlet.data.Message msg,
                                   String headerName)

Returns the HTTP header with the given name from the given msg.

Parameters:

msg - restlet message (e.g. a Request or Response)

headerName - the name of the desired header

Returns:

the header value (trimmed) if non-blank, null otherwise

getHttpHeader

public static String getHttpHeader(org.restlet.data.Message msg,
                                   String headerName,
                                   String defaultValue)

Returns the HTTP header with the given name from the given msg.

Parameters:

msg - restlet message (e.g. a Request or Response)

headerName - the name of the desired header

defaultValue - the defaultValue if the header value is blank

Returns:

the header value (trimmed) if non-blank, defaultValue otherwise

getHttpHeader

public static String getHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers,
                                   String headerName)

Returns the HTTP header with the given name from the given header list.

Parameters:

headers - restlet header list (may be null)

headerName - the name of the desired header

Returns:

the header value (trimmed) if non-blank, null otherwise

getHttpHeader

public static String getHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers,
                                   String headerName,
                                   String defaultValue)

Returns the HTTP header with the given name from the given header list.

Parameters:

headers - restlet header list (may be null)

headerName - the name of the desired header

defaultValue - the defaultValue if the header value is blank

Returns:

the header value (trimmed) if non-blank, defaultValue otherwise

setHttpHeader

public static void setHttpHeader(org.restlet.data.Request request,
                                 String headerName,
                                 String value)

Sets the HTTP header with the given name to the given value in the given request.

Parameters:

request - restlet request

headerName - the name of the header to modify

value - the new header value

setHttpHeader

public static void setHttpHeader(org.restlet.data.Message msg,
                                 String headerName,
                                 String value)

Sets the HTTP header with the given name to the given value in the given message.

Parameters:

msg - restlet message

headerName - the name of the header to modify

value - the new header value

setHttpHeader

public static void setHttpHeader(org.restlet.util.Series<org.restlet.data.Parameter> headers,
                                 String headerName,
                                 String value)

Sets the HTTP header with the given name to the given value in the given header list (and removes any other header with the same name).

Parameters:

headers - restlet header list (may not be null)

headerName - the name of the header to modify

value - the new header value