org.openapi4j.operation.validator.model.Request Maven / Gradle / Ivy
package org.openapi4j.operation.validator.model;
import org.openapi4j.operation.validator.model.impl.Body;
import java.util.Collection;
import java.util.Map;
import java.util.TreeMap;
/**
* Representation of a HTTP request
*/
public interface Request {
/**
* @return The request URL.
*/
String getURL();
/**
* @return The request path without the query string.
*/
String getPath();
/**
* @return The HTTP request method.
*/
Method getMethod();
/**
* @return The request body.
*/
Body getBody();
/**
* @return The query string.
*/
String getQuery();
/**
* Get the cookies on this request.
*
* @return The map of key->value for the cookies associated with this request.
*/
Map getCookies();
/**
* Get the headers on this request.
*
* Result will include key and all values (in the case of multiple headers with the same key)
*
* @return The map of key->values for the headers associated with this request.
*/
Map> getHeaders();
/**
* Get the collection of header values for the header param with the given name.
*
* @param name The (case insensitive) name of the parameter to retrieve
* @return The header values for that param.
*/
Collection getHeaderValues(String name);
/**
* Get the first of header value for the header param with the given name (if any exist).
*
* @param name The (case insensitive) name of the parameter to retrieve
* @return The first header value for that param (if it exists)
*/
default String getHeaderValue(final String name) {
Collection values = getHeaderValues(name);
if (values != null) {
return values.stream().findFirst().orElse(null);
}
return null;
}
/**
* Get the content-type header of this request, if it has been set.
*
* @return The content-type header, or null if it has not been set.
*/
default String getContentType() {
return getHeaderValue("Content-Type");
}
/**
* HTTP request methods
*/
enum Method {
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD,
OPTIONS,
TRACE;
// Cache to iterate only once for request adapters new instances.
private static final Map BY_LABEL = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
static {
for (Method e: values()) {
BY_LABEL.put(e.name(), e);
}
}
public static Method getMethod(String value) {
return BY_LABEL.get(value);
}
}
}