1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/SetCookie.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,109 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.cookie;
1.32 +
1.33 +import java.util.Date;
1.34 +
1.35 +/**
1.36 + * This interface represents a <code>Set-Cookie</code> response header sent by the
1.37 + * origin server to the HTTP agent in order to maintain a conversational state.
1.38 + *
1.39 + * @since 4.0
1.40 + */
1.41 +public interface SetCookie extends Cookie {
1.42 +
1.43 + void setValue(String value);
1.44 +
1.45 + /**
1.46 + * If a user agent (web browser) presents this cookie to a user, the
1.47 + * cookie's purpose will be described using this comment.
1.48 + *
1.49 + * @param comment
1.50 + *
1.51 + * @see #getComment()
1.52 + */
1.53 + void setComment(String comment);
1.54 +
1.55 + /**
1.56 + * Sets expiration date.
1.57 + * <p><strong>Note:</strong> the object returned by this method is considered
1.58 + * immutable. Changing it (e.g. using setTime()) could result in undefined
1.59 + * behaviour. Do so at your peril.</p>
1.60 + *
1.61 + * @param expiryDate the {@link Date} after which this cookie is no longer valid.
1.62 + *
1.63 + * @see Cookie#getExpiryDate
1.64 + *
1.65 + */
1.66 + void setExpiryDate (Date expiryDate);
1.67 +
1.68 + /**
1.69 + * Sets the domain attribute.
1.70 + *
1.71 + * @param domain The value of the domain attribute
1.72 + *
1.73 + * @see Cookie#getDomain
1.74 + */
1.75 + void setDomain(String domain);
1.76 +
1.77 + /**
1.78 + * Sets the path attribute.
1.79 + *
1.80 + * @param path The value of the path attribute
1.81 + *
1.82 + * @see Cookie#getPath
1.83 + *
1.84 + */
1.85 + void setPath(String path);
1.86 +
1.87 + /**
1.88 + * Sets the secure attribute of the cookie.
1.89 + * <p>
1.90 + * When <tt>true</tt> the cookie should only be sent
1.91 + * using a secure protocol (https). This should only be set when
1.92 + * the cookie's originating server used a secure protocol to set the
1.93 + * cookie's value.
1.94 + *
1.95 + * @param secure The value of the secure attribute
1.96 + *
1.97 + * @see #isSecure()
1.98 + */
1.99 + void setSecure (boolean secure);
1.100 +
1.101 + /**
1.102 + * Sets the version of the cookie specification to which this
1.103 + * cookie conforms.
1.104 + *
1.105 + * @param version the version of the cookie.
1.106 + *
1.107 + * @see Cookie#getVersion
1.108 + */
1.109 + void setVersion(int version);
1.110 +
1.111 +}
1.112 +
