Class SignatureInputField

java.lang.Object

java.util.AbstractMap<String,SignatureMetadata>

java.util.HashMap<String,SignatureMetadata>

java.util.LinkedHashMap<String,SignatureMetadata>

com.authlete.hms.SignatureInputField

All Implemented Interfaces:

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

public class SignatureInputField
extends LinkedHashMap<String,SignatureMetadata>

The Signature-Input HTTP Field.

See Also:

• RFC 9421 HTTP Message Signatures, Section 4.1. The Signature-Input HTTP Field
• Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
SignatureInputField()	The default constructor.
SignatureInputField(Map<String,? extends SignatureMetadata> members)	A constructor with dictionary members, each of which represents a pair of label and signature metadata.

Method Summary

Modifier and Type	Method	Description
static SignatureInputField	parse(String fieldValue)	Parse the value of the Signature-Input HTTP field.
String	serialize()	Serialize the dictionary 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 dictionary represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and write the resulting string into the specified string builder.
String	toString()	Get the string representation of this instance, which is the serialized dictionary 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

Constructor Details

SignatureInputField

public SignatureInputField()

The default constructor.

SignatureInputField

public SignatureInputField(Map<String,? extends SignatureMetadata> members)

A constructor with dictionary members, each of which represents a pair of label and signature metadata.

Parameters:

members - Dictionary members in the value of the Signature-Input HTTP field.

Method Details

parse

public static SignatureInputField parse(String fieldValue)
                                 throws SignatureException

Parse the value of the Signature-Input HTTP field.

Parameters:

fieldValue - The value of the Signature-Input HTTP field. If null is passed, this method returns null.

Returns:

The parsed field value.

Throws:

SignatureException - The passed field value could not be parsed successfully.

toString

public String toString()

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

Overrides:

toString in class AbstractMap<String,T>

Returns:

The string representation of this instance.

serialize

public String serialize()

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

Returns:

The serialized dictionary represented by this instance.

serializeTo

public StringBuilder serializeTo(StringBuilder sb)

Serialize the dictionary 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 Dictionaries from RFC 8941 Structured Field Values for HTTP, 3.2. Dictionaries:

 sf-dictionary  = dict-member *( OWS "," OWS dict-member )
 dict-member    = member-key ( parameters / ( "=" member-value ))
 member-key     = key
 member-value   = sf-item / inner-list
 

Parameters:

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

Returns:

The same string builder that was passed as the argument.