org.forgerock.http.example

Class DescribedOauth2Endpoint

java.lang.Object

org.forgerock.http.example.DescribedOauth2Endpoint

All Implemented Interfaces:

Handler, DescribableHandler, Describable<io.swagger.models.Swagger,Request>

public class DescribedOauth2Endpoint
extends Object
implements DescribableHandler

A described CHF Handler that implements a crude OAuth 2.0 AS. Exposes the following endpoints:

• /api - an API method that returns the username associated with the bearer token
• /authorize - the standard OAuth 2.0 authorization endpoint
• /login - logs the user in through HTTP basic authorization
• /token - the standard OAuth 2.0 token endpoint

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.services.descriptor.Describable

Describable.Listener

Constructor Summary

Constructors

Constructor and Description
DescribedOauth2Endpoint() Create the endpoint.

Method Summary

Modifier and Type	Method and Description
void	addDescriptorListener(Describable.Listener listener) Add a listener for API Descriptor changes.
io.swagger.models.Swagger	api(ApiProducer<io.swagger.models.Swagger> producer) Provide the API description for the component.
Promise<Response,NeverThrowsException>	handle(Context context, Request request) Returns a Promise representing the asynchronous Response of the given request.
io.swagger.models.Swagger	handleApiRequest(Context context, Request request) Handle a request for the API Descriptor.
void	removeDescriptorListener(Describable.Listener listener) Remove a listener from API Descriptor changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribedOauth2Endpoint

public DescribedOauth2Endpoint()

Create the endpoint.

Method Detail

handle

public Promise<Response,NeverThrowsException> handle(Context context,
                                                     Request request)

Description copied from interface: Handler

Returns a Promise representing the asynchronous Response of the given request. If any (asynchronous) processing goes wrong, the promise still contains a Response (probably from the 4xx or 5xx status code family).

A handler that doesn't hand-off the processing to another downstream handler is responsible for creating the response.

The returned Promise contains the response returned from the server as-is. This is responsibility of the handler to produce the appropriate error response (404, 500, ...) in case of processing error.

Note: As of Promise 2.0 implementation, it is not permitted to throw any runtime exception here. Doing so produce unexpected behaviour (most likely a server-side hang of the processing thread).

Specified by:

handle in interface Handler

Parameters:

context - The request context.

request - The request.

Returns:

A Promise representing the response to be returned to the caller.

api

public io.swagger.models.Swagger api(ApiProducer<io.swagger.models.Swagger> producer)

Description copied from interface: Describable

Provide the API description for the component. This method should perform the heavy-lifting of computing the API descriptor, and should be expected to be called rarely. Upstream handlers should call this method in order to compose all of their downstream API Descriptors into a single descriptor.

Specified by:

api in interface Describable<io.swagger.models.Swagger,Request>

Parameters:

producer - The API producer that provides general information to be built into the descriptor.

Returns:

The description object.

handleApiRequest

public io.swagger.models.Swagger handleApiRequest(Context context,
                                                  Request request)

Description copied from interface: Describable

Handle a request for the API Descriptor. This method should not do any computation, but should return the already computed descriptor.

Specified by:

handleApiRequest in interface Describable<io.swagger.models.Swagger,Request>

Parameters:

context - The request context.

request - The request.

Returns:

The descriptor.

addDescriptorListener

public void addDescriptorListener(Describable.Listener listener)

Description copied from interface: Describable

Add a listener for API Descriptor changes. The described object should call all the listeners.

Specified by:

addDescriptorListener in interface Describable<io.swagger.models.Swagger,Request>

Parameters:

listener - The listener.

removeDescriptorListener

public void removeDescriptorListener(Describable.Listener listener)

Description copied from interface: Describable

Remove a listener from API Descriptor changes.

Specified by:

removeDescriptorListener in interface Describable<io.swagger.models.Swagger,Request>

Parameters:

listener - The listener.