io.continual.http.service.framework.context.CHttpRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of continualHttp Show documentation
Continual's HTTP service library.
There is a newer version: 0.3.16
/*
 *	Copyright 2019, Continual.io
 *
 *	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.continual.http.service.framework.context;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;

import io.continual.util.standards.HttpHeaders;

/**
 * A request made to a servlet.
 */
public interface CHttpRequest
{
	/**
	 * Get the request's URL
	 * @return the URL
	 */
	String getUrl ();

	/**
	 * Get the query string from the HTTP request, or null if there's no query
	 * @return the query string or null
	 */
	String getQueryString ();

	/**
	 * Get the HTTP method for this request. 
	 * @return the HTTP method
	 */
	String getMethod ();

	/**
	 * get the request's path within the servlet context
	 * @return the request path within the servlet context
	 */
	String getPathInContext ();

	/**
	 * Get the first value (of 1 or more) for a given header name.
	 * @param header
	 * @return null if the header does not exist, or the first value otherwise
	 */
	String getFirstHeader ( String header );

	/**
	 * Get the first value (of 1 or more) for a given header name.
	 * @param header
	 * @return null if the header does not exist, or the first value otherwise
	 */
	default String getFirstHeader ( HttpHeaders header )
	{
		return getFirstHeader ( header.toString () );
	}

	/**
	 * Get all values for a given header.
	 * @param header
	 * @return a list of 0 or more values
	 */
	List getHeader ( String header );

	/**
	 * Get all values for a given header.
	 * @param header
	 * @return a list of 0 or more values
	 */
	default List getHeader ( HttpHeaders header )
	{
		return getHeader ( header.toString () );
	}

	/**
	 * Get all headers.
	 * @return a map of headers
	 */
	Map> getAllHeaders ();

	/**
	 * Get the parameter map for this request.
	 * @return a map of name/value pairs.
	 */
	Map getParameterMap ();

	/**
	 * get a parameter by name
	 * @param key
	 * @return null, or the value of the named parameter
	 */
	String getParameter ( String key );

	/**
	 * get a parameter by name. If the parameter does not exist on this request,
	 * return the default value provided.
	 * 
	 * @param key
	 * @param defVal
	 * @return the value of the parameter, or the default value
	 */
	String getParameter ( String key, String defVal );

	/**
	 * Get a parameter as an integer.
	 * @param key
	 * @param defVal
	 * @return an integer parameter, or the default value
	 */
	int getIntParameter ( String key, int defVal );

	/**
	 * Get a parameter as an long.
	 * @param key
	 * @param defVal
	 * @return an long parameter, or the default value
	 */
	long getLongParameter ( String key, long defVal );

	/**
	 * Get a parameter as a double.
	 * @param key
	 * @param defVal
	 * @return
	 */
	double getDoubleParameter ( String key, double defVal );

	/**
	 * Get a parameter as a boolean.
	 * @param key
	 * @param defVal
	 * @return
	 */
	boolean getBooleanParameter ( String key, boolean defVal );

	/**
	 * Get a parameter as a char.
	 * @param key
	 * @param defVal
	 * @return
	 */
	char getCharParameter ( String key, char defVal );

	/**
	 * Change the value of a parameter on this request. (Generally used by validators.)
	 * @param fieldName
	 * @param defVal
	 */
	void changeParameter ( String fieldName, String defVal );

	/**
	 * Get the content type header for this request.
	 * @return
	 */
	String getContentType ();

	/**
	 * Get the content length for this request.
	 * @return the number of bytes of content in this request
	 */
	int getContentLength ();

	/**
	 * get the content as an input stream
	 * @return the body of the request as an input stream
	 * @throws IOException
	 */
	InputStream getBodyStream () throws IOException;

	/**
	 * get the content of the request as text.
	 * @return a buffered reader on the content of this request.
	 * @throws IOException
	 */
	BufferedReader getBodyStreamAsText () throws IOException;

	/**
	 * get the address of the requesting agent
	 * @return the address of the requesting agent
	 */
	String getActualRemoteAddress ();

	/**
	 * get the address of the requesting agent, using proxy headers to determine the actual client
	 * when behind a load-balancer/reverse-proxy
	 * @return the address of the requesting agent
	 */
	String getBestRemoteAddress ();

	/**
	 * Get the actual connected port number
	 * @return the actual connected client port number
	 */
	int getActualRemotePort ();

	/**
	 * Get the best connected port number, respecting standard proxy headers
	 * @return a client port number
	 */
	int getBestRemotePort ();
	
	/**
	 * return true if the request (and response) was made over a secure transport
	 * @return true if the request was made over a secure transport
	 */
	boolean isSecure ();
}