Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addDataTypeMapping(String, StructuredDataType) - Method in class com.authlete.hms.ComponentValueProvider
-
Add an additional mapping between a field name and its structured data type.
- addRequestSignature(SignatureEntry) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Add a signature entry that represents an HTTP message signature in the request.
- addRequestSignatures(Collection<SignatureEntry>) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Add signature entries that represent HTTP message signatures in the request.
- ALG - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"alg"
: Explicitly declared signature algorithm.
B
- BS - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"bs"
: Byte Sequence wrapping indicator. - build(SignatureMetadata) - Method in class com.authlete.hms.SignatureBaseBuilder
-
Build a signature base based on the specified signature metadata.
C
- com.authlete.hms - package com.authlete.hms
- com.authlete.hms.fapi - package com.authlete.hms.fapi
- com.authlete.hms.impl - package com.authlete.hms.impl
- ComponentIdentifier - Class in com.authlete.hms
-
A class representing a component identifier.
- ComponentIdentifier(String) - Constructor for class com.authlete.hms.ComponentIdentifier
-
A constructor with a component name.
- ComponentIdentifier(String, ComponentIdentifierParameters) - Constructor for class com.authlete.hms.ComponentIdentifier
-
A constructor with a component name and parameters.
- ComponentIdentifierParameters - Class in com.authlete.hms
-
HTTP Signature Component Parameters.
- ComponentIdentifierParameters() - Constructor for class com.authlete.hms.ComponentIdentifierParameters
-
The default constructor.
- ComponentValueProvider - Class in com.authlete.hms
-
A utility to provide component values.
- ComponentValueProvider() - Constructor for class com.authlete.hms.ComponentValueProvider
-
The default constructor.
- CREATED - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"created"
: Timestamp of signature creation.
D
- DICTIONARY - Enum constant in enum class com.authlete.hms.StructuredDataType
-
Dictionary.
E
- equals(Object) - Method in class com.authlete.hms.ComponentIdentifier
- equals(Object) - Method in class com.authlete.hms.StructuredFieldToken
- EXPIRES - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"expires"
: Timestamp of proposed signature expiration.
F
- FapiResourceRequestBase<T> - Class in com.authlete.hms.fapi
-
The base class for
FapiResourceRequestSigner
andFapiResourceRequestVerifier
. - FapiResourceRequestBase() - Constructor for class com.authlete.hms.fapi.FapiResourceRequestBase
- FapiResourceRequestSigner - Class in com.authlete.hms.fapi
-
A utility for signing a resource request in accordance with the FAPI 2.0 Http Signatures requirements.
- FapiResourceRequestSigner() - Constructor for class com.authlete.hms.fapi.FapiResourceRequestSigner
- FapiResourceRequestVerifier - Class in com.authlete.hms.fapi
-
A utility for verifying a resource request in accordance with the FAPI 2.0 Http Signatures requirements.
- FapiResourceRequestVerifier() - Constructor for class com.authlete.hms.fapi.FapiResourceRequestVerifier
- FapiResourceResponseBase<T> - Class in com.authlete.hms.fapi
-
The base class for
FapiResourceResponseSigner
andFapiResourceResponseVerifier
. - FapiResourceResponseBase() - Constructor for class com.authlete.hms.fapi.FapiResourceResponseBase
- FapiResourceResponseSigner - Class in com.authlete.hms.fapi
-
A utility for signing a resource response in accordance with the FAPI 2.0 Http Signatures requirements.
- FapiResourceResponseSigner() - Constructor for class com.authlete.hms.fapi.FapiResourceResponseSigner
- FapiResourceResponseVerifier - Class in com.authlete.hms.fapi
-
A utility for signing a resource response in accordance with the FAPI 2.0 Http Signatures requirements.
- FapiResourceResponseVerifier() - Constructor for class com.authlete.hms.fapi.FapiResourceResponseVerifier
G
- getAlg() - Method in class com.authlete.hms.impl.JoseHttpSigner
-
Get the algorithm.
- getAlg() - Method in class com.authlete.hms.impl.JoseHttpVerifier
-
Get the algorithm.
- getAlg() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
alg
parameter. - getAuthority() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the authority component of the target URI of the HTTP request message.
- getAuthorization() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the value of the
Authorization
HTTP field of the request. - getBaseLines() - Method in class com.authlete.hms.SignatureBase
-
Get the signature base lines included in this signature base.
- getByFieldName(String) - Static method in enum class com.authlete.hms.StructuredDataType
-
Get the structured data type of the specified field.
- getComponentIdentifier() - Method in class com.authlete.hms.SignatureBaseLine
-
Get the component identifier.
- getComponentName() - Method in class com.authlete.hms.ComponentIdentifier
-
Get the component name.
- getComponentValue() - Method in class com.authlete.hms.SignatureBaseLine
-
Get the component value.
- getComponentValue(ComponentIdentifier) - Method in class com.authlete.hms.ComponentValueProvider
-
Get the value of the component specified by the component identifier.
- getComponentValue(SignatureMetadata, ComponentIdentifier) - Method in class com.authlete.hms.ComponentValueProvider
- getComponentValue(SignatureMetadata, ComponentIdentifier) - Method in interface com.authlete.hms.SignatureContext
-
Get the component value.
- getComponentValue(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Get the value of the component specified by the component name.
- getContentDigest() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the value of the
Content-Digest
HTTP field of the request. - getContext() - Method in class com.authlete.hms.SignatureBaseBuilder
-
Get the signature context passed to the constructor.
- getCreated() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the creation time of the signature, represented as seconds since the Unix epoch.
- getCreated() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the creation time of the signature, represented as seconds since the Unix epoch.
- getCreated() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
created
parameter. - getDataTypeMappings() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the
Map
instance that manages additional mappings between field names and their structured data types. - getDpop() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the value of the
DPoP
HTTP field of the request. - getExpires() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
expires
parameter. - getHeaders() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the pool of the HTTP header fields.
- getHeadersInRequest() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the pool of the HTTP header fields in the request.
- getKey() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the value of the
key
parameter. - getKey() - Method in class com.authlete.hms.impl.JoseHttpSigner
-
Get the key.
- getKey() - Method in class com.authlete.hms.impl.JoseHttpVerifier
-
Get the key.
- getKeyid() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
keyid
parameter. - getLabel() - Method in class com.authlete.hms.SignatureEntry
-
Get the label assigned to the signature.
- getMetadata() - Method in class com.authlete.hms.SignatureEntry
-
Get the signature metadata.
- getMetadata() - Method in class com.authlete.hms.SignatureOperationInfo
-
Get the signature metadata.
- getMetadata() - Method in class com.authlete.hms.SignatureParamsLine
-
Get the signature metadata that has been passed to the constructor.
- getMethod() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the HTTP method of a request message.
- getMethod() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the HTTP method of the request.
- getMethod() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the HTTP method of the request.
- getName() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the value of the
name
parameter. - getNonce() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
nonce
parameter. - getParameters() - Method in class com.authlete.hms.ComponentIdentifier
-
Get the parameters which are part of this component identifier.
- getParameters() - Method in class com.authlete.hms.SignatureMetadata
-
Get the signature metadata parameters.
- getParamsLine() - Method in class com.authlete.hms.SignatureBase
-
Get the signature params line included in this signature base.
- getPath() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the target path of the HTTP request message.
- getQuery() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the query component of the HTTP request message.
- getQueryParam(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Get the value of a query parameter in the HTTP request message.
- getReason() - Method in class com.authlete.hms.VerificationInfo
-
Get the reason of the verification result.
- getRequestContentDigest() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the value of the
Content-Digest
HTTP field of the request. - getRequestSignatures() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the list of signature entries that represent HTTP message signatures in the request.
- getRequestTarget() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the full request target of the HTTP request message.
- getResponseContentDigest() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the value of the
Content-Digest
HTTP field of the response. - getScheme() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the scheme of the target URL of the HTTP request message.
- getSerializedSignature() - Method in class com.authlete.hms.SignatureOperationInfo
-
Get the signature in the serialized form.
- getSerializedSignatureMetadata() - Method in class com.authlete.hms.SignatureOperationInfo
-
Get the signature metadata in the serialized form.
- getSignature() - Method in class com.authlete.hms.SignatureEntry
-
Get the signature.
- getSignature() - Method in class com.authlete.hms.SignatureOperationInfo
-
Get the signature.
- getSignatureBase() - Method in class com.authlete.hms.SignatureOperationInfo
-
Get the computed signature base.
- getSigningKey() - Method in class com.authlete.hms.fapi.FapiResourceRequestSigner
-
Get the private key for signing the HTTP request.
- getSigningKey() - Method in class com.authlete.hms.fapi.FapiResourceResponseSigner
-
Get the private key for signing the HTTP response.
- getSigningKey() - Method in class com.authlete.hms.SigningInfo
-
Get the signing key used in the signing operation.
- getStatus() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the three-digit numeric HTTP status code of a response message.
- getStatus() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the status code of the HTTP response.
- getTag() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the value of the
tag
parameter. - getTargetUri() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the target URI of a request message.
- getTargetUri() - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Get the target URI of the HTTP request.
- getTargetUri() - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Get the target URI (the original request URL) of the HTTP request.
- getToken() - Method in class com.authlete.hms.StructuredFieldToken
-
Get the token passed to the constructor.
- getTrailers() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the pool of the HTTP trailer fields.
- getTrailersInRequest() - Method in class com.authlete.hms.ComponentValueProvider
-
Get the pool of the HTTP trailer fields in the request.
- getVerificationKey() - Method in class com.authlete.hms.fapi.FapiResourceRequestVerifier
-
Get the public key for verifying the HTTP message signature in the request.
- getVerificationKey() - Method in class com.authlete.hms.fapi.FapiResourceResponseVerifier
-
Get the public key for verifying the HTTP message signature in the response.
- getVerificationKey() - Method in class com.authlete.hms.VerificationInfo
-
Get the verification key used in the verification operation.
H
- hashCode() - Method in class com.authlete.hms.ComponentIdentifier
- hashCode() - Method in class com.authlete.hms.StructuredFieldToken
- HttpSigner - Interface in com.authlete.hms
-
The interface that signature signers must implement.
- HttpVerifier - Interface in com.authlete.hms
-
The interface that signature verifiers must implement.
I
- isBs() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the flag indicating whether the
bs
flag is set. - isDerivedComponent() - Method in class com.authlete.hms.ComponentIdentifier
-
Get the flag indicating that the component name of this component identifier refers to a derived component.
- isReq() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the flag indicating whether the
req
flag is set. - isSf() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the flag indicating whether the
sf
flag is set. - isTr() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the flag indicating whether the
tr
flag is set. - isVerified() - Method in class com.authlete.hms.VerificationInfo
-
Get the result of the verification operation.
- ITEM - Enum constant in enum class com.authlete.hms.StructuredDataType
-
Item.
J
- JoseHttpSigner - Class in com.authlete.hms.impl
-
An
HttpSigner
implementation for JWS algorithms. - JoseHttpSigner(JWK) - Constructor for class com.authlete.hms.impl.JoseHttpSigner
-
A constructor with a key for signing.
- JoseHttpSigner(JWK, JWSAlgorithm) - Constructor for class com.authlete.hms.impl.JoseHttpSigner
-
A constructor with a key and algorithm for signing.
- JoseHttpVerifier - Class in com.authlete.hms.impl
-
An
HttpVerifier
implementation for JWS algorithms. - JoseHttpVerifier(JWK) - Constructor for class com.authlete.hms.impl.JoseHttpVerifier
-
A constructor with a key for verification.
- JoseHttpVerifier(JWK, JWSAlgorithm) - Constructor for class com.authlete.hms.impl.JoseHttpVerifier
-
A constructor with a key and algorithm for verification.
K
- KEY - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"key"
: Single key value of Dictionary Structured Fields. - KEYID - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"keyid"
: Key identifier for the signing and verification keys used to create this signature.
L
- LIST - Enum constant in enum class com.authlete.hms.StructuredDataType
-
List.
N
- NAME - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"name"
: Single named query parameter. - NONCE - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"nonce"
: A single-use nonce value.
P
- parse(String) - Static method in class com.authlete.hms.SignatureField
-
Parse the value of the
Signature
HTTP field. - parse(String) - Static method in class com.authlete.hms.SignatureInputField
-
Parse the value of the
Signature-Input
HTTP field.
R
- REQ - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"req"
: Related request indicator.
S
- scan(SignatureField, SignatureInputField) - Static method in class com.authlete.hms.SignatureEntry
-
Build a list of signature entries from the provided
Signature
andSignature-Input
HTTP fields. - scan(SignatureField, SignatureInputField, String) - Static method in class com.authlete.hms.SignatureEntry
-
Build a list of signature entries from the provided
Signature
andSignature-Input
HTTP fields. - serialize() - Method in class com.authlete.hms.SignatureField
-
Serialize the dictionary represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureInputField
-
Serialize the dictionary represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.
- serialize() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Serialize the parameters represented by this instance, as defined in RFC 8941 Structured Field Values for HTTP, and return the resulting string.
- serialize() - Method in class com.authlete.hms.ComponentIdentifier
-
Serialize the component identifier represented by this instance, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureBase
-
Serialize the signature base represented by this instance, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureBaseLine
-
Serialize the signature base line represented by this instance, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureMetadata
-
Serialize the signature metadata represented by this instance, and return the resulting string.
- serialize() - Method in class com.authlete.hms.SignatureParamsLine
-
Serialize the signature params line represented by this instance, and return the resulting string.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureField
-
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.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureInputField
-
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.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
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.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureMetadataParameters
-
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.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.ComponentIdentifier
-
Serialize the component identifier represented by this instance, and write the resulting string into the specified string builder.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureBase
-
Serialize the signature base represented by this instance, and write the resulting string into the specified string builder.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureBaseLine
-
Serialize the signature base line represented by this instance, and write the resulting string into the specified string builder.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureMetadata
-
Serialize the signature metadata represented by this instance, and write the resulting string into the specified string builder.
- serializeTo(StringBuilder) - Method in class com.authlete.hms.SignatureParamsLine
-
Serialize the signature params line represented by this instance, and write the resulting string into the specified string builder.
- setAlg(String) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
alg
parameter. - setAuthorization(String) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the value of the
Authorization
HTTP field of the request. - setBs(Boolean) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the flag indicating whether the
bs
flag is set. - setContentDigest(String) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the value of the
Content-Digest
HTTP field of the request. - setCreated(Long) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the creation time of the signature, represented as seconds since the Unix epoch.
- setCreated(Long) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the creation time of the signature, represented as seconds since the Unix epoch.
- setCreated(Long) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
created
parameter. - setCreated(Instant) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the creation time of the signature.
- setCreated(Instant) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the creation time of the signature.
- setCreated(Instant) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
created
parameter. - setDpop(String) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the value of the
DPoP
HTTP field of the request. - setExpires(Long) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
expires
parameter. - setExpires(Instant) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
expires
parameter. - setHeaders(Map<String, List<String>>) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the pool of the HTTP header fields.
- setHeadersInRequest(Map<String, List<String>>) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the pool of the HTTP header fields in the request.
- setKey(String) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the value of the
key
parameter. - setKeyid(String) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
keyid
parameter. - setLabel(String) - Method in class com.authlete.hms.SignatureEntry
-
Set the label assigned to the signature.
- setMetadata(SignatureMetadata) - Method in class com.authlete.hms.SignatureEntry
-
Set the signature metadata.
- setMethod(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the HTTP method of a request message.
- setMethod(String) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the HTTP method of the request.
- setMethod(String) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the HTTP method of the request.
- setName(String) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the value of the
name
parameter. - setNonce(String) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
nonce
parameter. - setReason(String) - Method in class com.authlete.hms.VerificationInfo
-
Set the reason of the verification result.
- setReq(Boolean) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the flag indicating whether the
req
flag is set. - setRequestContentDigest(String) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the value of the
Content-Digest
HTTP field of the request. - setRequestTarget(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the full request target of the HTTP request message.
- setResponseContentDigest(String) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the value of the
Content-Digest
HTTP field of the response. - setSf(Boolean) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the flag indicating whether the
sf
flag is set. - setSignature(byte[]) - Method in class com.authlete.hms.SignatureEntry
-
Set the signature.
- setSignature(byte[]) - Method in class com.authlete.hms.SignatureOperationInfo
-
Set the signature.
- setSignatureBase(SignatureBase) - Method in class com.authlete.hms.SignatureOperationInfo
-
Set the computed signature base.
- setSigningKey(JWK) - Method in class com.authlete.hms.fapi.FapiResourceRequestSigner
-
Set the private key for signing the HTTP request.
- setSigningKey(JWK) - Method in class com.authlete.hms.fapi.FapiResourceResponseSigner
-
Set the private key for signing the HTTP response.
- setSigningKey(JWK) - Method in class com.authlete.hms.SigningInfo
-
Set the signing key used in the signing operation.
- setStatus(int) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the three-digit numeric HTTP status code of a response message.
- setStatus(int) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the status code of the HTTP response.
- setStatus(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the three-digit numeric HTTP status code of a response message.
- setTag(String) - Method in class com.authlete.hms.SignatureMetadataParameters
-
Set the value of the
tag
parameter. - setTargetUri(String) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the target URI of a request message.
- setTargetUri(URI) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the target URI of a request message.
- setTargetUri(URI) - Method in class com.authlete.hms.fapi.FapiResourceRequestBase
-
Set the target URI of the HTTP request.
- setTargetUri(URI) - Method in class com.authlete.hms.fapi.FapiResourceResponseBase
-
Set the target URI (the original request URL) of the HTTP request.
- setTr(Boolean) - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Set the flag indicating whether the
tr
flag is set. - setTrailers(Map<String, List<String>>) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the pool of the HTTP trailer fields.
- setTrailersInRequest(Map<String, List<String>>) - Method in class com.authlete.hms.ComponentValueProvider
-
Set the pool of the HTTP trailer fields in the request.
- setVerificationKey(JWK) - Method in class com.authlete.hms.fapi.FapiResourceRequestVerifier
-
Set the public key for verifying the HTTP message signature in the request.
- setVerificationKey(JWK) - Method in class com.authlete.hms.fapi.FapiResourceResponseVerifier
-
Set the public key for verifying the HTTP message signature in the response.
- setVerificationKey(JWK) - Method in class com.authlete.hms.VerificationInfo
-
Set the verification key used in the verification operation.
- setVerified(boolean) - Method in class com.authlete.hms.VerificationInfo
-
Set the result of the verification operation.
- SF - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"sf"
: Strict Structured Field serialization. - sign() - Method in class com.authlete.hms.fapi.FapiResourceRequestSigner
-
Execute HTTP message signing.
- sign() - Method in class com.authlete.hms.fapi.FapiResourceResponseSigner
-
Execute HTTP message signing.
- sign(byte[]) - Method in interface com.authlete.hms.HttpSigner
-
Sign the signature base (= create a signature).
- sign(byte[]) - Method in class com.authlete.hms.impl.JoseHttpSigner
- sign(HttpSigner) - Method in class com.authlete.hms.SignatureBase
-
Sign this signature base (= create a signature for this signature base).
- sign(SignatureMetadata) - Method in class com.authlete.hms.fapi.FapiResourceRequestSigner
-
Execute HTTP message signing.
- sign(SignatureMetadata) - Method in class com.authlete.hms.fapi.FapiResourceResponseSigner
-
Execute HTTP message signing.
- SignatureBase - Class in com.authlete.hms
-
A class representing
signature-base
defined in RFC 9421 HTTP Message Signatures, Section 2.5. Creating the Signature Base. - SignatureBase(List<SignatureBaseLine>, SignatureParamsLine) - Constructor for class com.authlete.hms.SignatureBase
-
A constructor with signature base lines and a signature params line.
- SignatureBaseBuilder - Class in com.authlete.hms
-
A builder for signature base, which is represented by the
SignatureBase
class. - SignatureBaseBuilder(SignatureContext) - Constructor for class com.authlete.hms.SignatureBaseBuilder
-
A constructor with a signature context.
- SignatureBaseLine - Class in com.authlete.hms
-
A class representing
signature-base-line
defined in RFC 9421 HTTP Message Signatures, Section 2.5. Creating the Signature Base. - SignatureBaseLine(ComponentIdentifier, String) - Constructor for class com.authlete.hms.SignatureBaseLine
-
A constructor with a component identifier and a component value.
- SignatureContext - Interface in com.authlete.hms
-
The signature context that provides component values.
- SignatureEntry - Class in com.authlete.hms
-
Signature entry, a pack of label, signature, and signature metadata.
- SignatureEntry() - Constructor for class com.authlete.hms.SignatureEntry
-
Default constructor.
- SignatureEntry(String, byte[], SignatureMetadata) - Constructor for class com.authlete.hms.SignatureEntry
-
Constructor with initial property values.
- SignatureField - Class in com.authlete.hms
-
The
Signature
HTTP Field. - SignatureField() - Constructor for class com.authlete.hms.SignatureField
-
The default constructor.
- SignatureField(Map<String, byte[]>) - Constructor for class com.authlete.hms.SignatureField
-
A constructor with dictionary members, each of which represents a pair of label and signature.
- SignatureInputField - Class in com.authlete.hms
-
The
Signature-Input
HTTP Field. - SignatureInputField() - Constructor for class com.authlete.hms.SignatureInputField
-
The default constructor.
- SignatureInputField(Map<String, ? extends SignatureMetadata>) - Constructor for class com.authlete.hms.SignatureInputField
-
A constructor with dictionary members, each of which represents a pair of label and signature metadata.
- SignatureMetadata - Class in com.authlete.hms
-
Signature metadata.
- SignatureMetadata() - Constructor for class com.authlete.hms.SignatureMetadata
-
The default constructor.
- SignatureMetadata(SignatureMetadataParameters) - Constructor for class com.authlete.hms.SignatureMetadata
-
A constructor with signature metadata parameters.
- SignatureMetadata(Collection<? extends ComponentIdentifier>) - Constructor for class com.authlete.hms.SignatureMetadata
-
A constructor with component identifiers.
- SignatureMetadata(Collection<? extends ComponentIdentifier>, SignatureMetadataParameters) - Constructor for class com.authlete.hms.SignatureMetadata
-
A constructor with component identifiers and signature metadata parameters.
- SignatureMetadataParameters - Class in com.authlete.hms
-
HTTP Signature Metadata Parameters.
- SignatureMetadataParameters() - Constructor for class com.authlete.hms.SignatureMetadataParameters
-
The default constructor.
- SignatureOperationInfo<T> - Class in com.authlete.hms
-
The base class for
SigningInfo
andVerificationInfo
. - SignatureOperationInfo() - Constructor for class com.authlete.hms.SignatureOperationInfo
- SignatureParamsLine - Class in com.authlete.hms
-
A class representing
signature-params-line
defined in RFC 9421 HTTP Message Signatures, Section 2.5. Creating the Signature Base. - SignatureParamsLine(SignatureMetadata) - Constructor for class com.authlete.hms.SignatureParamsLine
-
A constructor with signature metadata.
- SigningInfo - Class in com.authlete.hms
-
Information about signing operation, including the computed signature base and the generated signature.
- SigningInfo() - Constructor for class com.authlete.hms.SigningInfo
- StructuredDataType - Enum Class in com.authlete.hms
-
Structured data types.
- StructuredFieldToken - Class in com.authlete.hms
-
A class representing
sf-token
defined in RFC 8941 Structured Field Values for HTTP, Section 3.3.4. Tokens. - StructuredFieldToken(String) - Constructor for class com.authlete.hms.StructuredFieldToken
-
A constructor with a string that conforms to the sf-token format.
T
- TAG - Static variable in class com.authlete.hms.SignatureMetadataParameters
-
"tag"
: An application-specific tag for a signature. - toString() - Method in class com.authlete.hms.SignatureField
-
Get the string representation of this instance, which is the serialized dictionary returned by the
AbstractDictionaryField.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureInputField
-
Get the string representation of this instance, which is the serialized dictionary returned by the
AbstractDictionaryField.serialize()
method. - toString() - Method in class com.authlete.hms.ComponentIdentifierParameters
-
Get the string representation of this instance, which is the serialized parameters returned by the
BasicParameters.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureMetadataParameters
-
Get the string representation of this instance, which is the serialized parameters returned by the
BasicParameters.serialize()
method. - toString() - Method in class com.authlete.hms.ComponentIdentifier
-
Get the string representation of this instance, which is the serialized component identifier returned by the
ComponentIdentifier.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureBase
-
Get the string representation of this instance, which is the serialized signature base returned by the
SignatureBase.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureBaseLine
-
Get the string representation of this instance, which is the serialized signature base line returned by the
SignatureBaseLine.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureEntry
-
Get the string representation of this instance in the following format:
"label={label}, signature={signature}, metadata={metadata}"
. - toString() - Method in class com.authlete.hms.SignatureMetadata
-
Get the string representation of this instance, which is the serialized signature metadata returned by the
SignatureMetadata.serialize()
method. - toString() - Method in class com.authlete.hms.SignatureParamsLine
-
Get the string representation of this instance, which is the serialized signature params line returned by the
SignatureParamsLine.serialize()
method. - toString() - Method in class com.authlete.hms.StructuredFieldToken
- TR - Static variable in class com.authlete.hms.ComponentIdentifierParameters
-
"tr"
: Trailer.
V
- valueOf(String) - Static method in enum class com.authlete.hms.StructuredDataType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.authlete.hms.StructuredDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VerificationInfo - Class in com.authlete.hms
-
Information about verification operation, including the computed signature base and the verification result.
- VerificationInfo() - Constructor for class com.authlete.hms.VerificationInfo
- verify(byte[], byte[]) - Method in interface com.authlete.hms.HttpVerifier
-
Verify the signature.
- verify(byte[], byte[]) - Method in class com.authlete.hms.impl.JoseHttpVerifier
- verify(byte[], SignatureMetadata) - Method in class com.authlete.hms.fapi.FapiResourceRequestVerifier
-
Execute HTTP message verification.
- verify(byte[], SignatureMetadata) - Method in class com.authlete.hms.fapi.FapiResourceResponseVerifier
-
Execute HTTP message verification.
- verify(HttpVerifier, byte[]) - Method in class com.authlete.hms.SignatureBase
-
Verify the signature.
- verify(SignatureEntry) - Method in class com.authlete.hms.fapi.FapiResourceRequestVerifier
-
Execute HTTP message verification.
- verify(SignatureEntry) - Method in class com.authlete.hms.fapi.FapiResourceResponseVerifier
-
Execute HTTP message verification.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form