1 /*
2  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.net;
27 
28 /**
29  * CookiePolicy implementations decide which cookies should be accepted
30  * and which should be rejected. Three pre-defined policy implementations
31  * are provided, namely ACCEPT_ALL, ACCEPT_NONE and ACCEPT_ORIGINAL_SERVER.
32  *
33  * <p>See RFC 2965 sec. 3.3 and 7 for more detail.
34  *
35  * @author Edward Wang
36  * @since 1.6
37  */
38 public interface CookiePolicy {
39     /**
40      * One pre-defined policy which accepts all cookies.
41      */
42     public static final CookiePolicy ACCEPT_ALL = new CookiePolicy(){
43         public boolean shouldAccept(URI uri, HttpCookie cookie) {
44             return true;
45         }
46     };
47 
48     /**
49      * One pre-defined policy which accepts no cookies.
50      */
51     public static final CookiePolicy ACCEPT_NONE = new CookiePolicy(){
52         public boolean shouldAccept(URI uri, HttpCookie cookie) {
53             return false;
54         }
55     };
56 
57     /**
58      * One pre-defined policy which only accepts cookies from original server.
59      */
60     public static final CookiePolicy ACCEPT_ORIGINAL_SERVER  = new CookiePolicy(){
61         public boolean shouldAccept(URI uri, HttpCookie cookie) {
62             if (uri == null || cookie == null)
63                 return false;
64             return HttpCookie.domainMatches(cookie.getDomain(), uri.getHost());
65         }
66     };
67 
68 
69     /**
70      * Will be called to see whether or not this cookie should be accepted.
71      *
72      * @param uri       the URI to consult accept policy with
73      * @param cookie    the HttpCookie object in question
74      * @return          {@code true} if this cookie should be accepted;
75      *                  otherwise, {@code false}
76      */
shouldAccept(URI uri, HttpCookie cookie)77     public boolean shouldAccept(URI uri, HttpCookie cookie);
78 }
79