net.adamcin.httpsig.api

Class RequestContent

java.lang.Object

net.adamcin.httpsig.api.RequestContent

All Implemented Interfaces:

java.io.Serializable

public final class RequestContent
extends java.lang.Object
implements java.io.Serializable

Object used to pass per-request context, such as Request Line and HTTP Headers in client/server implementation-independent way.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestContent.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_FORMAT Deprecated.
static java.lang.String	DATE_FORMAT_RFC1123

Method Summary

Modifier and Type	Method and Description
byte[]	getBytesToSign(java.util.List<java.lang.String> headers, java.nio.charset.Charset charset) Returns the request content as a byte array for generating a signature.
byte[]	getContent(java.util.List<java.lang.String> headers, java.nio.charset.Charset charset) Deprecated. use getBytesToSign(List, Charset) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content
java.lang.String	getContentString(java.util.List<java.lang.String> headers) Deprecated. use getStringToSign(List) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content
java.lang.String	getDate()
java.util.Date	getDateGMT() Returns the currently set date header value converted to a Date object in the GMT time zone
java.util.Calendar	getDateTZ(java.util.TimeZone timeZone) Returns the currently set date header value converted to a Calendar in the specified timeZone, or in the default timeZone if the parameter is null
java.util.List<java.lang.String>	getHeaderNames()
java.util.List<java.lang.String>	getHeaderValues(java.lang.String name)
java.lang.String	getRequestLine() Deprecated.
java.lang.String	getRequestTarget()
java.lang.String	getStringToSign(java.util.List<java.lang.String> headers) Returns the request content as a String for generating a signature.
java.lang.String	toString()
protected static java.util.Date	tryParseDate(java.lang.String date) Sets the literal date header value.

Methods inherited from class java.lang.Object

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

Field Detail

DATE_FORMAT

@Deprecated
public static final java.lang.String DATE_FORMAT

Deprecated.

The official format of the Date header value (and other date-type headers) is defined by RFC 1123 (DATE_FORMAT_RFC1123)

See Also:

Constant Field Values

DATE_FORMAT_RFC1123

public static final java.lang.String DATE_FORMAT_RFC1123

See Also:

Constant Field Values

Method Detail

getContent

@Deprecated
public byte[] getContent(java.util.List<java.lang.String> headers,
                                     java.nio.charset.Charset charset)

Deprecated. use getBytesToSign(List, Charset) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content

Returns the signature content as a byte array

Parameters:

headers - the list of headers to be included in the signed content

charset - charset for decoding the content

Returns:

the result of getContentString(java.util.List) encoded using the provided Charset

getContentString

@Deprecated
public java.lang.String getContentString(java.util.List<java.lang.String> headers)

Deprecated. use getStringToSign(List) to include the Constants.HEADER_REQUEST_TARGET prefix in signature content

Returns the signature content as a String

Parameters:

headers - the list of headers to be included in the signed content

Returns:

formatted content to be signed

getStringToSign

public java.lang.String getStringToSign(java.util.List<java.lang.String> headers)

Returns the request content as a String for generating a signature.

Parameters:

headers - the list of headers to be included in the signed content

Returns:

formatted content to be signed

getBytesToSign

public byte[] getBytesToSign(java.util.List<java.lang.String> headers,
                             java.nio.charset.Charset charset)

Returns the request content as a byte array for generating a signature.

Parameters:

headers - the list of headers to be included in the signed content

charset - charset for decoding the content

Returns:

the result of getStringToSign(List) encoded using the provided Charset

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHeaderNames

public java.util.List<java.lang.String> getHeaderNames()

Returns:

the list of header names contained in this RequestContent, in the order in which they were added, except for request-target, which is listed first if present

getRequestLine

@Deprecated
public java.lang.String getRequestLine()

Deprecated.

Returns:

the request-line if set

getRequestTarget

public java.lang.String getRequestTarget()

Returns:

the request-target if set

getDate

public java.lang.String getDate()

Returns:

the first date header value if set, null if not

getHeaderValues

public java.util.List<java.lang.String> getHeaderValues(java.lang.String name)

Parameters:

name - the name of the header

Returns:

the list of values for the given header name, or an empty list if no values have been added.

tryParseDate

protected static java.util.Date tryParseDate(java.lang.String date)

Sets the literal date header value.

Parameters:

date - a date string conforming to DATE_FORMAT_RFC1123 or to the deprecated DATE_FORMAT

Returns:

true if the date header was set successfully. false if the header is already set or the provided string does not conform to DATE_FORMAT_RFC1123 or to DATE_FORMAT

getDateGMT

public java.util.Date getDateGMT()

Returns the currently set date header value converted to a Date object in the GMT time zone

Returns:

a Date object in GMT or null if header is not set or not valid

getDateTZ

public java.util.Calendar getDateTZ(java.util.TimeZone timeZone)

Returns the currently set date header value converted to a Calendar in the specified timeZone, or in the default timeZone if the parameter is null

Parameters:

timeZone - some time zone or null to convert to the default time zone

Returns:

a Calendar in the specified time zone or in the default time zone if the timeZone parameter is null