• Home
• io.inverno.mod
• inverno-http-server
• 1.6.2
• source code
• ReactiveServerController.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.inverno.mod.http.server.ReactiveServerController Maven / Gradle / Ivy

/*
 * Copyright 2022 Jeremy KUHN
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.inverno.mod.http.server;

import io.inverno.mod.http.base.ExchangeContext;
import reactor.core.publisher.Mono;

/**
 * 

 * A reactive server controller defines how exchanges and error exchanges must be handled within the HTTP server following reactive principles.
 * 
 *
 * @author Jeremy Kuhn
 * @since 1.5
 *
 * @param  the type of the exchange context
 * @param  the type of exchange handled by the controller
 * @param  the type of error exchange handled by the controller
 */
public interface ReactiveServerController, C extends ErrorExchange> {

	/**
	 * 

	 * Returns a Mono that defers the processing of an exchange.
	 * 
	 *
	 * 

	 * The HTTP server subscribes to the returned Mono and, on completion, subscribes to the exchange response body data publisher to respond to the client.
	 * 
	 *
	 * @param exchange the exchange to process
	 *
	 * @see ReactiveExchangeHandler
	 *
	 * @return an empty mono that completes when the exchange has been processed
	 */
	Mono defer(B exchange);

	/**
	 * 

	 * Returns a Mono that defers the processing of an error exchange.
	 * 
	 *
	 * 

	 * In case of error, the HTTP server creates an error exchange from the original exchange, subscribes to the returned Mono and on completion, subscribes to the error exchange response body data
	 * publisher to respond to the client.
	 * 
	 *
	 * @param errorExchange the error exchange to process
	 *
	 * @see ReactiveExchangeHandler
	 *
	 * @return an empty mono that completes when the error exchange has been processed
	 */
	Mono defer(C errorExchange);
}