Class ComponentIdentifierParameters

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

java.util.LinkedHashMap<String,Object>

com.authlete.hms.ComponentIdentifierParameters

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, SequencedMap<String,Object>

public class ComponentIdentifierParameters
extends LinkedHashMap<String,Object>

HTTP Signature Component Parameters.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1. HTTP Fields
• IANA: HTTP Message Signature / HTTP Signature Component Parameters
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BS	"bs": Byte Sequence wrapping indicator.
static final String	KEY	"key": Single key value of Dictionary Structured Fields.
static final String	NAME	"name": Single named query parameter.
static final String	REQ	"req": Related request indicator.
static final String	SF	"sf": Strict Structured Field serialization.
static final String	TR	"tr": Trailer.

Constructor Summary

Constructors

Constructor	Description
ComponentIdentifierParameters()	The default constructor.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the value of the key parameter.
String	getName()	Get the value of the name parameter.
boolean	isBs()	Get the flag indicating whether the bs flag is set.
boolean	isReq()	Get the flag indicating whether the req flag is set.
boolean	isSf()	Get the flag indicating whether the sf flag is set.
boolean	isTr()	Get the flag indicating whether the tr flag is set.
String	serialize()	Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.
StringBuilder	serializeTo(StringBuilder sb)	Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and write the resulting string into the specified string builder.
ComponentIdentifierParameters	setBs(Boolean bs)	Set the flag indicating whether the bs flag is set.
ComponentIdentifierParameters	setKey(String key)	Set the value of the key parameter.
ComponentIdentifierParameters	setName(String name)	Set the value of the name parameter.
ComponentIdentifierParameters	setReq(Boolean req)	Set the flag indicating whether the req flag is set.
ComponentIdentifierParameters	setSf(Boolean sf)	Set the flag indicating whether the sf flag is set.
ComponentIdentifierParameters	setTr(Boolean tr)	Set the flag indicating whether the tr flag is set.
String	toString()	Get the string representation of this instance, which is the serialized parameters returned by the serialize() method.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Field Details

BS

public static final String BS

"bs": Byte Sequence wrapping indicator.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.3. Binary-Wrapped HTTP Fields
• Constant Field Values

KEY

public static final String KEY

"key": Single key value of Dictionary Structured Fields.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.2. Dictionary Structured Field Members
• Constant Field Values

NAME

public static final String NAME

"name": Single named query parameter.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.2.8. Query Parameters
• Constant Field Values

REQ

public static final String REQ

"req": Related request indicator.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.4. Signing Request Components in a Response Message
• Constant Field Values

SF

public static final String SF

"sf": Strict Structured Field serialization.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.1. Strict Serialization of HTTP Structured Fields
• Constant Field Values

TR

public static final String TR

"tr": Trailer.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.4. Trailer Fields
• Constant Field Values

Constructor Details

ComponentIdentifierParameters

public ComponentIdentifierParameters()

The default constructor.

Method Details

isBs

public boolean isBs()

Get the flag indicating whether the bs flag is set.

Returns:

True if the bs flag is set.

Throws:

IllegalStateException - The parameter value identified by the key "bs" is not null, but it is not an instance of Boolean.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.3. Binary-Wrapped HTTP Fields

setBs

public ComponentIdentifierParameters setBs(Boolean bs)

Set the flag indicating whether the bs flag is set.

Parameters:

bs - True to indicate that the bs flag is set.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.3. Binary-Wrapped HTTP Fields

getKey

public String getKey()

Get the value of the key parameter.

Returns:

The value of the key parameter.

Throws:

IllegalStateException - The parameter value identified by the key "key" is not null, but it is not an instance of String.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.2. Dictionary Structured Field Members

setKey

public ComponentIdentifierParameters setKey(String key)

Set the value of the key parameter.

Parameters:

key - The value of the key parameter.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.2. Dictionary Structured Field Members

getName

public String getName()

Get the value of the name parameter.

Returns:

The value of the name parameter.

Throws:

IllegalStateException - The parameter value identified by the key "name" is not null, but it is not an instance of String.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.2.8. Query Parameters

setName

public ComponentIdentifierParameters setName(String name)

Set the value of the name parameter.

Parameters:

name - The value of the name parameter.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.2.8. Query Parameters

isReq

public boolean isReq()

Get the flag indicating whether the req flag is set.

Returns:

True if the req flag is set.

Throws:

IllegalStateException - The parameter value identified by the key "req" is not null, but it is not an instance of Boolean.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.4. Signing Request Components in a Response Message

setReq

public ComponentIdentifierParameters setReq(Boolean req)

Set the flag indicating whether the req flag is set.

Parameters:

req - True to indicate that the req flag is set.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.4. Signing Request Components in a Response Message

isSf

public boolean isSf()

Get the flag indicating whether the sf flag is set.

Returns:

True if the sf flag is set.

Throws:

IllegalStateException - The parameter value identified by the key "sf" is not null, but it is not an instance of Boolean.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.1. Strict Serialization of HTTP Structured Fields

setSf

public ComponentIdentifierParameters setSf(Boolean sf)

Set the flag indicating whether the sf flag is set.

Parameters:

sf - True to indicate that the sf flag is set.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.1. Strict Serialization of HTTP Structured Fields

isTr

public boolean isTr()

Get the flag indicating whether the tr flag is set.

Returns:

True if the tr flag is set.

Throws:

IllegalStateException - The parameter value identified by the key "tr" is not null, but it is not an instance of Boolean.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.1. Strict Serialization of HTTP Structured Fields

setTr

public ComponentIdentifierParameters setTr(Boolean tr)

Set the flag indicating whether the tr flag is set.

Parameters:

tr - True to indicate that the tr flag is set.

Returns:

this object.

See Also:

• RFC 9421 HTTP Message Signatures, Section 2.1.1. Strict Serialization of HTTP Structured Fields

toString

public String toString()

Get the string representation of this instance, which is the serialized parameters returned by the serialize() method.

Overrides:

toString in class AbstractMap<String,Object>

Returns:

The string representation of this instance.

serialize

public String serialize()

Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.

Returns:

The serialized parameters represented by this instance.

serializeTo

public StringBuilder serializeTo(StringBuilder sb)

Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and write the resulting string into the specified string builder.

The ABNF for Parameters from RFC 8941 Structured Field Values for HTTP, 3.1.2. Parameters:

 parameters    = *( ";" *SP parameter )
 parameter     = param-key [ "=" param-value ]
 param-key     = key
 key           = ( lcalpha / "*" )
                 *( lcalpha / DIGIT / "_" / "-" / "." / "*" )
 lcalpha       = %x61-7A ; a-z
 param-value   = bare-item
 

Parameters:

sb - A string builder into which the resulting string is written.

Returns:

The same string builder that was passed as the argument.