com.jayway.restassured.response.Response Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
There is a newer version: 2.9.0
/*
 * Copyright 2011 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 com.jayway.restassured.response;

import java.util.Map;

/**
 * The response of a request made by REST Assured.
 * 
 * Usage example:
 * 
 * Response response = get("/lotto");
 * String body = response.getBody().asString();
 * String headerValue = response.getHeader("headerName");
 * String cookieValue = response.getCookie("cookieName");
 * 
 * 
 * The response can only be returned if you don't use any expectations on the body. E.g.
 * 
 * expect().body(equalTo("my body")).when().get("/something").asString()
 * 
 * will throw an {@link IllegalStateException} because of the body expectation matcher.
 *
 * 
 */
public interface Response extends ResponseBody {

    /**
     * Syntactic sugar, simply returns the same response instance.
     *
     * @return The same response instance.
     */
    Response andReturn();

    /**
     * Syntactic sugar, simply returns the same response instance.
     *
     * @return The same response instance.
     */
    Response thenReturn();

    /**
     * Returns the response body
     *
     * @return The response body.
     */
    ResponseBody body();

    /**
     * Returns the response body
     *
     * @return The response body.
     */
    ResponseBody getBody();

    /**
     * The response headers.
     *
     * @return The response headers.
     */
    Map headers();

    /**
     * The response headers.
     *
     * @return The response headers.
     */
    Map getHeaders();

    /**
     * Get a single header value associated with the given name.
     *
     * @return The header value or null if value was not found.
     */
    String header(String name);

    /**
     * Get a single header value associated with the given name.
     *
     * @return The header value or null if value was not found.
     */
    String getHeader(String name);

    /**
     * The response cookies.
     *
     * @return The response cookies.
     */
    Map cookies();

    /**
     * The response cookies.
     *
     * @return The response cookies.
     */
    Map getCookies();

    /**
     * Get a single cookie value associated with the given name.
     *
     * @return The cookie value or null if value was not found.
     */
    String cookie(String name);

    /**
     * Get a single cookie value associated with the given name.
     *
     * @return The cookie value or null if value was not found.
     */
    String getCookie(String name);

    /**
     * Get the status line of the response.
     *
     * @return The status line of the response.
     */
    String statusLine();

    /**
     * Get the status line of the response.
     *
     * @return The status line of the response.
     */
    String getStatusLine();

    /**
     * Get the status code of the response.
     *
     * @return The status code of the response.
     */
    int statusCode();

    /**
     * Get the status code of the response.
     *
     * @return The status code of the response.
     */
    int getStatusCode();
}