com.wealdtech.hawk

Class HawkClient

java.lang.Object

com.wealdtech.hawk.HawkClient

All Implemented Interfaces:

java.lang.Comparable<HawkClient>

public final class HawkClient
extends java.lang.Object
implements java.lang.Comparable<HawkClient>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HawkClient.Builder

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(HawkClient that)
boolean	equals(java.lang.Object that)
java.lang.String	generateAuthorizationHeader(java.net.URI uri, java.lang.String method, java.lang.String hash, java.lang.String ext, java.lang.String app, java.lang.String dlg) Generate the value for the Hawk authorization header.
int	hashCode()
boolean	isValidFor(java.lang.String path)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

generateAuthorizationHeader

public java.lang.String generateAuthorizationHeader(java.net.URI uri,
                                           java.lang.String method,
                                           java.lang.String hash,
                                           java.lang.String ext,
                                           java.lang.String app,
                                           java.lang.String dlg)

Generate the value for the Hawk authorization header.

Parameters:

uri - the URI for the request

method - the request for the method

hash - a hash of the request's payload, or null if payload authentication is not required

ext - extra data, or null if none

app - application ID, or null if none

dlg - delegator, or null if none

Returns:

The value for the Hawk authorization header.

Throws:

com.wealdtech.DataError - If there is a problem with the data passed in which makes it impossible to generate a valid authorization header

isValidFor

public boolean isValidFor(java.lang.String path)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(HawkClient that)

Specified by:

compareTo in interface java.lang.Comparable<HawkClient>