Class FapiResourceRequestBase<T extends FapiResourceRequestBase<T>>

java.lang.Object

com.authlete.hms.fapi.FapiResourceRequestBase<T>

Type Parameters:

T - The subclass.

Direct Known Subclasses:

FapiResourceRequestSigner, FapiResourceRequestVerifier

public abstract class FapiResourceRequestBase<T extends FapiResourceRequestBase<T>>
extends Object

The base class for FapiResourceRequestSigner and FapiResourceRequestVerifier.

Since:

1.4

See Also:

• FAPI 2.0 Http Signatures
• RFC 9421: HTTP Message Signatures

Constructor Summary

Constructors

Constructor	Description
FapiResourceRequestBase()

Method Summary

Modifier and Type	Method	Description
String	getAuthorization()	Get the value of the Authorization HTTP field of the request.
String	getContentDigest()	Get the value of the Content-Digest HTTP field of the request.
Long	getCreated()	Get the creation time of the signature, represented as seconds since the Unix epoch.
String	getDpop()	Get the value of the DPoP HTTP field of the request.
String	getMethod()	Get the HTTP method of the request.
URI	getTargetUri()	Get the target URI of the HTTP request.
T	setAuthorization(String authorization)	Set the value of the Authorization HTTP field of the request.
T	setContentDigest(String contentDigest)	Set the value of the Content-Digest HTTP field of the request.
T	setCreated(Long created)	Set the creation time of the signature, represented as seconds since the Unix epoch.
T	setCreated(Instant created)	Set the creation time of the signature.
T	setDpop(String dpop)	Set the value of the DPoP HTTP field of the request.
T	setMethod(String method)	Set the HTTP method of the request.
T	setTargetUri(URI targetUri)	Set the target URI of the HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Details

FapiResourceRequestBase

public FapiResourceRequestBase()

Method Details

getMethod

public String getMethod()

Get the HTTP method of the request. This is used as the value of the "@method" derived component.

Returns:

The HTTP method of the request.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.2.1. Method

setMethod

public T setMethod(String method)

Set the HTTP method of the request. This is used as the value of the "@method" derived component.

Parameters:

method - The HTTP method of the request.

Returns:

this object.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.2.1. Method

getTargetUri

public URI getTargetUri()

Get the target URI of the HTTP request. This is used as the value of the "@target-uri" derived component.

Returns:

The target URI of the HTTP request.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.2.2. Target URI

setTargetUri

public T setTargetUri(URI targetUri)

Set the target URI of the HTTP request. This is used as the value of the "@target-uri" derived component.

Parameters:

targetUri - The target URI of the HTTP request.

Returns:

this object.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.2.2. Target URI

getAuthorization

public String getAuthorization()

Get the value of the Authorization HTTP field of the request. This is used as the value of the "authorization" component.

Returns:

The value of the Authorization HTTP field of the request.

setAuthorization

public T setAuthorization(String authorization)

Set the value of the Authorization HTTP field of the request. This is used as the value of the "authorization" component.

Parameters:

authorization - The value of the Authorization HTTP field of the request.

Returns:

this object.

getDpop

public String getDpop()

Get the value of the DPoP HTTP field of the request. This is used as the value of the "dpop" component.

Returns:

The value of the DPoP HTTP field of the request.

setDpop

public T setDpop(String dpop)

Set the value of the DPoP HTTP field of the request. This is used as the value of the "dpop" component.

Parameters:

dpop - The value of the DPoP HTTP field of the request.

Returns:

this object.

getContentDigest

public String getContentDigest()

Get the value of the Content-Digest HTTP field of the request. This is used as the value of the "content-digest" component.

Returns:

The value of the Content-Digest HTTP field of the request.

See Also:

• RFC 9530: Digest Fields

setContentDigest

public T setContentDigest(String contentDigest)

Set the value of the Content-Digest HTTP field of the request. This is used as the value of the "content-digest" component.

Parameters:

contentDigest - The value of the Content-Digest HTTP field of the request.

Returns:

this object.

See Also:

• RFC 9530: Digest Fields

getCreated

public Long getCreated()

Get the creation time of the signature, represented as seconds since the Unix epoch. This is used as the value of the created parameter of the signature metadata.

Returns:

The creation time of the signature.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.3. Signature Parameters

setCreated

public T setCreated(Long created)

Set the creation time of the signature, represented as seconds since the Unix epoch. This is used as the value of the created parameter of the signature metadata.

If this is not set before the signing or verifying operation, the current time at which the operation will be executed is used as the signature creation time.

Parameters:

created - The creation time of the signature.

Returns:

this object.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.3. Signature Parameters

setCreated

public T setCreated(Instant created)

Set the creation time of the signature. This is used as the value of the created parameter of the signature metadata.

If this is not set before the signing or verifying operation, the current time at which the operation will be executed is used as the signature creation time.

Parameters:

created - The creation time of the signature.

Returns:

this object.

See Also:

• RFC 9421: HTTP Message Signatures, Section 2.3. Signature Parameters