com.wealdtech.hawk

Class HawkServer

java.lang.Object

com.wealdtech.hawk.HawkServer

All Implemented Interfaces:

java.lang.Comparable<HawkServer>

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

The Hawk server. Note that this is not an HTTP server in itself, but provides the backbone of any Hawk implementation within an HTTP server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HawkServer.Builder

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(HawkCredentials credentials, java.net.URI uri) Authenticate a request using a Hawk bewit.
void	authenticate(HawkCredentials credentials, java.net.URI uri, java.lang.String method, com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> authorizationHeaders, java.lang.String hash, boolean hasBody) Authenticate a request using Hawk.
int	compareTo(HawkServer that)
boolean	equals(java.lang.Object that)
java.lang.String	extractBewit(java.net.URI uri) Extract a bewit from a URI.
java.lang.String	generateAuthenticateHeader() Generate text for a WWW-Authenticate header after a failed authentication.
int	hashCode()
com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	splitAuthorizationHeader(java.lang.String authorizationheader)
com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	splitBewit(java.lang.String bewit) Split a base64-encoded bewit into individual fields.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

authenticate

public void authenticate(HawkCredentials credentials,
                java.net.URI uri,
                java.lang.String method,
                com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> authorizationHeaders,
                java.lang.String hash,
                boolean hasBody)

Authenticate a request using Hawk.

Parameters:

credentials - the Hawk credentials against which to authenticate

uri - the URI of the request

method - the method of the request

authorizationHeaders - the Hawk authentication headers

hash - the hash of the body, if available

hasBody - true if the request has a body, false if not

authenticate

public void authenticate(HawkCredentials credentials,
                java.net.URI uri)

Authenticate a request using a Hawk bewit.

Parameters:

credentials - the Hawk credentials against which to authenticate

uri - the URI of the request

generateAuthenticateHeader

public java.lang.String generateAuthenticateHeader()

Generate text for a WWW-Authenticate header after a failed authentication.

Note that this generates the header's contents, and not the header itself.

Returns:

text suitable for placement in a WWW-Authenticate header

splitAuthorizationHeader

public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> splitAuthorizationHeader(java.lang.String authorizationheader)

splitBewit

public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> splitBewit(java.lang.String bewit)

Split a base64-encoded bewit into individual fields.

Parameters:

bewit - the base64-encoded bewit

Returns:

A map of bewit parameters

Throws:

com.wealdtech.DataError - If the bewit is invalid in some way

extractBewit

public java.lang.String extractBewit(java.net.URI uri)

Extract a bewit from a URI.

Parameters:

uri - the URI from which to pull the bewit

Returns:

The bewit

Throws:

com.wealdtech.DataError - if there is an issue with the data that prevents obtaining the bewit

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(HawkServer that)

Specified by:

compareTo in interface java.lang.Comparable<HawkServer>