/*
 * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package sun.net.www.protocol.http;

Author:
Michael McMahon
Interface provided by internal http authentication cache.
NB. This API will be replaced in a future release, and should
not be made public./**
 * @author Michael McMahon
 *
 * Interface provided by internal http authentication cache.
 * NB. This API will be replaced in a future release, and should
 * not be made public.
 */

public interface AuthCache {

    
Put an entry in the cache. pkey is a string specified as follows: A:[B:]C:D:E[:F][;key=value] Between 4 and 6 fields separated by ":", and an optional semicolon-separated key=value list postfix, where the fields have the following meaning: A is "s" or "p" for server or proxy authentication respectively B is optional and is the AuthScheme, e.g. BASIC, DIGEST, NTLM, etc C is either "http" or "https" D is the hostname E is the port number F is optional and if present is the realm The semi-colon separated key=value list postfix can be used to provide additional contextual information, thus allowing to separate AuthCacheValue instances obtained from different contexts. Generally, two entries are created for each AuthCacheValue, one including the realm and one without the realm. Also, for some schemes (digest) multiple entries may be created with the same pkey, but with a different path value in the AuthCacheValue. /**
     * Put an entry in the cache. pkey is a string specified as follows:
     *
     * A:[B:]C:D:E[:F][;key=value]   Between 4 and 6 fields separated by ":",
     *          and an optional semicolon-separated key=value list postfix,
     *          where the fields have the following meaning:
     * A is "s" or "p" for server or proxy authentication respectively
     * B is optional and is the {@link AuthScheme}, e.g. BASIC, DIGEST, NTLM, etc
     * C is either "http" or "https"
     * D is the hostname
     * E is the port number
     * F is optional and if present is the realm
     *
     * The semi-colon separated key=value list postfix can be used to
     * provide additional contextual information, thus allowing
     * to separate AuthCacheValue instances obtained from different
     * contexts.
     *
     * Generally, two entries are created for each AuthCacheValue,
     * one including the realm and one without the realm.
     * Also, for some schemes (digest) multiple entries may be created
     * with the same pkey, but with a different path value in
     * the AuthCacheValue.
     */
    public void put (String pkey, AuthCacheValue value);

    
Get an entry from the cache based on pkey as described above, but also
using a pathname (skey) and the cache must return an entry
if skey is a sub-path of the AuthCacheValue.path field.
/**
     * Get an entry from the cache based on pkey as described above, but also
     * using a pathname (skey) and the cache must return an entry
     * if skey is a sub-path of the AuthCacheValue.path field.
     */
    public AuthCacheValue get (String pkey, String skey);

    
remove the entry from the cache whose pkey is specified and
whose path is equal to entry.path. If entry is null then
all entries with the same pkey should be removed.
/**
     * remove the entry from the cache whose pkey is specified and
     * whose path is equal to entry.path. If entry is null then
     * all entries with the same pkey should be removed.
     */
    public void remove (String pkey, AuthCacheValue entry);
}