io.inverno.mod.http.server.Part 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.InboundData;
import io.inverno.mod.http.base.InboundRequestHeaders;
import io.netty.buffer.ByteBuf;
import java.util.Optional;

/**
 * 
 * Represents a part in a multipart/form-data request body as defined by RFC 7578.
 * 
 *
 * @author Jeremy Kuhn
 * @since 1.0
 *
 * @see RequestBody.Multipart
 */
public interface Part {

	/**
	 * 
	 * Returns the part's name.
	 * 
	 * 
	 * @return the name
	 */
	String getName();

	/**
	 * 
	 * Returns the part's file name.
	 * 
	 *
	 * @return an optional returning the file name or an empty optional if the part is not a file
	 */
	Optional getFilename();
	
	/**
	 * 
	 * Returns the part's headers.
	 * 
	 * 
	 * @return the headers
	 */
	InboundRequestHeaders headers();
	
	/**
	 * 
	 * Returns the part's raw data.
	 * 
	 * 
	 * @return the raw data
	 */
	InboundData raw();
	
	/**
	 * 
	 * Returns the part's data as string.
	 * 
	 * 
	 * @return the string data
	 */
	InboundData string();
}