public Class HttpsURLConnectionImpl

Overrides java.net.URLConnection.addRequestProperty.

Adds a general request property specified by a key-value pair. This method will not overwrite existing values associated with the same key.

Parameters

key:String

the keyword by which the request is known (e.g., "accept").

value:String

the value associated with it.

Since

1.4

See Also

getRequestProperty(java.lang.String)

Implements abstract java.net.URLConnection.connect.

Implements the HTTP protocol handler's "connect" method, establishing an SSL connection to the server as necessary.

Exceptions

IOException:

Doc from java.net.URLConnection.connect.

if an I/O error occurs while opening the connection.

Implements abstract java.net.HttpURLConnection.disconnect.

Disconnect from the server.

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Overrides java.net.URLConnection.getAllowUserInteraction.

Doc from java.net.URLConnection.getAllowUserInteraction.

Returns the value of the allowUserInteraction field for this object.

Implements abstract javax.net.ssl.HttpsURLConnection.getCipherSuite.

Returns the cipher suite in use on this connection.

Overrides java.net.URLConnection.getConnectTimeout.

Doc from java.net.URLConnection.getConnectTimeout.

Returns setting for connect timeout.

0 return implies that the option is disabled (i.e., timeout of infinity).

Overrides java.net.URLConnection.getContent.

Doc from java.net.URLConnection.getContent.

Retrieves the contents of this URL connection.

This method first determines the content type of the object by calling the getContentType method. If this is the first time that the application has seen that specific content type, a content handler for that content type is created.

This is done as follows:

1. If the application has set up a content handler factory instance using the setContentHandlerFactory method, the createContentHandler method of that instance is called with the content type as an argument; the result is a content handler for that content type.
2. If no ContentHandlerFactory has yet been set up, or if the factory's createContentHandler method returns null, then the ServiceLoader mechanism is used to locate ContentHandlerFactory implementations using the system class loader. The order that factories are located is implementation specific, and an implementation is free to cache the located factories. A ServiceConfigurationError, Error or RuntimeException thrown from the createContentHandler, if encountered, will be propagated to the calling thread. The createContentHandler method of each factory, if instantiated, is invoked, with the content type, until a factory returns non-null, or all factories have been exhausted.
3. Failing that, this method tries to load a content handler class as defined by ContentHandler. If the class does not exist, or is not a subclass of ContentHandler, then an UnknownServiceException is thrown.

Exceptions

IOException:

if an I/O error occurs while getting the content.

Overrides java.net.URLConnection.getContent.

Doc from java.net.URLConnection.getContent.

Retrieves the contents of this URL connection.

Annotations

@SuppressWarnings:rawtypes

Exceptions

IOException:

if an I/O error occurs while getting the content.

Overrides java.net.URLConnection.getContentEncoding.

Doc from java.net.URLConnection.getContentEncoding.

Returns the value of the content-encoding header field.

Overrides java.net.URLConnection.getContentLength.

Doc from java.net.URLConnection.getContentLength.

Returns the value of the content-length header field.

Overrides java.net.URLConnection.getContentLengthLong.

Doc from java.net.URLConnection.getContentLengthLong.

Returns the value of the content-length header field as a long.

Overrides java.net.URLConnection.getContentType.

Doc from java.net.URLConnection.getContentType.

Returns the value of the content-type header field.

Overrides java.net.URLConnection.getDate.

Doc from java.net.URLConnection.getDate.

Returns the value of the date header field.

Overrides java.net.URLConnection.getDefaultUseCaches.

Doc from java.net.URLConnection.getDefaultUseCaches.

Returns the default value of a URLConnection's useCaches flag.

This default is "sticky", being a part of the static state of all URLConnections. This flag applies to the next, and all following URLConnections that are created. This default value can be over-ridden per protocol using setDefaultUseCaches(String, boolean)

Overrides java.net.URLConnection.getDoInput.

Doc from java.net.URLConnection.getDoInput.

Returns the value of this URLConnection's doInput flag.

Overrides java.net.URLConnection.getDoOutput.

Doc from java.net.URLConnection.getDoOutput.

Returns the value of this URLConnection's doOutput flag.

Overrides java.net.HttpURLConnection.getErrorStream.

Doc from java.net.HttpURLConnection.getErrorStream.

Returns the error stream if the connection failed but the server sent useful data nonetheless. The typical example is when an HTTP server responds with a 404, which will cause a FileNotFoundException to be thrown in connect, but the server sent an HTML help page with suggestions as to what to do.

This method will not cause a connection to be initiated. If the connection was not connected, or if the server did not have an error while connecting or if the server had an error but no error data was sent, this method will return null. This is the default.

Overrides java.net.URLConnection.getExpiration.

Doc from java.net.URLConnection.getExpiration.

Returns the value of the expires header field.

Overrides java.net.URLConnection.getHeaderField.

Gets a header field by name. Returns null if not known.

Parameters

name:String

the name of the header field

Overrides java.net.HttpURLConnection.getHeaderField.

Gets a header field by index. Returns null if not known.

Parameters

n:int

the index of the header field

Overrides java.net.HttpURLConnection.getHeaderFieldDate.

Doc from java.net.URLConnection.getHeaderFieldDate.

Returns the value of the named field parsed as date. The result is the number of milliseconds since January 1, 1970 GMT represented by the named field.

This form of getHeaderField exists because some connection types (e.g., http-ng) have pre-parsed headers. Classes for that connection type can override this method and short-circuit the parsing.

Overrides java.net.URLConnection.getHeaderFieldInt.

Doc from java.net.URLConnection.getHeaderFieldInt.

Returns the value of the named field parsed as a number.

This form of getHeaderField exists because some connection types (e.g., http-ng) have pre-parsed headers. Classes for that connection type can override this method and short-circuit the parsing.

Overrides java.net.HttpURLConnection.getHeaderFieldKey.

Gets a header field by index. Returns null if not known.

Parameters

n:int

the index of the header field

Overrides java.net.URLConnection.getHeaderFieldLong.

Doc from java.net.URLConnection.getHeaderFieldLong.

Returns the value of the named field parsed as a number.

This form of getHeaderField exists because some connection types (e.g., http-ng) have pre-parsed headers. Classes for that connection type can override this method and short-circuit the parsing.

Overrides java.net.URLConnection.getHeaderFields.

Returns an unmodifiable Map of the header fields. The Map keys are Strings that represent the response-header field names. Each Map value is an unmodifiable List of Strings that represents the corresponding field values.

Returns:Map<String, List<String>>

a Map of header fields

Since

1.4

Overrides java.net.URLConnection.getIfModifiedSince.

Doc from java.net.URLConnection.getIfModifiedSince.

Returns the value of this object's ifModifiedSince field.

Overrides java.net.URLConnection.getInputStream.

Doc from java.net.URLConnection.getInputStream.

Returns an input stream that reads from this open connection. A SocketTimeoutException can be thrown when reading from the returned input stream if the read timeout expires before data is available for read.

Exceptions

IOException:

if an I/O error occurs while creating the input stream.

Overrides java.net.HttpURLConnection.getInstanceFollowRedirects.

Doc from java.net.HttpURLConnection.getInstanceFollowRedirects.

Returns the value of this HttpURLConnection's instanceFollowRedirects field.

Overrides java.net.URLConnection.getLastModified.

Doc from java.net.URLConnection.getLastModified.

Returns the value of the last-modified header field. The result is the number of milliseconds since January 1, 1970 GMT.

Implements abstract javax.net.ssl.HttpsURLConnection.getLocalCertificates.

Returns the certificate chain the client sent to the server, or null if the client did not authenticate.

Overrides javax.net.ssl.HttpsURLConnection.getLocalPrincipal.

Returns the principal the client sent to the server, or null if the client did not authenticate.

Overrides java.net.URLConnection.getOutputStream.

Doc from java.net.URLConnection.getOutputStream.

Returns an output stream that writes to this connection.

Exceptions

IOException:

if an I/O error occurs while creating the output stream.

Overrides javax.net.ssl.HttpsURLConnection.getPeerPrincipal.

Returns the principal with which the server authenticated itself, or throw a SSLPeerUnverifiedException if the server did not authenticate.

Exceptions

SSLPeerUnverifiedException:

Doc from javax.net.ssl.HttpsURLConnection.getPeerPrincipal.

if the peer was not verified

Overrides java.net.HttpURLConnection.getPermission.

Doc from java.net.HttpURLConnection.getPermission.

Returns a SocketPermission object representing the permission necessary to connect to the destination host and port.

Annotations

@Override

@Deprecated

since:25

forRemoval:true

@SuppressWarnings:removal

Exceptions

IOException:

if an error occurs while computing the permission.

Overrides java.net.URLConnection.getReadTimeout.

Doc from java.net.URLConnection.getReadTimeout.

Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).

Overrides java.net.HttpURLConnection.getRequestMethod.

Doc from java.net.HttpURLConnection.getRequestMethod.

Get the request method.

Overrides java.net.URLConnection.getRequestProperties.

Returns an unmodifiable Map of general request properties for this connection. The Map keys are Strings that represent the request-header field names. Each Map value is a unmodifiable List of Strings that represents the corresponding field values.

Returns:Map<String, List<String>>

a Map of the general request properties for this connection.

Exceptions

IllegalStateException:

if already connected

Since

1.4

Overrides java.net.URLConnection.getRequestProperty.

Doc from java.net.URLConnection.getRequestProperty.

Returns the value of the named general request property for this connection.

Overrides java.net.HttpURLConnection.getResponseCode.

Overwrite super class method

Exceptions

IOException:

Doc from java.net.HttpURLConnection.getResponseCode.

if an error occurred connecting to the server.

Overrides java.net.HttpURLConnection.getResponseMessage.

Doc from java.net.HttpURLConnection.getResponseMessage.

Gets the HTTP response message, if any, returned along with the response code from a server. From responses like:

HTTP/1.0 200 OK
HTTP/1.0 404 Not Found

Exceptions

IOException:

if an error occurred connecting to the server.

Implements abstract javax.net.ssl.HttpsURLConnection.getServerCertificates.

Returns the server's certificate chain, or throws SSLPeerUnverified Exception if the server did not authenticate.

Exceptions

SSLPeerUnverifiedException:

Doc from javax.net.ssl.HttpsURLConnection.getServerCertificates.

if the peer is not verified.

Overrides javax.net.ssl.HttpsURLConnection.getSSLSession.

Doc from javax.net.ssl.HttpsURLConnection.getSSLSession.

Returns an Optional containing the SSLSession in use on this connection. Returns an empty Optional if the underlying implementation does not support this method.

Annotations

@Override

Overrides java.net.URLConnection.getURL.

Doc from java.net.URLConnection.getURL.

Returns the value of this URLConnection's URL field.

Overrides java.net.URLConnection.getUseCaches.

Doc from java.net.URLConnection.getUseCaches.

Returns the value of this URLConnection's useCaches field.

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Overrides java.net.URLConnection.setAllowUserInteraction.

Doc from java.net.URLConnection.setAllowUserInteraction.

Set the value of the allowUserInteraction field of this URLConnection.

Overrides java.net.HttpURLConnection.setAuthenticator.

Doc from java.net.HttpURLConnection.setAuthenticator.

Supplies an Authenticator to be used when authentication is requested through the HTTP protocol for this HttpURLConnection. If no authenticator is supplied, the default authenticator will be used.

Annotations

@Override

Overrides java.net.HttpURLConnection.setChunkedStreamingMode.

Doc from java.net.HttpURLConnection.setChunkedStreamingMode.

This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is not known in advance. In this mode, chunked transfer encoding is used to send the request body. Note, not all HTTP servers support this mode.

When output streaming is enabled, authentication and redirection cannot be handled automatically. A HttpRetryException will be thrown when reading the response if authentication or redirection are required. This exception can be queried for the details of the error.

This method must be called before the URLConnection is connected.

Overrides java.net.URLConnection.setConnectTimeout.

Doc from java.net.URLConnection.setConnectTimeout.

Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Some non-standard implementation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().

Overrides java.net.URLConnection.setDefaultUseCaches.

Doc from java.net.URLConnection.setDefaultUseCaches.

Sets the default value of the useCaches field to the specified value. This default value can be over-ridden per protocol using setDefaultUseCaches(String, boolean)

Overrides java.net.URLConnection.setDoInput.

Doc from java.net.URLConnection.setDoInput.

Sets the value of the doInput field for this URLConnection to the specified value.

A URL connection can be used for input and/or output. Set the doInput flag to true if you intend to use the URL connection for input, false if not. The default is true.

Overrides java.net.URLConnection.setDoOutput.

Doc from java.net.URLConnection.setDoOutput.

Sets the value of the doOutput field for this URLConnection to the specified value.

A URL connection can be used for input and/or output. Set the doOutput flag to true if you intend to use the URL connection for output, false if not. The default is false.

Overrides java.net.HttpURLConnection.setFixedLengthStreamingMode.

Doc from java.net.HttpURLConnection.setFixedLengthStreamingMode.

This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is known in advance.

An exception will be thrown if the application attempts to write more data than the indicated content-length, or if the application closes the OutputStream before writing the indicated amount.

When output streaming is enabled, authentication and redirection cannot be handled automatically. A HttpRetryException will be thrown when reading the response if authentication or redirection are required. This exception can be queried for the details of the error.

This method must be called before the URLConnection is connected.

Overrides java.net.HttpURLConnection.setFixedLengthStreamingMode.

Doc from java.net.HttpURLConnection.setFixedLengthStreamingMode.

This method is used to enable streaming of a HTTP request body without internal buffering, when the content length is known in advance.

An exception will be thrown if the application attempts to write more data than the indicated content-length, or if the application closes the OutputStream before writing the indicated amount.

When output streaming is enabled, authentication and redirection cannot be handled automatically. A HttpRetryException will be thrown when reading the response if authentication or redirection are required. This exception can be queried for the details of the error.

This method must be called before the URLConnection is connected.

The content length set by invoking this method takes precedence over any value set by setFixedLengthStreamingMode(int).

Overrides java.net.URLConnection.setIfModifiedSince.

Doc from java.net.URLConnection.setIfModifiedSince.

Sets the value of the ifModifiedSince field of this URLConnection to the specified value.

Overrides java.net.HttpURLConnection.setInstanceFollowRedirects.

Doc from java.net.HttpURLConnection.setInstanceFollowRedirects.

Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this HttpURLConnection instance.

The default value comes from followRedirects, which defaults to true.

Overrides java.net.URLConnection.setReadTimeout.

Doc from java.net.URLConnection.setReadTimeout.

Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Some non-standard implementation of this method ignores the specified timeout. To see the read timeout set, please call getReadTimeout().

Overrides java.net.HttpURLConnection.setRequestMethod.

Doc from java.net.HttpURLConnection.setRequestMethod.

Set the method for the URL request, one of:

• GET
• POST
• HEAD
• OPTIONS
• PUT
• DELETE
• TRACE

Exceptions

ProtocolException:

if the method cannot be reset or if the requested method isn't valid for HTTP.

Overrides java.net.URLConnection.setRequestProperty.

Sets request property. If a property with the key already exists, overwrite its value with the new value.

Parameters

value:String

the value to be set

Overrides java.net.URLConnection.setUseCaches.

Doc from java.net.URLConnection.setUseCaches.

Sets the value of the useCaches field of this URLConnection to the specified value.

Some protocols do caching of documents. Occasionally, it is important to be able to "tunnel through" and ignore the caches (e.g., the "reload" button in a browser). If the UseCaches flag on a connection is true, the connection is allowed to use whatever caches it can. If false, caches are to be ignored. The default value comes from defaultUseCaches, which defaults to true. A default value can also be set per-protocol using setDefaultUseCaches(String, boolean).

Overrides java.net.URLConnection.toString.

Doc from java.net.URLConnection.toString.

Returns a String representation of this URL connection.

Implements abstract java.net.HttpURLConnection.usingProxy.

Doc from java.net.HttpURLConnection.usingProxy.

Indicates if the connection is going through a proxy. This method returns true if the connection is known to be going or has gone through proxies, and returns false if the connection will never go through a proxy or if the use of a proxy cannot be determined.