reactor.netty.http.HttpInfos Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactor-netty-http Show documentation
HTTP functionality for the Reactor Netty library
There is a newer version: 1.2.1
/*
 * Copyright (c) 2011-2024 VMware, Inc. or its affiliates, All Rights Reserved.
 *
 * 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
 *
 *   https://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 reactor.netty.http;

import java.util.Map;
import java.util.Set;

import io.netty.handler.codec.http.HttpMethod;
import io.netty.handler.codec.http.HttpVersion;
import io.netty.handler.codec.http.cookie.Cookie;

/**
 * An Http Reactive Channel with several accessors related to HTTP flow: headers, params,
 * URI, method, websocket...
 *
 * @author Stephane Maldini
 * @since 0.5
 */
public interface HttpInfos {

	/**
	 * Returns resolved HTTP cookies.
	 *
	 * @return Resolved HTTP cookies
	 */
	Map> cookies();

	/**
	 * Returns the decoded path portion from the {@link #uri()}.
	 *
	 * @return the decoded path portion from the {@link #uri()}
	 * @throws IllegalArgumentException if the {@link #uri()} violates RFC2396
	 * @since 0.9.6
	 */
	String fullPath();

	/**
	 * Return a unique id for the request. The id is a combination
	 * of the id of the underlying connection and the serial number of the request
	 * received on that connection.
	 * Format of the id:
	 * {@code -}
	 * 
	 * 
	 * Example:
	 * {@code
	 *     : 329c6ffd
	 *     : 5
	 *
	 *     Result: 329c6ffd-5
	 * }
	 * 
	 *
	 * @return an unique id for the request
	 * @since 1.0.5
	 */
	String requestId();

	/**
	 * Is the request keep alive.
	 *
	 * @return is keep alive
	 */
	boolean isKeepAlive();

	/**
	 * Returns true if websocket connection (upgraded).
	 *
	 * @return true if websocket connection
	 */
	boolean isWebsocket();

	/**
	 * Returns the resolved request method (HTTP 1.1 etc.).
	 *
	 * @return the resolved request method (HTTP 1.1 etc.)
	 */
	HttpMethod method();

	/**
	 * Returns the decoded path portion from the {@link #uri()} without the leading and trailing '/' if present.
	 *
	 * @return the decoded path portion from the {@link #uri()} without the leading and trailing '/' if present
	 * @throws IllegalArgumentException if the {@link #uri()} violates RFC2396
	 */
	default String path() {
		String path = fullPath();
		if (!path.isEmpty()) {
			if (path.charAt(0) == '/') {
				path = path.substring(1);
				if (path.isEmpty()) {
					return path;
				}
			}
			if (path.charAt(path.length() - 1) == '/') {
				return path.substring(0, path.length() - 1);
			}
		}
		return path;
	}

	/**
	 * Returns the resolved target address.
	 *
	 * @return the resolved target address
	 */
	String uri();

	/**
	 * Returns the resolved request version (HTTP 1.1 etc).
	 *
	 * @return the resolved request version (HTTP 1.1 etc)
	 */
	HttpVersion version();

}