OpenJDK 27 · sun.net.www.protocol.https.HttpsClient · APIdia, the JavaDoc alternative

This class provides HTTPS client URL support, building on the standard "sun.net.www" HTTP protocol handler. HTTPS is the same protocol as HTTP, but differs in the transport layer which it uses:

There's a Secure Sockets Layer between TCP and the HTTP protocol code.
It uses a different default TCP port.
It doesn't use application level proxies, which can see and manipulate HTTP user level data, compromising privacy. It uses low level tunneling instead, which hides HTTP protocol and data from all third parties. (Traffic analysis is still possible).
It does basic server authentication, to protect against "URL spoofing" attacks. This involves deciding whether the X.509 certificate chain identifying the server is trusted, and verifying that the name of the server is found in the certificate. (The application may enable an anonymous SSL cipher suite, and such checks are not done for anonymous ciphers.)
It exposes key SSL session attributes, specifically the cipher suite in use and the server's X509 certificates, to application software which knows about this protocol handler.

System properties used include:

https.proxyHost ... the host supporting SSL tunneling using the conventional CONNECT syntax
https.proxyPort ... port to use on proxyHost
https.cipherSuites ... comma separated list of SSL cipher suite names to enable.
http.nonProxyHosts ...

Field Summary

Modifier and Type	Field and Description
private static final String	defaultHVCanonicalName
private static final int	httpsPortNumber
private HostnameVerifier	hv
private SSLSession	session
private SSLSocketFactory	sslSocketFactory

Inherited from sun.net.www.http.HttpClient:: authcache cachedHttpClient host inCache kac port proxyDisabled reuse url usingProxy

Constructor Summary

Access	Constructor and Description
pack-priv	HttpsClient(SSLSocketFactory sf, URL url, Proxy proxy, int connectTimeout) Create an HTTPS client URL.

Method Summary

Modifier and Type	Method and Description
public void	afterConnect() Overrides sun.net.www.http.HttpClient.afterConnect.
private void	checkURLSpoofing(HostnameVerifier hostnameVerifier)
public void	closeIdleConnection() Overrides sun.net.www.http.HttpClient.closeIdleConnection.
public void	closeServer() Overrides sun.net.www.http.HttpClient.closeServer. Close an open connection to the server.
protected Socket	createSocket() Overrides sun.net.NetworkClient.createSocket. The following method, createSocket, is defined in NetworkClient and overridden here so that the socket factory is used to create new sockets.
private String[]	getCipherSuites()
protected int	getDefaultPort() Overrides sun.net.www.http.HttpClient.getDefaultPort. Returns the default HTTPS port (443)
private String[]	getProtocols()
public String	getProxyHostUsed() Overrides sun.net.www.http.HttpClient.getProxyHostUsed. Returns: the proxy host being used for this client, or null if we're not going through a proxy
public int	getProxyPortUsed() Overrides sun.net.www.http.HttpClient.getProxyPortUsed. Returns: the proxy port being used for this client.
pack-priv SSLSession	getSSLSession() Returns the `SSLSession` in use on this connection.
public void	handshakeCompleted(HandshakeCompletedEvent event) Implements javax.net.ssl.HandshakeCompletedListener.handshakeCompleted. This method implements the SSL HandshakeCompleted callback, remembering the resulting session so that it may be queried for the current cipher suite and peer certificates.
public boolean	needsTunneling() Overrides sun.net.www.http.HttpClient.needsTunneling.
pack-priv static HttpClient	New(SSLSocketFactory sf, URL url, HostnameVerifier hv, String proxyHost, int proxyPort, boolean useCache, int connectTimeout, HttpURLConnection httpuc)
pack-priv static HttpClient	New(SSLSocketFactory sf, URL url, HostnameVerifier hv, Proxy p, boolean useCache, int connectTimeout, HttpURLConnection httpuc)
protected void	putInKeepAliveCache() Overrides sun.net.www.http.HttpClient.putInKeepAliveCache.
private void	setHostnameVerifier(HostnameVerifier hv)
private void	setSSLSocketFactory(SSLSocketFactory sf)

Field Detail

defaultHVCanonicalName	back to summary
private static final String defaultHVCanonicalName

httpsPortNumber	back to summary
private static final int httpsPortNumber

hv	back to summary
private HostnameVerifier hv

session	back to summary
private SSLSession session

sslSocketFactory	back to summary
private SSLSocketFactory sslSocketFactory

Constructor Detail

HttpsClient	back to summary
pack-priv HttpsClient(SSLSocketFactory sf, URL url, Proxy proxy, int connectTimeout) throws IOException Create an HTTPS client URL. Traffic will be tunneled through the specified proxy server, with a connect timeout

Method Detail

afterConnect	back to summary
public void afterConnect() throws IOException, UnknownHostException Overrides sun.net.www.http.HttpClient.afterConnect. Annotations @Override

afterConnect

back to summary

public void afterConnect() throws IOException, UnknownHostException

Overrides sun.net.www.http.HttpClient.afterConnect.

Annotations

@Override

checkURLSpoofing	back to summary
private void checkURLSpoofing(HostnameVerifier hostnameVerifier) throws IOException

closeIdleConnection	back to summary
public void closeIdleConnection() Overrides sun.net.www.http.HttpClient.closeIdleConnection. Annotations @Override

closeIdleConnection

back to summary

public void closeIdleConnection()

Overrides sun.net.www.http.HttpClient.closeIdleConnection.

Annotations

@Override

closeServer	back to summary
public void closeServer() Overrides sun.net.www.http.HttpClient.closeServer. Doc from sun.net.NetworkClient.closeServer. Close an open connection to the server. Annotations @Override

closeServer

back to summary

public void closeServer()

Overrides sun.net.www.http.HttpClient.closeServer.

Doc from sun.net.NetworkClient.closeServer.

Close an open connection to the server.

Annotations

@Override

createSocket	back to summary
protected Socket createSocket() throws IOException Overrides sun.net.NetworkClient.createSocket. The following method, createSocket, is defined in NetworkClient and overridden here so that the socket factory is used to create new sockets. Annotations @Override

createSocket

back to summary

protected Socket createSocket() throws IOException

Overrides sun.net.NetworkClient.createSocket.

The following method, createSocket, is defined in NetworkClient and overridden here so that the socket factory is used to create new sockets.

Annotations

@Override

getCipherSuites	back to summary
private String[] getCipherSuites()

getDefaultPort	back to summary
protected int getDefaultPort() Overrides sun.net.www.http.HttpClient.getDefaultPort. Returns the default HTTPS port (443) Annotations @Override

getDefaultPort

back to summary

protected int getDefaultPort()

Overrides sun.net.www.http.HttpClient.getDefaultPort.

Returns the default HTTPS port (443)

Annotations

@Override

getProtocols	back to summary
private String[] getProtocols()

getProxyHostUsed	back to summary
public String getProxyHostUsed() Overrides sun.net.www.http.HttpClient.getProxyHostUsed. Returns:String the proxy host being used for this client, or null if we're not going through a proxy Annotations @Override

getProxyHostUsed

back to summary

public String getProxyHostUsed()

Overrides sun.net.www.http.HttpClient.getProxyHostUsed.

Returns:String

the proxy host being used for this client, or null if we're not going through a proxy

Annotations

@Override

getProxyPortUsed	back to summary
public int getProxyPortUsed() Overrides sun.net.www.http.HttpClient.getProxyPortUsed. Returns:int the proxy port being used for this client. Meaningless if getProxyHostUsed() gives null. Annotations @Override

getProxyPortUsed

back to summary

public int getProxyPortUsed()

Overrides sun.net.www.http.HttpClient.getProxyPortUsed.

Returns:int

the proxy port being used for this client. Meaningless if getProxyHostUsed() gives null.

Annotations

@Override

getSSLSession	back to summary
pack-priv SSLSession getSSLSession() Returns the `SSLSession` in use on this connection.

handshakeCompleted	back to summary
public void handshakeCompleted(HandshakeCompletedEvent event) Implements javax.net.ssl.HandshakeCompletedListener.handshakeCompleted. This method implements the SSL HandshakeCompleted callback, remembering the resulting session so that it may be queried for the current cipher suite and peer certificates. Servers sometimes re-initiate handshaking, so the session in use on a given connection may change. When sessions change, so may peer identities and cipher suites.

handshakeCompleted

back to summary

public void handshakeCompleted(HandshakeCompletedEvent event)

Implements javax.net.ssl.HandshakeCompletedListener.handshakeCompleted.

This method implements the SSL HandshakeCompleted callback, remembering the resulting session so that it may be queried for the current cipher suite and peer certificates. Servers sometimes re-initiate handshaking, so the session in use on a given connection may change. When sessions change, so may peer identities and cipher suites.

needsTunneling	back to summary
public boolean needsTunneling() Overrides sun.net.www.http.HttpClient.needsTunneling. Annotations @Override

needsTunneling

back to summary

public boolean needsTunneling()

Overrides sun.net.www.http.HttpClient.needsTunneling.

Annotations

@Override

New	back to summary
pack-priv static HttpClient New(SSLSocketFactory sf, URL url, HostnameVerifier hv, String proxyHost, int proxyPort, boolean useCache, int connectTimeout, HttpURLConnection httpuc) throws IOException

New	back to summary
pack-priv static HttpClient New(SSLSocketFactory sf, URL url, HostnameVerifier hv, Proxy p, boolean useCache, int connectTimeout, HttpURLConnection httpuc) throws IOException

putInKeepAliveCache	back to summary
protected void putInKeepAliveCache() Overrides sun.net.www.http.HttpClient.putInKeepAliveCache. Annotations @Override

putInKeepAliveCache

back to summary

protected void putInKeepAliveCache()

Overrides sun.net.www.http.HttpClient.putInKeepAliveCache.

Annotations

@Override

setHostnameVerifier	back to summary
private void setHostnameVerifier(HostnameVerifier hv)

setSSLSocketFactory	back to summary
private void setSSLSocketFactory(SSLSocketFactory sf)

pack-priv final Class HttpsClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail