mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/SetCookie.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.cookie;
michael@0 29
michael@0 30 import java.util.Date;
michael@0 31
michael@0 32 /**
michael@0 33 * This interface represents a <code>Set-Cookie</code> response header sent by the
michael@0 34 * origin server to the HTTP agent in order to maintain a conversational state.
michael@0 35 *
michael@0 36 * @since 4.0
michael@0 37 */
michael@0 38 public interface SetCookie extends Cookie {
michael@0 39
michael@0 40 void setValue(String value);
michael@0 41
michael@0 42 /**
michael@0 43 * If a user agent (web browser) presents this cookie to a user, the
michael@0 44 * cookie's purpose will be described using this comment.
michael@0 45 *
michael@0 46 * @param comment
michael@0 47 *
michael@0 48 * @see #getComment()
michael@0 49 */
michael@0 50 void setComment(String comment);
michael@0 51
michael@0 52 /**
michael@0 53 * Sets expiration date.
michael@0 54 * <p><strong>Note:</strong> the object returned by this method is considered
michael@0 55 * immutable. Changing it (e.g. using setTime()) could result in undefined
michael@0 56 * behaviour. Do so at your peril.</p>
michael@0 57 *
michael@0 58 * @param expiryDate the {@link Date} after which this cookie is no longer valid.
michael@0 59 *
michael@0 60 * @see Cookie#getExpiryDate
michael@0 61 *
michael@0 62 */
michael@0 63 void setExpiryDate (Date expiryDate);
michael@0 64
michael@0 65 /**
michael@0 66 * Sets the domain attribute.
michael@0 67 *
michael@0 68 * @param domain The value of the domain attribute
michael@0 69 *
michael@0 70 * @see Cookie#getDomain
michael@0 71 */
michael@0 72 void setDomain(String domain);
michael@0 73
michael@0 74 /**
michael@0 75 * Sets the path attribute.
michael@0 76 *
michael@0 77 * @param path The value of the path attribute
michael@0 78 *
michael@0 79 * @see Cookie#getPath
michael@0 80 *
michael@0 81 */
michael@0 82 void setPath(String path);
michael@0 83
michael@0 84 /**
michael@0 85 * Sets the secure attribute of the cookie.
michael@0 86 * <p>
michael@0 87 * When <tt>true</tt> the cookie should only be sent
michael@0 88 * using a secure protocol (https). This should only be set when
michael@0 89 * the cookie's originating server used a secure protocol to set the
michael@0 90 * cookie's value.
michael@0 91 *
michael@0 92 * @param secure The value of the secure attribute
michael@0 93 *
michael@0 94 * @see #isSecure()
michael@0 95 */
michael@0 96 void setSecure (boolean secure);
michael@0 97
michael@0 98 /**
michael@0 99 * Sets the version of the cookie specification to which this
michael@0 100 * cookie conforms.
michael@0 101 *
michael@0 102 * @param version the version of the cookie.
michael@0 103 *
michael@0 104 * @see Cookie#getVersion
michael@0 105 */
michael@0 106 void setVersion(int version);
michael@0 107
michael@0 108 }
michael@0 109

mercurial