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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-http-server Show documentation

Inverno HTTP 1.x/2 server module

There is a newer version: 1.11.0

/*
 * Copyright 2020 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 io.inverno.mod.http.base.HttpVersion;
import io.inverno.mod.http.server.ws.WebSocket;
import io.inverno.mod.http.server.ws.WebSocketExchange;
import java.util.Optional;
import java.util.function.Function;
import reactor.core.publisher.Mono;

/**
 * 
 * Represents a failing server exchange.
 * 
 *
 * 
 * The HTTP server creates a failing exchange when an exception is thrown during the normal processing of a server {@link Exchange}. It is handled in an {@link ExchangeHandler} used to format the
 * actual response returned to the client.
 * 
 *
 * @author Jeremy Kuhn
 * @since 1.0
 *
 * @see Exchange
 *
 * @param  the type of the exchange context
 */
public interface ErrorExchange extends Exchange {

	/**
	 * 
	 * Returns the error at the origin of the exchange.
	 * 
	 * 
	 * @return a throwable of type A
	 */
	Throwable getError();

	/**
	 * 
	 * Returns an empty optional since an error exchange does not support WebSocket upgrade.
	 * 
	 * 
	 * @return an empty optional
	 */
	@Override
	default Optional>> webSocket(String... subProtocols) {
		return Optional.empty();
	}
	
	/**
	 * 
	 * Returns an error exchange consisting of the result of applying the given function to the error of the exchange.
	 * 
	 *
	 * @param errorMapper an error mapper
	 *
	 * @return a new error exchange
	 */
	default ErrorExchange mapError(Function errorMapper) {
		ErrorExchange thisExchange = this;
		return new ErrorExchange() {
			
			@Override
			public HttpVersion getProtocol() {
				return thisExchange.getProtocol();
			}
			
			@Override
			public Request request() {
				return thisExchange.request();
			}

			@Override
			public Response response() {
				return thisExchange.response();
			}
			
			@Override
			public A context() {
				return thisExchange.context();
			}
			
			@Override
			public void finalizer(Mono finalizer) {
				thisExchange.finalizer(finalizer);
			}

			@Override
			public Throwable getError() {
				return errorMapper.apply(thisExchange.getError());
			}
			
		};
	}
}

Related Artifacts