public abstract class

HttpsURLConnection

extends HttpURLConnection

java.lang.Object
↳	java.net.URLConnection
	↳	java.net.HttpURLConnection
		↳	javax.net.ssl.HttpsURLConnection

Class Overview

This abstract subclass of HttpURLConnection defines methods for managing HTTPS connections according to the description given by RFC 2818.

Summary

[Expand]

Inherited Constants

From class java.net.HttpURLConnection

Fields
protected HostnameVerifier	hostnameVerifier	The host name verifier used by this connection.

[Expand]

Inherited Fields

From class java.net.HttpURLConnection

From class java.net.URLConnection

Protected Constructors
	HttpsURLConnection(URL url) Creates a new `HttpsURLConnection` with the specified `URL`.

Public Methods
abstract String	getCipherSuite() Returns the name of the cipher suite negotiated during the SSL handshake.
static HostnameVerifier	getDefaultHostnameVerifier() Returns the default hostname verifier.
static SSLSocketFactory	getDefaultSSLSocketFactory() Returns the default SSL socket factory for new instances.
HostnameVerifier	getHostnameVerifier() Returns the hostname verifier used by this instance.
abstract Certificate[]	getLocalCertificates() Returns the list of local certificates used during the handshake.
Principal	getLocalPrincipal() Returns the `Principal` used to identify the local host during the handshake.
Principal	getPeerPrincipal() Returns the `Principal` identifying the peer.
SSLSocketFactory	getSSLSocketFactory() Returns the SSL socket factory used by this instance.
abstract Certificate[]	getServerCertificates() Return the list of certificates identifying the peer during the handshake.
static void	setDefaultHostnameVerifier(HostnameVerifier v) Sets the default hostname verifier to be used by new instances.
static void	setDefaultSSLSocketFactory(SSLSocketFactory sf) Sets the default SSL socket factory to be used by new instances.
void	setHostnameVerifier(HostnameVerifier v) Sets the hostname verifier for this instance.
void	setSSLSocketFactory(SSLSocketFactory sf) Sets the SSL socket factory for this instance.

[Expand]

Inherited Methods

From class java.net.HttpURLConnection

abstract void	disconnect() Closes the connection to the HTTP server.
String	getContentEncoding() Returns the encoding used to transmit the response body over the network.
InputStream	getErrorStream() Returns an input stream from the server in the case of an error such as the requested file has not been found on the remote server.
static boolean	getFollowRedirects() Returns the value of `followRedirects` which indicates if this connection follows a different URL redirected by the server.
long	getHeaderFieldDate(String field, long defaultValue) Returns the date value in milliseconds since `01.01.1970, 00:00h` corresponding to the header field `field`.
boolean	getInstanceFollowRedirects() Returns whether this connection follows redirects.
Permission	getPermission() Returns the permission object (in this case `SocketPermission`) with the host and the port number as the target name and `"resolve, connect"` as the action list.
String	getRequestMethod() Returns the request method which will be used to make the request to the remote HTTP server.
int	getResponseCode() Returns the response code returned by the remote HTTP server.
String	getResponseMessage() Returns the response message returned by the remote HTTP server.
void	setChunkedStreamingMode(int chunkLength) Stream a request body whose length is not known in advance.
void	setFixedLengthStreamingMode(int contentLength) If the length of a HTTP request body is known ahead, sets fixed length to enable streaming without buffering.
static void	setFollowRedirects(boolean auto) Sets the flag of whether this connection will follow redirects returned by the remote server.
void	setInstanceFollowRedirects(boolean followRedirects) Sets whether this connection follows redirects.
void	setRequestMethod(String method) Sets the request command which will be sent to the remote HTTP server.
abstract boolean	usingProxy() Returns whether this connection uses a proxy server or not.

From class java.net.URLConnection

void	addRequestProperty(String field, String newValue) Adds the given property to the request header.
abstract void	connect() Opens a connection to the resource.
boolean	getAllowUserInteraction() Returns the option value which indicates whether user interaction is allowed on this `URLConnection`.
int	getConnectTimeout() Returns the configured connecting timeout.
Object	getContent() Returns an object representing the content of the resource this `URLConnection` is connected to.
Object	getContent(Class[] types) Returns an object representing the content of the resource this `URLConnection` is connected to.
String	getContentEncoding() Returns the content encoding type specified by the response header field `content-encoding` or `null` if this field is not set.
int	getContentLength() Returns the content length in bytes specified by the response header field `content-length` or `-1` if this field is not set.
String	getContentType() Returns the MIME-type of the content specified by the response header field `content-type` or `null` if type is unknown.
long	getDate() Returns the timestamp when this response has been sent as a date in milliseconds since January 1, 1970 GMT or `0` if this timestamp is unknown.
static boolean	getDefaultAllowUserInteraction() Returns the default setting whether this connection allows user interaction.
static String	getDefaultRequestProperty(String field) This method is deprecated. Use `getRequestProperty(String)`
boolean	getDefaultUseCaches() Returns the default setting whether this connection allows using caches.
boolean	getDoInput() Returns the value of the option `doInput` which specifies whether this connection allows to receive data.
boolean	getDoOutput() Returns the value of the option `doOutput` which specifies whether this connection allows to send data.
long	getExpiration() Returns the timestamp when this response will be expired in milliseconds since January 1, 1970 GMT or `0` if this timestamp is unknown.
static FileNameMap	getFileNameMap() Returns the table which is used by all `URLConnection` instances to determine the MIME-type according to a file extension.
String	getHeaderField(String key) Returns the value of the header field specified by `key` or `null` if there is no field with this name.
String	getHeaderField(int pos) Returns the header value at the field position `pos` or `null` if the header has fewer than `pos` fields.
long	getHeaderFieldDate(String field, long defaultValue) Returns the specified header value as a date in milliseconds since January 1, 1970 GMT.
int	getHeaderFieldInt(String field, int defaultValue) Returns the specified header value as a number.
String	getHeaderFieldKey(int posn) Returns the name of the header field at the given position `posn` or `null` if there are fewer than `posn` fields.
Map<String, List<String>>	getHeaderFields() Returns an unchangeable map of the response-header fields and values.
long	getIfModifiedSince() Returns the point of time since when the data must be modified to be transmitted.
InputStream	getInputStream() Returns an `InputStream` for reading data from the resource pointed by this `URLConnection`.
long	getLastModified() Returns the value of the response header field `last-modified` or `0` if this value is not set.
OutputStream	getOutputStream() Returns an `OutputStream` for writing data to this `URLConnection`.
Permission	getPermission() Returns a `Permission` object representing all needed permissions to open this connection.
int	getReadTimeout() Returns the configured timeout for reading from the input stream of an established connection to the resource.
Map<String, List<String>>	getRequestProperties() Returns an unchangeable map of general request properties used by this connection.
String	getRequestProperty(String field) Returns the value of the request header property specified by {code field} or `null` if there is no field with this name.
URL	getURL() Returns the URL represented by this `URLConnection`.
boolean	getUseCaches() Returns the value of the flag which specifies whether this `URLConnection` allows to use caches.
static String	guessContentTypeFromName(String url) Determines the MIME-type of the given resource `url` by resolving the filename extension with the internal FileNameMap.
static String	guessContentTypeFromStream(InputStream is) Determines the MIME-type of the resource represented by the input stream `is` by reading its first few characters.
void	setAllowUserInteraction(boolean newValue) Sets the flag indicating whether this connection allows user interaction or not.
void	setConnectTimeout(int timeout) Sets the timeout value in milliseconds for establishing the connection to the resource pointed by this `URLConnection` instance.
synchronized static void	setContentHandlerFactory(ContentHandlerFactory contentFactory) Sets the internally used content handler factory.
static void	setDefaultAllowUserInteraction(boolean allows) Sets the default value for the flag indicating whether this connection allows user interaction or not.
static void	setDefaultRequestProperty(String field, String value) This method is deprecated. Use `setRequestProperty(String, String)` of an existing `URLConnection` instance.
void	setDefaultUseCaches(boolean newValue) Sets the default value for the flag indicating whether this connection allows to use caches.
void	setDoInput(boolean newValue) Sets the flag indicating whether this `URLConnection` allows input.
void	setDoOutput(boolean newValue) Sets the flag indicating whether this `URLConnection` allows output.
static void	setFileNameMap(FileNameMap map) Sets the internal map which is used by all `URLConnection` instances to determine the MIME-type according to a filename extension.
void	setIfModifiedSince(long newValue) Sets the point of time since when the data must be modified to be transmitted.
void	setReadTimeout(int timeout) Sets the timeout value in milliseconds for reading from the input stream of an established connection to the resource.
void	setRequestProperty(String field, String newValue) Sets the value of the specified request header field.
void	setUseCaches(boolean newValue) Sets the flag indicating whether this connection allows to use caches or not.
String	toString() Returns the string representation containing the name of this class and the URL.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Fields

protected HostnameVerifier hostnameVerifier

Since: API Level 1

The host name verifier used by this connection. It is initialized from the default hostname verifier setDefaultHostnameVerifier(HostnameVerifier) or getDefaultHostnameVerifier().

Protected Constructors

protected HttpsURLConnection (URL url)

Since: API Level 1

Creates a new HttpsURLConnection with the specified URL.

Parameters

url	the `URL` to connect to.

Public Methods

public abstract String getCipherSuite ()

Since: API Level 1

Returns the name of the cipher suite negotiated during the SSL handshake.

Returns

the name of the cipher suite negotiated during the SSL handshake.

Throws

IllegalStateException	if no connection has been established yet.

public static HostnameVerifier getDefaultHostnameVerifier ()

Since: API Level 1

Returns the default hostname verifier.

Returns

the default hostname verifier.

public static SSLSocketFactory getDefaultSSLSocketFactory ()

Since: API Level 1

Returns the default SSL socket factory for new instances.

Returns

the default SSL socket factory for new instances.

public HostnameVerifier getHostnameVerifier ()

Since: API Level 1

Returns the hostname verifier used by this instance.

Returns

the hostname verifier used by this instance.

public abstract Certificate[] getLocalCertificates ()

Since: API Level 1

Returns the list of local certificates used during the handshake. These certificates were sent to the peer.

Returns

Returns the list of certificates used during the handshake with the local identity certificate followed by CAs, or null if no certificates were used during the handshake.

Throws

IllegalStateException	if no connection has been established yet.

public Principal getLocalPrincipal ()

Since: API Level 1

Returns the Principal used to identify the local host during the handshake.

Returns

the Principal used to identify the local host during the handshake, or null if none was used.

Throws

IllegalStateException	if no connection has been established yet.

public Principal getPeerPrincipal ()

Since: API Level 1

Returns the Principal identifying the peer.

Returns

the Principal identifying the peer.

Throws

SSLPeerUnverifiedException	if the identity of the peer has not been verified.
IllegalStateException	if no connection has been established yet.

public SSLSocketFactory getSSLSocketFactory ()

Since: API Level 1

Returns the SSL socket factory used by this instance.

Returns

the SSL socket factory used by this instance.

public abstract Certificate[] getServerCertificates ()

Since: API Level 1

Return the list of certificates identifying the peer during the handshake.

Returns

the list of certificates identifying the peer with the peer's identity certificate followed by CAs.

Throws

SSLPeerUnverifiedException	if the identity of the peer has not been verified..
IllegalStateException	if no connection has been established yet.

public static void setDefaultHostnameVerifier (HostnameVerifier v)

Since: API Level 1

Sets the default hostname verifier to be used by new instances.

Parameters

v	the new default hostname verifier

Throws

IllegalArgumentException	if the specified verifier is `null`.

public static void setDefaultSSLSocketFactory (SSLSocketFactory sf)

Since: API Level 1

Sets the default SSL socket factory to be used by new instances.

Parameters

sf	the new default SSL socket factory.

Throws

IllegalArgumentException	if the specified socket factory is `null`.

public void setHostnameVerifier (HostnameVerifier v)

Since: API Level 1

Sets the hostname verifier for this instance.

Parameters

v	the hostname verifier for this instance.

Throws

IllegalArgumentException	if the specified verifier is `null`.

public void setSSLSocketFactory (SSLSocketFactory sf)

Since: API Level 1

Sets the SSL socket factory for this instance.

Parameters

sf	the SSL socket factory to be used by this instance.

Throws

IllegalArgumentException	if the specified socket factory is `null`.

Interfaces

Classes

Enums

Exceptions

HttpsURLConnection

Class Overview

Summary

Fields

protected HostnameVerifier hostnameVerifier

Protected Constructors

protected HttpsURLConnection (URL url)

Parameters

Public Methods

public abstract String getCipherSuite ()

Returns

Throws

public static HostnameVerifier getDefaultHostnameVerifier ()

Returns

public static SSLSocketFactory getDefaultSSLSocketFactory ()

Returns

public HostnameVerifier getHostnameVerifier ()

Returns

public abstract Certificate[] getLocalCertificates ()

Returns

Throws

public Principal getLocalPrincipal ()

Returns

Throws

public Principal getPeerPrincipal ()

Returns

Throws

public SSLSocketFactory getSSLSocketFactory ()

Returns

public abstract Certificate[] getServerCertificates ()

Returns

Throws

public static void setDefaultHostnameVerifier (HostnameVerifier v)

Parameters

Throws

public static void setDefaultSSLSocketFactory (SSLSocketFactory sf)

Parameters

Throws

public void setHostnameVerifier (HostnameVerifier v)

Parameters

Throws

public void setSSLSocketFactory (SSLSocketFactory sf)

Parameters

Throws