1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package javax.net.ssl;
19
20/**
21 * The interface to be used to provide hostname verification functionality.
22 * <p>
23 * This is an extended verification option that implementers can provide. It is to be used
24 * during a handshake if the URL's hostname does not match the peer's
25 * identification hostname.
26 */
27public interface HostnameVerifier {
28    /**
29     * Verifies that the specified hostname is allowed within the specified SSL
30     * session.
31     *
32     * @param hostname
33     *            the hostname.
34     * @param session
35     *            the SSL session of the connection.
36     * @return {@code true} if the specified hostname is allowed, otherwise
37     *         {@code false}.
38     */
39    boolean verify(String hostname, SSLSession session);
40}
41