net.adamcin.httpsig.api

Class SignatureBuilder

java.lang.Object

net.adamcin.httpsig.api.SignatureBuilder

All Implemented Interfaces:

Serializable

public final class SignatureBuilder
extends Object
implements 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
SignatureBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDate(Calendar calendar) IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate().
boolean	addDate(Date dateGMT) IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate().
boolean	addDateNow() IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate().
boolean	addHeader(String name, String value) Adds a header name and value pair
byte[]	buildContent(List<String> headers, Charset charset) Returns the signature content as a byte array
String	buildString(List<String> headers) Returns the signature content as a String
String	getDate()
Date	getDateGMT() Returns the currently set date header value converted to a Date object in the GMT time zone
Calendar	getDateTZ(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
List<String>	getHeaderNames()
List<String>	getHeaderValues(String name)
String	getRequestLine()
boolean	setRequestLine(String requestLine)
String	toString()
boolean	tryParseDate(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

public static final String DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

SignatureBuilder

public SignatureBuilder()

Method Detail

buildContent

public byte[] buildContent(List<String> headers,
                  Charset charset)

Returns the signature content as a byte array

Parameters:

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

Returns:

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

buildString

public String buildString(List<String> headers)

Returns the signature content as a String

Parameters:

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

Returns:

toString

public String toString()

Overrides:

toString in class Object

getHeaderNames

public List<String> getHeaderNames()

Returns:

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

setRequestLine

public boolean setRequestLine(String requestLine)

addHeader

public boolean addHeader(String name,
                String value)

Adds a header name and value pair

Parameters:

name -

value -

Returns:

getRequestLine

public String getRequestLine()

Returns:

the request-line if set

getDate

public String getDate()

Returns:

the first date header value if set, null if not

getHeaderValues

public List<String> getHeaderValues(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

public boolean tryParseDate(String date)

Sets the literal date header value.

Parameters:

date - a date string conforming to 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

addDate

public boolean addDate(Calendar calendar)

IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate(). This is merely a convenience method to generate a date header in the correct format.

Parameters:

calendar - the Calendar to provide

Returns:

true if the date header was successfully set. false if date is already set

addDate

public boolean addDate(Date dateGMT)

IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate(). This is merely a convenience method to generate a date header in the correct format.

Parameters:

dateGMT - the current date in GMT

Returns:

true if the date header was successfully set. false if date is already set

addDateNow

public boolean addDateNow()

IMPORTANT: If you call this overload instead of addHeader(String, String), be sure to retrieve the generated header value to add to your client request using a subsequent call to getDate(). This is merely a convenience method to generate a date header in the correct format.

Returns:

true if the date header was successfully set. false if date is already set

getDateGMT

public 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 Calendar getDateTZ(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