io.inverno.mod.web.compiler.spi.WebRequestBodyParameterInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-web-compiler Show documentation

Inverno web compiler module providing an Inverno compiler plugin to aggregate module's web routes and web router configurers into a single web router configurer

There is a newer version: 1.11.0

Show newest version

/*
 * Copyright 2021 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.web.compiler.spi;

import javax.lang.model.type.TypeMirror;

import org.reactivestreams.Publisher;

import io.netty.buffer.ByteBuf;
import io.inverno.mod.http.base.Parameter;
import io.inverno.mod.web.server.WebPart;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

/**
 * 
 * Describes the request body parameter in a route.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 */
public interface WebRequestBodyParameterInfo extends WebParameterInfo {

	/**
	 * 
	 * Indicates the kind of a request body.
	 * 
	 * 
	 * @author Jeremy Kuhn
	 * @since 1.0
	 */
	public static enum RequestBodyKind {
		/**
		 * The actual request body type is {@link ByteBuf}.
		 */
		RAW,
		/**
		 * The actual request body type is a super type of {@link WebPart}.
		 */
		MULTIPART,
		/**
		 * The actual request body type is {@link Parameter}.
		 */
		URLENCODED,
		/**
		 * The actual request body type is none of the above.
		 */
		ENCODED;
	}
	
	/**
	 * 
	 * Indicates the reactive kind of a request body.
	 * 
	 * 
	 * @author Jeremy Kuhn
	 * @since 1.0
	 */
	public static enum RequestBodyReactiveKind {
		/**
		 * The body parameter is not of a reactive type.
		 */
		NONE,
		/**
		 * The body parameter is of type {@link Publisher Publisher<T>} where {@code T} represents the actual request body type.
		 */
		PUBLISHER,
		/**
		 * The body parameter is of type {@link Mono Mono<T>} where {@code T} represents the actual request body type.
		 */
		ONE,
		/**
		 * The body parameter is of type {@link Flux Flux<T>} where {@code T} represents the actual request body type.
		 */
		MANY;
	}
	
	/**
	 * 
	 * Returns the request body kind.
	 * 
	 * 
	 * @return the request body kind
	 */
	RequestBodyKind getBodyKind();
	
	/**
	 * 
	 * Returns the request body reactive kind.
	 * 
	 * 
	 * @return the request body reactive kind
	 */
	RequestBodyReactiveKind getBodyReactiveKind();
	
	/**
	 * 
	 * Returns the actual type of the request body.
	 * 
	 *
	 * 
	 * When the request body is reactive, this corresponds to the type argument of the reactive type.
	 * 
	 *
	 * @return the actual body type
	 */
	@Override
	TypeMirror getType();
}