/*
 * Copyright (c) 2001, 2012, 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 javax.net.ssl;

This class is the base interface for hostname verification.

During handshaking, if the URL's hostname and the server's identification hostname mismatch, the verification mechanism can call back to implementers of this interface to determine if this connection should be allowed.

The policies can be certificate-based or may depend on other authentication schemes.

These callbacks are used when the default rules for URL hostname verification fail.

Author:Brad R. Wetmore
Since:1.4
/** * This class is the base interface for hostname verification. * <P> * During handshaking, if the URL's hostname and * the server's identification hostname mismatch, the * verification mechanism can call back to implementers of this * interface to determine if this connection should be allowed. * <P> * The policies can be certificate-based * or may depend on other authentication schemes. * <P> * These callbacks are used when the default rules for URL hostname * verification fail. * * @author Brad R. Wetmore * @since 1.4 */
public interface HostnameVerifier {
Verify that the host name is an acceptable match with the server's authentication scheme.
Params:
  • hostname – the host name
  • session – SSLSession used on the connection to host
Returns:true if the host name is acceptable
/** * Verify that the host name is an acceptable match with * the server's authentication scheme. * * @param hostname the host name * @param session SSLSession used on the connection to host * @return true if the host name is acceptable */
public boolean verify(String hostname, SSLSession session); }