Package com.authlete.jaxrs

Class BaseClientRegistrationEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseClientRegistrationEndpoint

public class BaseClientRegistrationEndpoint
extends BaseEndpoint

A base class for dynamic client registration and dynamic client registration management endpoints.

Since:

2.17

See Also:

RFC 7591, RFC 7592, OpenID Connect Dynamic Client Registration

Constructor Summary

Constructors

Constructor	Description
BaseClientRegistrationEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handleDelete(com.authlete.common.api.AuthleteApi api, String clientId, String authorization)	Handle a client registration management delete request.
javax.ws.rs.core.Response	handleDelete(com.authlete.common.api.AuthleteApi api, String clientId, String authorization, com.authlete.common.api.Options options)	Handle a client registration management delete request.
javax.ws.rs.core.Response	handleGet(com.authlete.common.api.AuthleteApi api, String clientId, String authorization)	Handle a client registration management get request.
javax.ws.rs.core.Response	handleGet(com.authlete.common.api.AuthleteApi api, String clientId, String authorization, com.authlete.common.api.Options options)	Handle a client registration management get request.
javax.ws.rs.core.Response	handleRegister(com.authlete.common.api.AuthleteApi api, String json, String authorization)	Handle a client registration request.
javax.ws.rs.core.Response	handleRegister(com.authlete.common.api.AuthleteApi api, String json, String authorization, com.authlete.common.api.Options options)	Handle a client registration request.
javax.ws.rs.core.Response	handleUpdate(com.authlete.common.api.AuthleteApi api, String clientId, String json, String authorization)	Handle a client registration management update request.
javax.ws.rs.core.Response	handleUpdate(com.authlete.common.api.AuthleteApi api, String clientId, String json, String authorization, com.authlete.common.api.Options options)	Handle a client registration management update request.

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

BaseClientRegistrationEndpoint

public BaseClientRegistrationEndpoint()

Method Detail

handleRegister

public javax.ws.rs.core.Response handleRegister(com.authlete.common.api.AuthleteApi api,
                                                String json,
                                                String authorization)

Handle a client registration request. This method is an alias of handleRegister (api, json, authorization, null).

Parameters:

api - An implementation of AuthleteApi.

json - The serialized JSON body of the client registration request.

authorization - The value of Authorization header of the registration request. This is optional.

Returns:

A response that should be returned to the client application.

handleRegister

public javax.ws.rs.core.Response handleRegister(com.authlete.common.api.AuthleteApi api,
                                                String json,
                                                String authorization,
                                                com.authlete.common.api.Options options)

Handle a client registration request.

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

When ClientRegistrationRequestHandler.handle() 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.

json - The serialized JSON body of the client registration request.

authorization - The value of Authorization header of the registration request. This is optional.

options - The request options for the /api/client/registration API.

Returns:

A response that should be returned to the client application.

Since:

2.82

handleGet

public javax.ws.rs.core.Response handleGet(com.authlete.common.api.AuthleteApi api,
                                           String clientId,
                                           String authorization)

Handle a client registration management get request. This method is an alias of handle (api, clientId, authorization, null).

Parameters:

api - An implementation of AuthleteApi.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

authorization - The value of Authorization header of the registration request. This is optional.

Returns:

A response that should be returned to the client application.

handleGet

public javax.ws.rs.core.Response handleGet(com.authlete.common.api.AuthleteApi api,
                                           String clientId,
                                           String authorization,
                                           com.authlete.common.api.Options options)

Handle a client registration management get request.

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

When ClientRegistrationRequestHandler.handle() 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.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

authorization - The value of Authorization header of the registration request. This is optional.

options - The request options for the /api/client/registration API.

Returns:

A response that should be returned to the client application.

Since:

2.82

handleUpdate

public javax.ws.rs.core.Response handleUpdate(com.authlete.common.api.AuthleteApi api,
                                              String clientId,
                                              String json,
                                              String authorization)

Handle a client registration management update request. This method is an alias of the handleUpdate(api, clientId, json, authorization, null).

Parameters:

api - An implementation of AuthleteApi.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

json - The serialized JSON body of the client update request.

authorization - The value of Authorization header of the registration request. This is optional.

Returns:

A response that should be returned to the client application.

handleUpdate

public javax.ws.rs.core.Response handleUpdate(com.authlete.common.api.AuthleteApi api,
                                              String clientId,
                                              String json,
                                              String authorization,
                                              com.authlete.common.api.Options options)

Handle a client registration management update request.

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

When ClientRegistrationRequestHandler.handle() 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.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

json - The serialized JSON body of the client update request.

authorization - The value of Authorization header of the registration request. This is optional.

options - The request options for the /api/client/registration API.

Returns:

A response that should be returned to the client application.

Since:

2.82

handleDelete

public javax.ws.rs.core.Response handleDelete(com.authlete.common.api.AuthleteApi api,
                                              String clientId,
                                              String authorization)

Handle a client registration management delete request. This method is an alias of handle (api, clientId, authorization, null).

Parameters:

api - An implementation of AuthleteApi.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

authorization - The value of Authorization header of the registration request. This is optional.

Returns:

A response that should be returned to the client application.

handleDelete

public javax.ws.rs.core.Response handleDelete(com.authlete.common.api.AuthleteApi api,
                                              String clientId,
                                              String authorization,
                                              com.authlete.common.api.Options options)

Handle a client registration management delete request.

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

When ClientRegistrationRequestHandler.handle() 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.

clientId - The client ID as determined by the incoming request. You will commonly parse this from the incoming request URL as a path component. If your Service has its registrationManagementEndpoint property set, Authlete will add the client ID as a path parameter to this URI automatically.

authorization - The value of Authorization header of the registration request. This is optional.

options - The request options for the /api/client/registration API.

Returns:

A response that should be returned to the client application.

Since:

2.82