Home | History | Annotate | Download | only in http 
      1 /*
      2  * Copyright (c) 2003, 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 sun.net.www.protocol.http;
     27 
     28 import java.io.Serializable;
     29 import java.net.PasswordAuthentication;
     30 
     31 /**
     32  * AuthCacheValue: interface to minimise exposure to authentication cache
     33  * for external users (ie. plugin)
     34  *
     35  * @author Michael McMahon
     36  */
     37 
     38 public abstract class AuthCacheValue implements Serializable {
     39 
     40     public enum Type {
     41         Proxy,
     42         Server
     43     };
     44 
     45     /**
     46      * Caches authentication info entered by user.  See cacheKey()
     47      */
     48     static protected AuthCache cache = new AuthCacheImpl();
     49 
     50     public static void setAuthCache (AuthCache map) {
     51         cache = map;
     52     }
     53 
     54     /* Package private ctor to prevent extension outside package */
     55 
     56     AuthCacheValue() {}
     57 
     58     /**
     59      * Proxy or Server
     60      */
     61     abstract Type getAuthType ();
     62 
     63     /**
     64      * Authentication scheme
     65      */
     66     abstract AuthScheme getAuthScheme();
     67 
     68    /**
     69     * name of server/proxy
     70     */
     71     abstract String getHost ();
     72 
     73    /**
     74     * portnumber of server/proxy
     75     */
     76     abstract int getPort();
     77 
     78    /**
     79     * realm of authentication if known
     80     */
     81     abstract String getRealm();
     82 
     83     /**
     84      * root path of realm or the request path if the root
     85      * is not known yet.
     86      */
     87     abstract String getPath();
     88 
     89     /**
     90      * returns http or https
     91      */
     92     abstract String getProtocolScheme();
     93 
     94     /**
     95      * the credentials associated with this authentication
     96      */
     97     abstract PasswordAuthentication credentials();
     98 }
     99