blob: bada879311b97fdf7c86d107c1beb8d6bbb4b0de [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2001 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package javax.net.ssl;
27
28/**
29 * This class is the base interface for hostname verification.
30 * <P>
31 * During handshaking, if the URL's hostname and
32 * the server's identification hostname mismatch, the
33 * verification mechanism can call back to implementers of this
34 * interface to determine if this connection should be allowed.
35 * <P>
36 * The policies can be certificate-based
37 * or may depend on other authentication schemes.
38 * <P>
39 * These callbacks are used when the default rules for URL hostname
40 * verification fail.
41 *
42 * @author Brad R. Wetmore
43 * @since 1.4
44 */
45
46public interface HostnameVerifier {
47 /**
48 * Verify that the host name is an acceptable match with
49 * the server's authentication scheme.
50 *
51 * @param hostname the host name
52 * @param session SSLSession used on the connection to host
53 * @return true if the host name is acceptable
54 */
55 public boolean verify(String hostname, SSLSession session);
56}