io.muserver.Headers Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mu-server Show documentation
Show all versions of mu-server Show documentation
A simple but powerful web server framework
The newest version!
package io.muserver;
import jakarta.ws.rs.core.MediaType;
import java.util.*;
/**
* HTTP headers
*/
public interface Headers extends Iterable> {
/**
* Gets the value with the given name, or null if there is no parameter with that name.
* If there are multiple parameters with the same name, the first one is returned.
*
* @param name The name of the parameter to get
* @return The value, or null
*/
String get(String name);
/**
* Gets the value with the given name, or null if there is no parameter with that name.
* If there are multiple parameters with the same name, the first one is returned.
*
* @param name The name of the parameter to get
* @return The value, or null
*/
String get(CharSequence name);
/**
* Gets the value with the given name, or the default value if there is no parameter with that name.
* If there are multiple parameters with the same name, the first one is returned.
*
* @param name The name of the parameter to get
* @param defaultValue The default value to use if there is no given value
* @return The value of the parameter, or the default value
*/
String get(CharSequence name, String defaultValue);
/**
* Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
* @param name The name of the parameter.
* @param defaultValue The value to use if none was specified, or an invalid format was used.
* @return Returns the parameter value as an integer.
*/
int getInt(CharSequence name, int defaultValue);
/**
* Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.
* @param name The name of the parameter.
* @param defaultValue The value to use if none was specified, or an invalid format was used.
* @return Returns the parameter value as a long.
*/
long getLong(String name, long defaultValue);
/**
* Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
* @param name The name of the parameter.
* @param defaultValue The value to use if none was specified, or an invalid format was used.
* @return Returns the parameter value as a float.
*/
float getFloat(String name, float defaultValue);
/**
* Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
* @param name The name of the parameter.
* @param defaultValue The value to use if none was specified, or an invalid format was used.
* @return Returns the parameter value as a double.
*/
double getDouble(String name, double defaultValue);
/**
* Gets a parameter as a boolean, where values such as true, on and yes as
* considered true, and other values (or no parameter with the name) is considered false.
* This can be used to access checkbox values as booleans.
* @param name The name of the parameter.
* @return Returns true if the value was truthy, or false if it was falsy or not specified.
*/
boolean getBoolean(String name);
/**
* Gets a date header.
* This converts the string date values into milliseconds
* @param name The header name
* @return The value in milliseconds of the date header, or null if not found
*/
Long getTimeMillis(CharSequence name);
/**
* Gets a date header.
* This converts the string date values into milliseconds
* @param name The header name
* @param defaultValue The default to use if no date header is available
* @return The value in milliseconds of the date header, or the default if not found
*/
long getTimeMillis(CharSequence name, long defaultValue);
/**
* Gets all the parameters with the given name, or an empty list if none are found.
*
* @param name The parameter name to get
* @return All values of the parameter with the given name
*/
List getAll(String name);
/**
* Gets all the parameters with the given name, or an empty list if none are found.
*
* @param name The parameter name to get
* @return All values of the parameter with the given name
*/
List getAll(CharSequence name);
/**
* @return All the headers
*/
List> entries();
/**
* Returns true if the given parameter is specified with any value
* @param name The name of the value
* @return True if it's specified; otherwise false.
*/
boolean contains(String name);
/**
* Returns true if the given parameter is specified with any value
* @param name The name of the value
* @return True if it's specified; otherwise false.
*/
boolean contains(CharSequence name);
/**
* @return An iterator to iterate through the headers
*/
Iterator> iterator();
/**
* @return True if there are no headers
*/
boolean isEmpty();
/**
* @return The number of headers. Repeated headers are counted twice.
*/
int size();
/**
* @return The header names in these headers
*/
Set names();
/**
* Adds an item to these headers. If a header with the given name already exists then this value is added
* rather than replaced.
* @param name The header name
* @param value The value
* @return This headers object
*/
Headers add(String name, Object value);
/**
* Adds an item to these headers. If a header with the given name already exists then this value is added
* rather than replaced.
* @param name The header name
* @param value The value
* @return This headers object
*/
Headers add(CharSequence name, Object value);
/**
* Adds an item to these headers. If a header with the given name already exists then this value is added
* rather than replaced.
* @param name The header name
* @param values The values
* @return This headers object
*/
Headers add(String name, Iterable values);
/**
* Adds an item to these headers. If a header with the given name already exists then this value is added
* rather than replaced.
* @param name The header name
* @param values The value
* @return This headers object
*/
Headers add(CharSequence name, Iterable values);
/**
* Adds all headers from another headers object to this
* @param headers The headers to add
* @return This headers object
*/
Headers add(Headers headers);
/**
* Adds an integer value
* @param name The header name
* @param value The value
* @return This headers object
*/
Headers addInt(CharSequence name, int value);
/**
* Sets a header value. If a header with the given name already exists then this replaces it.
* @param name The header name
* @param value The value
* @return This headers object
*/
Headers set(String name, Object value);
/**
* Sets a header value. If a header with the given name already exists then this replaces it.
* @param name The header name
* @param value The value
* @return This headers object
*/
Headers set(CharSequence name, Object value);
/**
* Sets a header value list. If a header with the given name already exists then this replaces it.
* @param name The header name
* @param values The value
* @return This headers object
*/
Headers set(String name, Iterable values);
/**
* Sets a header value list. If a header with the given name already exists then this replaces it.
* @param name The header name
* @param values The value
* @return This headers object
*/
Headers set(CharSequence name, Iterable values);
/**
* Removes all the current headers and adds them from the given headers.
* @param headers The headers to use
* @return This headers object
*/
Headers set(Headers headers);
/**
* Sets all the values from the given headers object, overwriting any existing headers with the same names.
* @param headers The headers to use
* @return This headers object
*/
Headers setAll(Headers headers);
/**
* Sets the given integer value, replacing the existing value if it is already set.
* @param name The header name
* @param value The value to set
* @return This headers object
*/
Headers setInt(CharSequence name, int value);
/**
* Removes a header. Does nothing if the header is not set.
* @param name The header to remove
* @return This headers object
*/
Headers remove(String name);
/**
* Removes a header. Does nothing if the header is not set.
* @param name The header to remove
* @return This headers object
*/
Headers remove(CharSequence name);
/**
* @return Removes all the headers from this object
*/
Headers clear();
/**
* Checks if a header with the given name exists with the given value.
* @param name The case-insensitive header name to check.
* @param value The value to check for.
* @param ignoreCase If true, the case of the value is ignored.
* @return True if a header name with the given value exists.
*/
boolean contains(String name, String value, boolean ignoreCase);
/**
* Checks if a header with the given name exists with the given value.
* @param name The case-insensitive header name to check.
* @param value The value to check for.
* @param ignoreCase If true, the case of the value is ignored.
* @return True if a header name with the given value exists.
*/
boolean contains(CharSequence name, CharSequence value, boolean ignoreCase);
/**
* Similar to {@link #contains(String, String, boolean)} but returns true even if a value occurs in a comma-separated
* header list.
* @param name The case-insensitive header name to check.
* @param value The value to check for.
* @param ignoreCase If true, the case of the value is ignored.
* @return True if a header name with the given value exists.
*/
boolean containsValue(CharSequence name, CharSequence value, boolean ignoreCase);
/**
* Returns true if the headers suggest there is a message body by checking if there is a {@link HeaderNames#TRANSFER_ENCODING}
* header or the {@link HeaderNames#CONTENT_LENGTH} is greater than 0.
*
* @return True if there should be a body; otherwise false;
*/
boolean hasBody();
/**
* Gets the Accept-Charset header value.
* For example, if a client sends text/html,application/xml;q=0.9
* then this would return a list of two values: text/html, and application/xml where application/xml
* has a parameter q of value 0.9
*
* @return Returns a parsed Accept header, or an empty list if none specified.
*/
List accept();
/**
* Gets the Accept header value.
* For example, if a client sends iso-8859-5, unicode-1-1;q=0.8
* then this would return a list of two values: iso-8859-5, and unicode-1-1 where unicode-1-1
* has a parameter q of value 0.8
*
* @return Returns a parsed Accept-Charset header, or an empty list if none specified.
*/
List acceptCharset();
/**
* Gets the Accept-Encoding header value.
* For example, if a client sends gzip, deflate
* then this would return a list of two values: gzip and deflate
*
* @return Returns a parsed Accept-Encoding header, or an empty list if none specified.
*/
List acceptEncoding();
/**
* Gets the Forwarded header value.
* For example, if a client sends for=192.0.2.60;proto=http;by=203.0.113.43
* then this would return a list of length one that has for, proto, and by values.
* If there is no Forwarded header, however there are X-Forwarded-* headers, then those
* will be used to generate pseudo-forwarded headers.
*
* @return Returns a parsed Forwarded header, or an empty list if none specified.
*/
List forwarded();
/**
* Gets the Accept-Language header value.
* For example, if a client sends en-US,en;q=0.5
* then this would return a list of two values: en-US and en where en has a q value of 0.5
*
* @return Returns a parsed Accept-Language header, or an empty list if none specified.
*/
List acceptLanguage();
/**
* Gets the Cache-Control header value.
*
* @return A map of cache control directives to their optional values. If no cache-control
* is in the header, then the resulting map will be empty.
*/
ParameterizedHeader cacheControl();
/**
* Gets the parsed Content-Type header value.
*
* @return The media type of the content specified by the headers, or null if not set.
*/
MediaType contentType();
/**
* Returns a string representation of the headers.
*
* Note: The following headers will have their actual values replaced with the string (hidden)
* in order to protect potentially sensitive information: authorization, cookie and set-cookie.
* If you wish to print all values or customize the header values that are hidden, use {@link #toString(Collection)}
* @return a string representation of these headers
*/
String toString();
/**
* Returns a string representation of the headers with selected header values replaced with the string (hidden).
* This may be useful where headers are logged for diagnostic purposes while not revealing values that are held in
* potentially sensitive headers.
* @param toSuppress A collection of case-insensitive header names which will not have their values printed.
* Pass an empty collection to print all header values. A null value will hide
* the header values as defined on {@link #toString()}.
* @return a string representation of these headers
*/
String toString(Collection toSuppress);
/**
* Creates new headers for HTTP1 requests
* @return An empty headers object.
*/
static Headers http1Headers() {
return new Http1Headers();
}
/**
* Creates new headers for HTTP2 requests
* @return An empty headers object.
*/
static Headers http2Headers() {
return new Http2Headers();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy