Package com.authlete.jaxrs

Class BaseCredentialIssuerMetadataEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseCredentialIssuerMetadataEndpoint

public class BaseCredentialIssuerMetadataEndpoint
extends BaseEndpoint

A base class for the credential issuer metadata endpoint (/.well-known/openid-credential-issuer) defined in OpenID for Verifiable Credential Issuance.

A credential issuer that supports OpenID for Verifiable Credential Issuance must provide an endpoint that returns its credential issuer metadata in the JSON format. The URL of the endpoint is defined as follows:

Credential Issuer Identifier + /.well-known/openid-credential-issuer

Credential Issuer Identifier is a URL that identifies a credential issuer.

Since:

2.57, Authlete 3.0

See Also:

OpenID for Verifiable Credential Issuance

Constructor Summary

Constructors

Constructor	Description
BaseCredentialIssuerMetadataEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api)	Handle a request to the credential issuer metadata endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.api.Options options)	Handle a request to the credential issuer metadata endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.dto.CredentialIssuerMetadataRequest request)	Handle a request to the credential issuer metadata endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.dto.CredentialIssuerMetadataRequest request, com.authlete.common.api.Options options)	Handle a request to the credential issuer metadata endpoint.

Methods inherited from class com.authlete.jaxrs.BaseEndpoint

extractClientCertificate, extractClientCertificateChain, extractHeadersAsPairs, onError, takeAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCredentialIssuerMetadataEndpoint

public BaseCredentialIssuerMetadataEndpoint()

Method Detail

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api)

Handle a request to the credential issuer metadata endpoint. This method is an alias of handle(api, (Options)null).

Parameters:

api - An implementation of AuthleteApi.

Returns:

A response that should be returned from the credential issuer metadata endpoint.

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        com.authlete.common.api.Options options)

Handle a request to the credential issuer metadata endpoint. This method is an alias of the handle(AuthleteApi, CredentialIssuerMetadataRequest, Options) method.

Parameters:

api - An implementation of AuthleteApi.

options - The request options for the /api/vci/metadata API.

Returns:

A response that should be returned from the credential issuer metadata endpoint.

Since:

2.82

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        com.authlete.common.dto.CredentialIssuerMetadataRequest request)

Handle a request to the credential issuer metadata endpoint. This method is an alias of handle(api, request, null).

Parameters:

api - An implementation of AuthleteApi.

request - The request parameters for Authlete's /api/vci/metadata API.

Returns:

A response that should be returned from the credential issuer metadata endpoint.

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        com.authlete.common.dto.CredentialIssuerMetadataRequest request,
                                        com.authlete.common.api.Options options)

Handle a request to the credential issuer metadata endpoint.

This method internally creates a CredentialIssuerMetadataRequestHandler instance and calls its handle() method. Then, this method uses the value returned from the handler's method as a response from this method.

When the handler's method raises a WebApplicationException, this method calls onError() method with the exception. The default implementation of onError() does nothing. You can override the method as necessary. After calling onError() method, this method calls getResponse() method of the exception and uses the returned value as a response from this method.

Parameters:

api - An implementation of AuthleteApi.

request - The request parameters for Authlete's /api/vci/metadata API.

options - The request options for the /api/vci/metadata API.

Returns:

A response that should be returned from the credential issuer metadata endpoint.

Since:

2.82