javax.net.ssl.HostnameVerifier Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.net.ssl;
/**
* The interface to be used to provide hostname verification functionality.
*
* This is an extended verification option that implementers can provide. It is to be used
* during a handshake if the URL's hostname does not match the peer's
* identification hostname.
*/
public interface HostnameVerifier {
/**
* Verifies that the specified hostname is allowed within the specified SSL
* session.
*
* @param hostname
* the hostname.
* @param session
* the SSL session of the connection.
* @return {@code true} if the specified hostname is allowed, otherwise
* {@code false}.
*/
boolean verify(String hostname, SSLSession session);
}