io.restassured.specification.QueryableRequestSpecification Maven / Gradle / Ivy
/*
* Copyright 2018 the original author or authors.
*
* 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.restassured.specification;
import io.restassured.authentication.AuthenticationScheme;
import io.restassured.config.RestAssuredConfig;
import io.restassured.filter.Filter;
import io.restassured.http.Cookies;
import io.restassured.http.Headers;
import org.apache.http.client.HttpClient;
import java.util.List;
import java.util.Map;
/**
* A request specification that also supports getting the defined values.
*/
public interface QueryableRequestSpecification {
/**
* @return The base URI defined in the request specification
*/
String getBaseUri();
/**
* @return The base path defined in the request specification
*/
String getBasePath();
/**
* @return The derived request path with path parameters and base path etc applied
*/
String getDerivedPath();
/**
* Returns the original request path as it was before any path parameters were applied. For example
* if you made the following request to REST Assured:
*
* get("/something/{x}", x);
*
*
* Then this method would return "/something/{x}".
*
* @return The original request path
*/
String getUserDefinedPath();
/**
* @return The request method of the request (E.g. POST, GET etc)
*/
String getMethod();
/**
* @return The request URI as a string. This is the fully-qualified path including host, port number, scheme, path and query params.
*/
String getURI();
/**
* @return The port defined in the request specification
*/
int getPort();
/**
* @return The request content type defined in the request specification
*/
String getContentType();
/**
* @return The authentication scheme defined in the request specification
*/
AuthenticationScheme getAuthenticationScheme();
/**
* @return The request parameters defined in the request specification
*/
Map getRequestParams();
/**
* @return The form parameters defined in the request specification
*/
Map getFormParams();
/**
* @return The all path parameters defined in the request specification (both named and unnamed)
*/
Map getPathParams();
/**
* @return The named path parameters defined in the request specification
*/
Map getNamedPathParams();
/**
* Return the unnamed path parameters defined in the request specification as a map.
* Note that this only works when the unnamed path parameters are balanced (meaning that a place holder was defined in the user defined path and
* a value exists for this placeholder as an unnamed path parameter). For example when the request is defined as:
*
*
* get("/{x}/{y}", "one", "two");
*
* then this method will return { "x" : "one, "y" : "two" }. But if the request is missing the an unnamed path param for "y":
*
* get("/{x}/{y}", "one");
*
* then this method will return { "x" : "one" }.
* If the request is defined like this:
*
* get("/{x}/{y}", "one", "two", "three");
*
* then this method will return { "x" : "one, "y" : "two" }.
*
* If all you want is a list of the supplied unnamed path parameter (values) use {@link #getUnnamedPathParamValues()}.
*
* @return The unnamed path parameters defined in the request specification.
*/
Map getUnnamedPathParams();
/**
* @return A list of all unnamed path parameters supplied to the request
* @see #getUnnamedPathParams()
*/
List getUnnamedPathParamValues();
/**
* @return The query parameters defined in the request specification
*/
Map getQueryParams();
/**
* @return The multipart segments defined in the request specification
*/
List getMultiPartParams();
/**
* @return The headers defined in the request specification
*/
Headers getHeaders();
/**
* @return The cookies defined in the request specification
*/
Cookies getCookies();
/**
* @return The request body
*/
T getBody();
/**
* @return The filters (unmodifiable)
*/
List getDefinedFilters();
/**
* @return The Rest Assured configurations
*/
RestAssuredConfig getConfig();
/**
* @return The underlying http client. Only use this for advanced configuration which is not accessible from Rest Assured! By default an instance of {@link org.apache.http.impl.client.AbstractHttpClient} is used by REST Assured.
*/
HttpClient getHttpClient();
/**
* @return The defined proxy specification or null if undefined.
*/
ProxySpecification getProxySpecification();
/**
* Returns a list of all path param placeholders that are currently undefined in the request. For example if consider the following request:
*
*
* get("/{x}/{y}");
*
*
* Calling getPathParamPlaceholder() will return a list with "x" and "y". Note that if you have a path like this:
*
* get("/{x}/{x}");
*
*
* the list will include "x" twice. Also note that this function will only return those placeholders that are not yet defined.
* I.e. calling this method when the request is defined like this:
*
* get("/{x}/{y}", "something");
*
* will only return a list of "y". Use {@link #getPathParamPlaceholders()} to get ALL placeholders.
*
* @return A list of all path param templates that were defined in the request
* @see #getPathParamPlaceholders()
*/
List getUndefinedPathParamPlaceholders();
/**
* Returns a list of all path param placeholders that are currently undefined in the request. For example if consider the following request:
*
*
* get("/{x}/{y}");
*
*
* Calling getPathParamPlaceholders() will return a list with "x" and "y". Note that if you have a path like this:
*
* get("/{x}/{x}");
*
*
* the list will include "x" twice. Note that this function will return all placeholders as they were when the user issued the request.
* I.e. calling this method when the request is defined like this:
*
* get("/{x}/{y}", "something");
*
* will return a list of "x" and "y". Use {@link #getUndefinedPathParamPlaceholders()} to get a list of only the placeholders that are
* currently undefined ("y" in this case).
*
* @return A list of all path param templates that were defined in the request
* @see #getUndefinedPathParamPlaceholders()
*/
List getPathParamPlaceholders();
}