com.jayway.restassured.response.Cookies 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 2013 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 com.jayway.restassured.internal.MultiValueEntity;

import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import static com.jayway.restassured.internal.assertion.AssertParameter.notNull;
import static java.util.Arrays.asList;

/**
 * Represents the a number of response cookies
 */
public class Cookies implements Iterable {

    private final MultiValueEntity cookies;

    public Cookies(Cookie...cookies) {
        this(asList(cookies));
    }

    public Cookies(List cookies) {
        notNull(cookies, "Cookies");
        this.cookies = new MultiValueEntity(cookies);
    }

    /**
     * @return The size of the cookies
     */
    public int size() {
        return cookies.size();
    }

    /**
     * @return true if one or more cookies are defined, false otherwise.
     */
    public boolean exist() {
        return cookies.exist();
    }

    /**
     * See if a cookie with the given name exists
     *
     * @param cookieName The name of the cookie to check
     * @return true if the cookie exists
     */
    public boolean hasCookieWithName(String cookieName) {
        return cookies.hasEntityWithName(cookieName);
    }

    /**
     * @return All cookies as a list.
     */
    protected List list() {
        return cookies.list();
    }

    /**
     *  Get a single cookie with the supplied name. If there are several cookies match the cookieName then
     *  the first one is returned.
     *
     * @param cookieName The name of the cookie to find
     * @return The found cookie or null if no cookie was found.
     */
    public Cookie get(String cookieName) {
        notNull(cookieName, "Cookie name");
        return cookies.get(cookieName);
    }

    /**
     *  Get a single cookie value with the supplied name. If there are several cookies matching the cookieName then
     *  the first one is returned.
     *
     * @param cookieName The name of the cookie to find
     * @return The found cookie or null if no cookie was found.
     */
    public String getValue(String cookieName) {
        notNull(cookieName, "Cookie name");
        return cookies.getValue(cookieName);
    }

    /**
     *  Get all cookies with the supplied name. If there's only one cookie matching the cookieName then
     *  a list with only that cookie is returned.
     *
     * @param cookieName The name of the cookie to find
     * @return The found cookies or empty list if no cookie was found.
     */
    public List getList(String cookieName) {
        return cookies.getList(cookieName);
    }

    /**
     *  Get all cookie values of the cookie with the supplied name. If there's only one header matching the cookieName then
     *  a list with only that cookie value is returned.
     *
     * @param cookieName The name of the header to find
     * @return The found header values or empty list if no header was found.
     */
    public List getValues(String cookieName) {
        return cookies.getValues(cookieName);
    }

    /**
     * @return Cookies iterator
     */
    public Iterator iterator() {
        return cookies.iterator();
    }

    /**
     *  An alternative way to create a Cookies object from the constructor.
     *
     * @param cookie The cookie to be included
     * @param additionalCookies Additional cookies to be included (optional)
     * @return A new cookies object containing the specified cookies
     */
    public static Cookies cookies(Cookie cookie, Cookie... additionalCookies) {
        notNull(cookie, "Cookie");
        final List cookieList = new LinkedList();
        cookieList.add(cookie);
        if(cookieList != null) {
            for (Cookie additionalCookie : additionalCookies) {
                cookieList.add(additionalCookie);
            }
        }
        return new Cookies(cookieList);
    }

    @Override
    public String toString() {
        return cookies.toString();
    }
}