Package net.solarnetwork.security

Class SnsAuthorizationBuilder

java.lang.Object

net.solarnetwork.security.AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

net.solarnetwork.security.SnsAuthorizationBuilder

public class SnsAuthorizationBuilder
extends AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Builder for Authorization header values using the SolarNode Setup (SNS) authentication scheme.

This helper is designed with different communication protocols in mind, such as HTTP and STOMP, so the terms used are generic enough to apply in different contexts.

Since:

1.78

Version:

1.0

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEME_NAME	The authorization scheme name.
static final String	SIGNING_KEY_MESSAGE	The message used to sign the derived signing key.

Fields inherited from class net.solarnetwork.security.AbstractAuthorizationBuilder

AUTHORIZATION_COMPONENT_CREDENTIAL, AUTHORIZATION_COMPONENT_HEADERS, AUTHORIZATION_COMPONENT_SIGNATURE

Constructor Summary

Constructors

Constructor	Description
SnsAuthorizationBuilder(String identifier)	Construct with a credential.

Method Summary

Modifier and Type	Method	Description
protected String	computeCanonicalRequestMessage(String[] headerNames)	Compute the canonical request message.
SnsAuthorizationBuilder	date(Instant date)	Set the request date.
SnsAuthorizationBuilder	reset()	Reset all values to their defaults.
protected String	schemeName()	Get the authorization scheme name.
protected String	signingKeyMessageLiteral()	Get the signing key message.

Methods inherited from class net.solarnetwork.security.AbstractAuthorizationBuilder

appendContentSha256, appendHeaders, build, build, buildSignature, buildSignature, computeCanonicalRequestMessage, computeSignatureData, computeSigningKey, contentSha256, getContentSha256, getDate, getHeaders, getPath, getVerb, header, headers, headerValue, headerValues, host, path, saveSigningKey, signingKey, signingKeyHex, sortedHeaderNames, verb

Methods inherited from class java.lang.Object

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

Field Details

SCHEME_NAME

public static final String SCHEME_NAME

The authorization scheme name.

See Also:

• Constant Field Values

SIGNING_KEY_MESSAGE

public static final String SIGNING_KEY_MESSAGE

The message used to sign the derived signing key.

See Also:

• Constant Field Values

Constructor Details

SnsAuthorizationBuilder

public SnsAuthorizationBuilder(String identifier)

Construct with a credential.

The builder will be initialized and then reset() will be called so default values are configured.

Parameters:

identifier - the bearer's identifier, such as a token ID or username

Method Details

reset

public SnsAuthorizationBuilder reset()

Reset all values to their defaults.

All properties will be set to null except the following:

verb

will be set to GET

path

Will be set to /

date

will be set to the current time

signingKey

this value will not be changed

Overrides:

reset in class AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Returns:

The builder.

date

public SnsAuthorizationBuilder date(Instant date)

Set the request date.

This will also set the date header with the date's formatted value.

Overrides:

date in class AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Parameters:

date - the date to use, or null for the current system time via Instant.now(); will be truncated to second resolution

Returns:

this builder

signingKeyMessageLiteral

protected String signingKeyMessageLiteral()

Description copied from class: AbstractAuthorizationBuilder

Get the signing key message.

Specified by:

signingKeyMessageLiteral in class AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Returns:

the signing key message

schemeName

protected String schemeName()

Description copied from class: AbstractAuthorizationBuilder

Get the authorization scheme name.

Specified by:

schemeName in class AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Returns:

the scheme name

computeCanonicalRequestMessage

protected String computeCanonicalRequestMessage(String[] headerNames)

Description copied from class: AbstractAuthorizationBuilder

Compute the canonical request message.

Specified by:

computeCanonicalRequestMessage in class AbstractAuthorizationBuilder<SnsAuthorizationBuilder>

Parameters:

headerNames - the header names to include in the signature

Returns:

the canonical request message