Package com.authlete.jaxrs

Class BaseFederationConfigurationEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseFederationConfigurationEndpoint

public class BaseFederationConfigurationEndpoint
extends BaseEndpoint

A base class for the entity configuration endpoint of OpenID Connect Federation 1.0.

An OpenID Provider that supports OpenID Connect Federation 1.0 must provide an endpoint that returns its entity configuration in the JWT format. The URI of the endpoint is defined as follows:

1. Entity ID + /.well-known/openid-federation
2. Host component of Entity ID + /.well-known/openid-federation + Path component of Entity ID (The same rule in RFC 8414)

Entity ID is a URL that identifies an OpenID Provider (and other entities including Relying Parties, Trust Anchors and Intermediate Authorities) in the context of OpenID Connect Federation 1.0.

Since:

2.49, Authlete 2.3

See Also:

OpenID Connect Federation 1.0

Constructor Summary

Constructors

Constructor	Description
BaseFederationConfigurationEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api)	Handle a request to the entity configuration endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.api.Options options)	Handle a request to the entity configuration endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.dto.FederationConfigurationRequest request)	Handle a request to the entity configuration endpoint.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, com.authlete.common.dto.FederationConfigurationRequest request, com.authlete.common.api.Options options)	Handle a request to the entity configuration 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

BaseFederationConfigurationEndpoint

public BaseFederationConfigurationEndpoint()

Method Detail

handle

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

Handle a request to the entity configuration endpoint. This method is an alias of the handle(AuthleteApi, FederationConfigurationRequest) method.

Parameters:

api - An implementation of AuthleteApi.

Returns:

A response that should be returned from the entity configuration 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 entity configuration endpoint. This method is an alias of the handle(AuthleteApi, FederationConfigurationRequest, Options) method.

Parameters:

api - An implementation of AuthleteApi.

options - The request options for the /api/federation/configuration API.

Returns:

A response that should be returned from the entity configuration endpoint.

Since:

2.82

handle

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

Handle a request to the entity configuration 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/federation/configuration API.

Returns:

A response that should be returned from the entity configuration endpoint.

handle

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

Handle a request to the entity configuration endpoint.

This method internally creates a FederationConfigurationRequestHandler 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/federation/configuration API.

options - The request options for the /api/federation/configuration API.

Returns:

A response that should be returned from the entity configuration endpoint.

Since:

2.82