Package net.visma.autopay.http.signature

Class SignatureComponents.Builder

java.lang.Object

net.visma.autopay.http.signature.SignatureComponents.Builder

Enclosing class:

SignatureComponents

public static class SignatureComponents.Builder
extends Object

Builder class to build SignatureComponents objects

Method Summary

Modifier and Type	Method	Description
SignatureComponents.Builder	authority()	Adds an @authority derived component - the authority (host) of the target URI for a request
SignatureComponents.Builder	binaryWrappedHeader(String headerName)	Adds a single Binary-wrapped HTTP Field component
SignatureComponents.Builder	binaryWrappedTrailer(String trailerName)	Adds a single Binary-wrapped HTTP Field component for a trailer
SignatureComponents	build()	Constructs SignatureComponents object from this builder
SignatureComponents.Builder	dictionaryMember(String headerName, String dictionaryKey)	Adds a single Dictionary Structured Field Member component
SignatureComponents.Builder	header(String headerName)	Adds a single HTTP Field (header) component
SignatureComponents.Builder	headers(String... headerNames)	Adds multiple HTTP Field (header) components
SignatureComponents.Builder	headers(Collection<String> headerNames)	Adds multiple HTTP Field (header) components
SignatureComponents.Builder	method()	Adds a @method derived component - the method used for a request
SignatureComponents.Builder	path()	Adds a @path derived component - the absolute path portion of the target URI for a request
SignatureComponents.Builder	query()	Adds a @query derived component - the query portion of the target URI for a request
SignatureComponents.Builder	queryParam(String paramName)	Adds a @query-param derived component - a parsed query parameter of the target URI for a request
SignatureComponents.Builder	relatedRequestAuthority()	Adds an @authority derived component for Related Request - the authority (host) of the target URI for a request
SignatureComponents.Builder	relatedRequestBinaryWrappedHeader(String headerName)	Adds a single Binary-wrapped HTTP Field component for Related request
SignatureComponents.Builder	relatedRequestBinaryWrappedTrailer(String trailerName)	Adds a single Binary-wrapped HTTP Field component for a trailer from Related request
SignatureComponents.Builder	relatedRequestDictionaryMember(String headerName, String dictionaryKey)	Adds a single Dictionary Structured Field Member component for Related Request
SignatureComponents.Builder	relatedRequestHeader(String headerName)	Adds a single HTTP Field (header) component for Related Request (req, request that triggered generated response)
SignatureComponents.Builder	relatedRequestMethod()	Adds a @method derived component for Related Request - the method used for a request
SignatureComponents.Builder	relatedRequestPath()	Adds a @path derived component for Related Request - the absolute path portion of the target URI for a request
SignatureComponents.Builder	relatedRequestQuery()	Adds a @query derived component for Related Request - the query portion of the target URI for a request
SignatureComponents.Builder	relatedRequestQueryParam(String paramName)	Adds a @query-param derived component for Related Request - a parsed query parameter of the target URI for a request
SignatureComponents.Builder	relatedRequestRequestTarget()	Adds a @request-target derived component for Related Request
SignatureComponents.Builder	relatedRequestScheme()	Adds a @scheme derived component for Related Request - the scheme of the target URI for a request
SignatureComponents.Builder	relatedRequestStructuredHeader(String headerName)	Adds a single Structured Field (header) component for Related Request.
SignatureComponents.Builder	relatedRequestStructuredTrailer(String trailerName)	Adds a single Structured Field component for a trailer from Related Request.
SignatureComponents.Builder	relatedRequestTargetUri()	Adds a @target-uri derived component for Related Request - the full target URI for a request
SignatureComponents.Builder	relatedRequestTrailer(String trailerName)	Adds a single HTTP Field component for a trailed from Related Request (req, request that triggered generated response)
SignatureComponents.Builder	relatedRequestTrailerDictionaryMember(String trailerName, String dictionaryKey)	Adds a single Dictionary Structured Field Member component for a trailer from Related Request
SignatureComponents.Builder	requestTarget()	Adds a @request-target derived component
SignatureComponents.Builder	scheme()	Adds a @scheme derived component - the scheme of the target URI for a request
SignatureComponents.Builder	status()	Adds a @status derived component - the status code for a response
SignatureComponents.Builder	structuredHeader(String headerName)	Adds a single Structured Field (header) component, re-serialized to its standard form (without redundant whitespaces)
SignatureComponents.Builder	structuredTrailer(String trailerName)	Adds a single Structured Field component for a trailer, re-serialized to its standard form (without redundant whitespaces)
SignatureComponents.Builder	targetUri()	Adds a @target-uri derived component - the full target URI for a request
SignatureComponents.Builder	trailer(String trailerName)	Adds a single HTTP Field component for a trailer
SignatureComponents.Builder	trailerDictionaryMember(String trailerName, String dictionaryKey)	Adds a single Dictionary Structured Field Member component for a trailer
SignatureComponents.Builder	trailers(String... trailerNames)	Adds multiple HTTP Field components for trailers
SignatureComponents.Builder	trailers(Collection<String> trailerNames)	Adds multiple HTTP Field components for trailers

Methods inherited from class java.lang.Object

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

Method Details

header

public SignatureComponents.Builder header(String headerName)

Adds a single HTTP Field (header) component

Parameters:

headerName - Header name

Returns:

This builder

See Also:

• HTTP Fields
• HeaderComponent

headers

public SignatureComponents.Builder headers(Collection<String> headerNames)

Adds multiple HTTP Field (header) components

Parameters:

headerNames - Header names

Returns:

This builder

See Also:

• HTTP Fields
• HeaderComponent

headers

public SignatureComponents.Builder headers(String... headerNames)

Adds multiple HTTP Field (header) components

Parameters:

headerNames - Header names

Returns:

This builder

See Also:

• HTTP Fields
• HeaderComponent

relatedRequestHeader

public SignatureComponents.Builder relatedRequestHeader(String headerName)

Adds a single HTTP Field (header) component for Related Request (req, request that triggered generated response)

Parameters:

headerName - Header name from the related request

Returns:

This builder

See Also:

• HTTP Fields
• Signing Request Components in a Response Message
• HeaderComponent

structuredHeader

public SignatureComponents.Builder structuredHeader(String headerName)

Adds a single Structured Field (header) component, re-serialized to its standard form (without redundant whitespaces)

Parameters:

headerName - Header name

Returns:

This builder

See Also:

• Strict Serialization of HTTP Structured Fields
• HeaderComponent

relatedRequestStructuredHeader

public SignatureComponents.Builder relatedRequestStructuredHeader(String headerName)

Adds a single Structured Field (header) component for Related Request. Header value is re-serialized to its standard form (without redundant whitespaces).

Parameters:

headerName - Header name

Returns:

This builder

See Also:

• Strict Serialization of HTTP Structured Fields
• Signing Request Components in a Response Message
• HeaderComponent

dictionaryMember

public SignatureComponents.Builder dictionaryMember(String headerName,
 String dictionaryKey)

Adds a single Dictionary Structured Field Member component

Parameters:

headerName - Header name

dictionaryKey - Dictionary member key

Returns:

This builder

See Also:

• Dictionary Structured Field Members
• HeaderComponent

relatedRequestDictionaryMember

public SignatureComponents.Builder relatedRequestDictionaryMember(String headerName,
 String dictionaryKey)

Adds a single Dictionary Structured Field Member component for Related Request

Parameters:

headerName - Header name

dictionaryKey - Dictionary member key

Returns:

This builder

See Also:

• Dictionary Structured Field Members
• Signing Request Components in a Response Message
• HeaderComponent

binaryWrappedHeader

public SignatureComponents.Builder binaryWrappedHeader(String headerName)

Adds a single Binary-wrapped HTTP Field component

Parameters:

headerName - Header name

Returns:

This builder

See Also:

• Binary-Wrapped HTTP Fields

relatedRequestBinaryWrappedHeader

public SignatureComponents.Builder relatedRequestBinaryWrappedHeader(String headerName)

Adds a single Binary-wrapped HTTP Field component for Related request

Parameters:

headerName - Header name

Returns:

This builder

See Also:

• Binary-Wrapped HTTP Fields
• Signing Request Components in a Response Message

trailer

public SignatureComponents.Builder trailer(String trailerName)

Adds a single HTTP Field component for a trailer

Parameters:

trailerName - Trailer name

Returns:

This builder

See Also:

• Trailer Fields
• HeaderComponent

trailers

public SignatureComponents.Builder trailers(Collection<String> trailerNames)

Adds multiple HTTP Field components for trailers

Parameters:

trailerNames - Trailer names

Returns:

This builder

See Also:

• Trailer Fields
• HeaderComponent

trailers

public SignatureComponents.Builder trailers(String... trailerNames)

Adds multiple HTTP Field components for trailers

Parameters:

trailerNames - Trailer names

Returns:

This builder

See Also:

• Trailer Fields
• HeaderComponent

relatedRequestTrailer

public SignatureComponents.Builder relatedRequestTrailer(String trailerName)

Adds a single HTTP Field component for a trailed from Related Request (req, request that triggered generated response)

Parameters:

trailerName - Trailer name from the related request

Returns:

This builder

See Also:

• Trailer Fields
• Signing Request Components in a Response Message
• HeaderComponent

structuredTrailer

public SignatureComponents.Builder structuredTrailer(String trailerName)

Adds a single Structured Field component for a trailer, re-serialized to its standard form (without redundant whitespaces)

Parameters:

trailerName - Trailer name

Returns:

This builder

See Also:

• Trailer Fields
• Strict Serialization of HTTP Structured Fields
• HeaderComponent

relatedRequestStructuredTrailer

public SignatureComponents.Builder relatedRequestStructuredTrailer(String trailerName)

Adds a single Structured Field component for a trailer from Related Request. Trailer value is re-serialized to its standard form (without redundant whitespaces).

Parameters:

trailerName - Trailer name

Returns:

This builder

See Also:

• Trailer Fields
• Strict Serialization of HTTP Structured Fields
• Signing Request Components in a Response Message
• HeaderComponent

trailerDictionaryMember

public SignatureComponents.Builder trailerDictionaryMember(String trailerName,
 String dictionaryKey)

Adds a single Dictionary Structured Field Member component for a trailer

Parameters:

trailerName - Trailer name

dictionaryKey - Dictionary member key

Returns:

This builder

See Also:

• Trailer Fields
• Dictionary Structured Field Members
• HeaderComponent

relatedRequestTrailerDictionaryMember

public SignatureComponents.Builder relatedRequestTrailerDictionaryMember(String trailerName,
 String dictionaryKey)

Adds a single Dictionary Structured Field Member component for a trailer from Related Request

Parameters:

trailerName - Trailer name

dictionaryKey - Dictionary member key

Returns:

This builder

See Also:

• Trailer Fields
• Dictionary Structured Field Members
• Signing Request Components in a Response Message
• HeaderComponent

binaryWrappedTrailer

public SignatureComponents.Builder binaryWrappedTrailer(String trailerName)

Adds a single Binary-wrapped HTTP Field component for a trailer

Parameters:

trailerName - Trailer name

Returns:

This builder

See Also:

• Trailer Fields
• Binary-wrapped HTTP Fields

relatedRequestBinaryWrappedTrailer

public SignatureComponents.Builder relatedRequestBinaryWrappedTrailer(String trailerName)

Adds a single Binary-wrapped HTTP Field component for a trailer from Related request

Parameters:

trailerName - Trailer name

Returns:

This builder

See Also:

• Trailer Fields
• Binary-wrapped HTTP Fields
• Signing Request Components in a Response Message

method

public SignatureComponents.Builder method()

Adds a @method derived component - the method used for a request

Returns:

This builder

See Also:

• Method
• DerivedComponent

relatedRequestMethod

public SignatureComponents.Builder relatedRequestMethod()

Adds a @method derived component for Related Request - the method used for a request

Returns:

This builder

See Also:

• Method
• Signing Request Components in a Response Message
• DerivedComponent

targetUri

public SignatureComponents.Builder targetUri()

Adds a @target-uri derived component - the full target URI for a request

Returns:

This builder

See Also:

• Target URI
• DerivedComponent

relatedRequestTargetUri

public SignatureComponents.Builder relatedRequestTargetUri()

Adds a @target-uri derived component for Related Request - the full target URI for a request

Returns:

This builder

See Also:

• Target URI
• Signing Request Components in a Response Message
• DerivedComponent

authority

public SignatureComponents.Builder authority()

Adds an @authority derived component - the authority (host) of the target URI for a request

Returns:

This builder

See Also:

• Authority
• DerivedComponent

relatedRequestAuthority

public SignatureComponents.Builder relatedRequestAuthority()

Adds an @authority derived component for Related Request - the authority (host) of the target URI for a request

Returns:

This builder

See Also:

• Authority
• Signing Request Components in a Response Message
• DerivedComponent

scheme

public SignatureComponents.Builder scheme()

Adds a @scheme derived component - the scheme of the target URI for a request

Returns:

This builder

See Also:

• Scheme
• DerivedComponent

relatedRequestScheme

public SignatureComponents.Builder relatedRequestScheme()

Adds a @scheme derived component for Related Request - the scheme of the target URI for a request

Returns:

This builder

See Also:

• Scheme
• Signing Request Components in a Response Message
• DerivedComponent

requestTarget

public SignatureComponents.Builder requestTarget()

Adds a @request-target derived component

Returns:

This builder

See Also:

• Request Target
• DerivedComponent

relatedRequestRequestTarget

public SignatureComponents.Builder relatedRequestRequestTarget()

Adds a @request-target derived component for Related Request

Returns:

This builder

See Also:

• Request Target
• Signing Request Components in a Response Message
• DerivedComponent

path

public SignatureComponents.Builder path()

Adds a @path derived component - the absolute path portion of the target URI for a request

Returns:

This builder

See Also:

• Path
• DerivedComponent

relatedRequestPath

public SignatureComponents.Builder relatedRequestPath()

Adds a @path derived component for Related Request - the absolute path portion of the target URI for a request

Returns:

This builder

See Also:

• Path
• Signing Request Components in a Response Message
• DerivedComponent

query

public SignatureComponents.Builder query()

Adds a @query derived component - the query portion of the target URI for a request

Returns:

This builder

See Also:

• Query
• DerivedComponent

relatedRequestQuery

public SignatureComponents.Builder relatedRequestQuery()

Adds a @query derived component for Related Request - the query portion of the target URI for a request

Returns:

This builder

See Also:

• Query
• Signing Request Components in a Response Message
• DerivedComponent

queryParam

public SignatureComponents.Builder queryParam(String paramName)

Adds a @query-param derived component - a parsed query parameter of the target URI for a request

Parameters:

paramName - Query parameter name. Must be provided in decoded form, e.g. "q$p s" rather than "q%24p+r".

Returns:

This builder

See Also:

• Query Parameters
• DerivedComponent

relatedRequestQueryParam

public SignatureComponents.Builder relatedRequestQueryParam(String paramName)

Adds a @query-param derived component for Related Request - a parsed query parameter of the target URI for a request

Parameters:

paramName - Query parameter name. Must be provided in decoded form, e.g. "q$p s" rather than "q%24p+r".

Returns:

This builder

See Also:

• Query Parameters
• Signing Request Components in a Response Message
• DerivedComponent

status

public SignatureComponents.Builder status()

Adds a @status derived component - the status code for a response

Returns:

This builder

See Also:

• Status Code
• DerivedComponent

build

public SignatureComponents build()

Constructs SignatureComponents object from this builder

Returns:

SignatureComponents object