org.safs.rest.service

Class Headers

java.lang.Object

org.safs.rest.service.Headers

public class Headers
extends java.lang.Object

Provides for storing header Collections for predefined AND custom request types.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT
static java.lang.String	APPL_JAVASCRIPT
static java.lang.String	APPL_JSON
static java.lang.String	APPL_OCTET_STREAM
static java.lang.String	APPL_XML
static java.lang.String	BINARY_TYPE
static java.lang.String	CONTENT_TYPE
static java.lang.String	CSS_TYPE
static java.lang.String	HTML_TYPE
static java.lang.String	IMAGE
static java.lang.String	IMAGE_TYPE
static java.lang.String	JSON_TYPE
static java.lang.String	MOZILLA_GENERIC_AGENT
static java.lang.String	SCRIPT_TYPE
static java.lang.String	TEXT_CSS
static java.lang.String	TEXT_HTML
static java.lang.String	TEXT_PLAIN
static java.lang.String	TEXT_TYPE
static java.lang.String	TEXT_XML XML has two MIME types,application/xml and text/xml .
static java.lang.String	USER_AGENT
static java.lang.String	XML_TYPE

Constructor Summary

Constructors

Constructor and Description
Headers()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addHeadersForType(java.lang.String type, java.lang.String headerStr) Add one (or more) headers to the existing set of headers for the mapped type.
static java.lang.String	appendHeaderValue(java.lang.String headers, java.lang.String headerName, java.lang.String headerValue) Given a multi-line header String, append a header value to an existing header name, or create the new header with the given value.
static java.lang.String	convertHeadersMapToMultiLineString(java.util.Map<java.lang.String,java.lang.String> headerMap)
static java.util.Map<java.lang.String,java.lang.String>	convertHeadersMultiLineStringToMap(java.lang.String headers)
static java.lang.String	getBinaryHeaders() Will lazily create the default headers for this type if they don't already exist.
static java.lang.String	getCSSHeaders()
static java.lang.String	getHeader(java.lang.String headers, java.lang.String name)
static java.lang.String	getHeadersForType(java.lang.String type) Returns the headers currently set for a defined resource/request type as a multi-line String.
(package private) static java.util.Map<java.lang.String,java.lang.String>	getHeadersMapFromMultiLineString(java.lang.String headers) Utility method to convert headers multi-line string to a Map
static java.lang.String	getHtmlHeaders()
static java.lang.String	getImageHeaders()
static java.lang.String	getJSONHeaders()
static java.lang.String	getScriptHeaders()
static java.lang.String	getTextHeaders()
static java.lang.String	getXMLHeaders()
static void	loadHeaders(RuntimeDataInterface runtime, java.lang.String headersFile, java.lang.String method, java.lang.String type)
static java.lang.String	removeHeadersForType(java.lang.String type, java.lang.String headerStr) Remove one (or more) header(s) from the existing headers for the mapped type.
static java.lang.String	removeHeaderValue(java.lang.String headers, java.lang.String headerName, java.lang.String headerValue) Given a multi-line header String, remove a header value from an existing header name, or create the new header without the given value.
static void	resetHeaders()
static void	setBinaryHeaders(java.lang.String _binaryHeaders)
static void	setCSSHeaders(java.lang.String _cssHeaders)
static void	setHeadersForType(java.lang.String type, java.lang.String headerStr) Wholesale set/replace the headers multi-line String to be used for a predefined or custom resource/request type.
static void	setHtmlHeaders(java.lang.String _htmlHeaders)
static void	setImageHeaders(java.lang.String _imageHeaders)
static void	setJSONHeaders(java.lang.String _jsonHeaders)
static void	setScriptHeaders(java.lang.String _scriptHeaders)
static void	setTextHeaders(java.lang.String _textHeaders)
static void	setXMLHeaders(java.lang.String _xmlHeaders)

Methods inherited from class java.lang.Object

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

Field Detail

BINARY_TYPE

public static final java.lang.String BINARY_TYPE

See Also:

Constant Field Values

JSON_TYPE

public static final java.lang.String JSON_TYPE

See Also:

Constant Field Values

TEXT_TYPE

public static final java.lang.String TEXT_TYPE

See Also:

Constant Field Values

XML_TYPE

public static final java.lang.String XML_TYPE

See Also:

Constant Field Values

HTML_TYPE

public static final java.lang.String HTML_TYPE

See Also:

Constant Field Values

IMAGE_TYPE

public static final java.lang.String IMAGE_TYPE

See Also:

Constant Field Values

CSS_TYPE

public static final java.lang.String CSS_TYPE

See Also:

Constant Field Values

SCRIPT_TYPE

public static final java.lang.String SCRIPT_TYPE

See Also:

Constant Field Values

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

ACCEPT

public static final java.lang.String ACCEPT

See Also:

Constant Field Values

USER_AGENT

public static final java.lang.String USER_AGENT

See Also:

Constant Field Values

APPL_OCTET_STREAM

public static final java.lang.String APPL_OCTET_STREAM

See Also:

Constant Field Values

APPL_JSON

public static final java.lang.String APPL_JSON

See Also:

Constant Field Values

TEXT_PLAIN

public static final java.lang.String TEXT_PLAIN

See Also:

Constant Field Values

TEXT_XML

public static final java.lang.String TEXT_XML

XML has two MIME types,application/xml and text/xml . These are often used interchangeably, but there is a subtle difference which is why application/xml is generally recommended over the latter. Let me explain why: according to the standard, text/* -MIME types have a us-ascii character set unless otherwise specified in the HTTP headers (Content-type: text/xml; charset=utf-8). This effectively means that any encoding defined in the XML prolog (e.g. ) is ignored. This is of course not the expected and desired behavior. To further complicate matters, most/all browser implementations actually implement nonstandard behavior for text/xml because they process the encoding as if it were application/xml. So, text/* has encoding issues, and is not implemented by browsers in a standards-compliant manner, which is why using application/* is recommended.

See Also:

Constant Field Values

APPL_XML

public static final java.lang.String APPL_XML

See Also:

Constant Field Values

TEXT_HTML

public static final java.lang.String TEXT_HTML

See Also:

Constant Field Values

IMAGE

public static final java.lang.String IMAGE

See Also:

Constant Field Values

TEXT_CSS

public static final java.lang.String TEXT_CSS

See Also:

Constant Field Values

APPL_JAVASCRIPT

public static final java.lang.String APPL_JAVASCRIPT

See Also:

Constant Field Values

MOZILLA_GENERIC_AGENT

public static final java.lang.String MOZILLA_GENERIC_AGENT

See Also:

Constant Field Values

Constructor Detail

Headers

public Headers()

Method Detail

getHeadersForType

public static java.lang.String getHeadersForType(java.lang.String type)

Returns the headers currently set for a defined resource/request type as a multi-line String.

There are predefined request resource/request headers that can be retrieved and even changed. The user is also able to retrieve custom headers previously stored using a custom type.

Ex:

Parameters:

type -

Returns:

See Also:

#setHeadersForType(String,Collection), #addHeaderForType(String, String), #removeHeaderForType(String, String)

setHeadersForType

public static void setHeadersForType(java.lang.String type,
                                     java.lang.String headerStr)

Wholesale set/replace the headers multi-line String to be used for a predefined or custom resource/request type. If the provided String is null then the headers mapped to the type and the type entry will be removed.

Parameters:

type -

headerStr - Multi-line String containing the HTTP header(s)

Throws:

java.io.IOException

org.apache.hc.core5.http.HttpException

See Also:

getHeadersForType(String), #addHeaderForType(String, String), #removeHeaderForType(String, String)

addHeadersForType

public static java.lang.String addHeadersForType(java.lang.String type,
                                                 java.lang.String headerStr)

Add one (or more) headers to the existing set of headers for the mapped type.

Parameters:

type -

headerStr - Multi-line String containing the HTTP headers

Returns:

Throws:

java.io.IOException

org.apache.hc.core5.http.HttpException

See Also:

setHeadersForType(String,String), getHeadersForType(String), #removeHeaderForType(String, String)

removeHeadersForType

public static java.lang.String removeHeadersForType(java.lang.String type,
                                                    java.lang.String headerStr)

Remove one (or more) header(s) from the existing headers for the mapped type.

Parameters:

type -

headerStr - Multi-line String containing the HTTP header(s)

Returns:

Throws:

java.io.IOException

org.apache.hc.core5.http.HttpException

See Also:

#setHeadersForType(String,Collection), getHeadersForType(String), #addHeaderForType(String, String)

getBinaryHeaders

public static java.lang.String getBinaryHeaders()

Will lazily create the default headers for this type if they don't already exist.

Returns:

the _binaryHeaders currently in use for all requests for Binary resources.

See Also:

#setBinaryHeaders(Collection)

setBinaryHeaders

public static void setBinaryHeaders(java.lang.String _binaryHeaders)

Parameters:

_binaryHeaders - the _binaryHeaders to set for all future requests for Binary resources.

See Also:

getBinaryHeaders()

getJSONHeaders

public static java.lang.String getJSONHeaders()

Returns:

the _jsonHeaders currently in use for all requests for JSON resources.

See Also:

#setJSONHeaders(Collection)

setJSONHeaders

public static void setJSONHeaders(java.lang.String _jsonHeaders)

Parameters:

_jsonHeaders - the _jsonHeaders to set for all future requests for JSON resources.

See Also:

getJSONHeaders()

getTextHeaders

public static java.lang.String getTextHeaders()

Returns:

the _textHeaders currently in use for all requests for Text resources.

See Also:

#setTextHeaders(Collection)

setTextHeaders

public static void setTextHeaders(java.lang.String _textHeaders)

Parameters:

_textHeaders - the _textHeaders to set for all future requests for Text resources.

See Also:

getTextHeaders()

getXMLHeaders

public static java.lang.String getXMLHeaders()

Returns:

the _xmlHeaders currently used for all requests for XML resources.

See Also:

#setXMLHeaders(Collection)

setXMLHeaders

public static void setXMLHeaders(java.lang.String _xmlHeaders)

Parameters:

_xmlHeaders - the _xmlHeaders to set for all future requests for XML resources.

See Also:

getXMLHeaders()

getHtmlHeaders

public static java.lang.String getHtmlHeaders()

Returns:

the _htmlHeaders currently used for all requests for Html resources.

See Also:

#setHtmlHeaders(Collection)

setHtmlHeaders

public static void setHtmlHeaders(java.lang.String _htmlHeaders)

Parameters:

_htmlHeaders - the _htmlHeaders to set for all future requests for Html resources.

See Also:

getHtmlHeaders()

getImageHeaders

public static java.lang.String getImageHeaders()

Returns:

the _imageHeaders currently used for all requests for Image resources.

See Also:

#setImageHeaders(Collection)

setImageHeaders

public static void setImageHeaders(java.lang.String _imageHeaders)

Parameters:

_imageHeaders - the _imageHeaders to set for all future requests for Image resources.

See Also:

getImageHeaders()

getCSSHeaders

public static java.lang.String getCSSHeaders()

Returns:

the _cssHeaders currently used for all requests for CSS resources.

See Also:

#setCSSHeaders(Collection)

setCSSHeaders

public static void setCSSHeaders(java.lang.String _cssHeaders)

Parameters:

_cssHeaders - the _cssHeaders to set for all future requests for CSS resources.

See Also:

getCSSHeaders()

getScriptHeaders

public static java.lang.String getScriptHeaders()

Returns:

the _scriptHeaders currently used for all requests for Script resources.

See Also:

#setScriptHeaders(Collection)

setScriptHeaders

public static void setScriptHeaders(java.lang.String _scriptHeaders)

Parameters:

_scriptHeaders - the _scriptHeaders to set for all future requests for Script resources.

See Also:

getScriptHeaders()

getHeader

public static java.lang.String getHeader(java.lang.String headers,
                                         java.lang.String name)

Parameters:

headers - String, The headers in string format

name - String, The name of header field, such as "Content-Type", "Accept" etc.

Returns:

String, The content of a header field.

convertHeadersMapToMultiLineString

public static java.lang.String convertHeadersMapToMultiLineString(java.util.Map<java.lang.String,java.lang.String> headerMap)

convertHeadersMultiLineStringToMap

public static java.util.Map<java.lang.String,java.lang.String> convertHeadersMultiLineStringToMap(java.lang.String headers)

getHeadersMapFromMultiLineString

static java.util.Map<java.lang.String,java.lang.String> getHeadersMapFromMultiLineString(java.lang.String headers)

Utility method to convert headers multi-line string to a Map

Parameters:

headers - Multi-line String containing complete header info

Returns:

Map of String

appendHeaderValue

public static java.lang.String appendHeaderValue(java.lang.String headers,
                                                 java.lang.String headerName,
                                                 java.lang.String headerValue)

Given a multi-line header String, append a header value to an existing header name, or create the new header with the given value.

Example: appendHeaderValue(headers, "Accept", "text/html");

This does NOT act on prestored headers, only the header String provided.

When appending, this routine will prefix the value with a separator.

Parameters:

headers - multi-line header string.

headerName - name of the header to be created or appended.

headerValue - value to add to the provided header name.

Returns:

multiline headers properly appended, or unmodified if invalid arguments are provided.

removeHeaderValue

public static java.lang.String removeHeaderValue(java.lang.String headers,
                                                 java.lang.String headerName,
                                                 java.lang.String headerValue)

Given a multi-line header String, remove a header value from an existing header name, or create the new header without the given value.

Example: removeHeaderValue(headers, "Accept", "text/html");

This does NOT act on prestored headers, only the header String provided.

When removing, this routine will attempt to fix any separators.

Parameters:

headers - multi-line header string.

headerName - name of the header to have a value removed.

headerValue - value to remove.

Returns:

multiline headers properly changed, or unmodified if invalid arguments are provided.

loadHeaders

public static void loadHeaders(RuntimeDataInterface runtime,
                               java.lang.String headersFile,
                               java.lang.String method,
                               java.lang.String type)
                        throws SAFSException

Throws:

SAFSException

resetHeaders

public static void resetHeaders()