Added in API level 1

HttpsURLConnection

abstract class HttpsURLConnection : HttpURLConnection

kotlin.Any
↳	java.net.URLConnection
	↳	java.net.HttpURLConnection
		↳	javax.net.ssl.HttpsURLConnection

HttpsURLConnection extends HttpURLConnection with support for https-specific features.

See http://www.w3.org/pub/WWW/Protocols/ and RFC 2818 for more details on the https specification.

This class uses HostnameVerifier and SSLSocketFactory. There are default implementations defined for both classes. However, the implementations can be replaced on a per-class (static) or per-instance basis. All new HttpsURLConnections instances will be assigned the "default" static values at instance creation, but they can be overriden by calling the appropriate per-instance set method(s) before connecting.

Summary

Inherited constants

From class HttpURLConnection

`Int`	`HTTP_ACCEPTED` HTTP Status-Code 202: Accepted.
`Int`	`HTTP_BAD_GATEWAY` HTTP Status-Code 502: Bad Gateway.
`Int`	`HTTP_BAD_METHOD` HTTP Status-Code 405: Method Not Allowed.
`Int`	`HTTP_BAD_REQUEST` HTTP Status-Code 400: Bad Request.
`Int`	`HTTP_CLIENT_TIMEOUT` HTTP Status-Code 408: Request Time-Out.
`Int`	`HTTP_CONFLICT` HTTP Status-Code 409: Conflict.
`Int`	`HTTP_CREATED` HTTP Status-Code 201: Created.
`Int`	`HTTP_ENTITY_TOO_LARGE` HTTP Status-Code 413: Request Entity Too Large.
`Int`	`HTTP_FORBIDDEN` HTTP Status-Code 403: Forbidden.
`Int`	`HTTP_GATEWAY_TIMEOUT` HTTP Status-Code 504: Gateway Timeout.
`Int`	`HTTP_GONE` HTTP Status-Code 410: Gone.
`Int`	`HTTP_INTERNAL_ERROR` HTTP Status-Code 500: Internal Server Error.
`Int`	`HTTP_LENGTH_REQUIRED` HTTP Status-Code 411: Length Required.
`Int`	`HTTP_MOVED_PERM` HTTP Status-Code 301: Moved Permanently.
`Int`	`HTTP_MOVED_TEMP` HTTP Status-Code 302: Temporary Redirect.
`Int`	`HTTP_MULT_CHOICE` HTTP Status-Code 300: Multiple Choices.
`Int`	`HTTP_NOT_ACCEPTABLE` HTTP Status-Code 406: Not Acceptable.
`Int`	`HTTP_NOT_AUTHORITATIVE` HTTP Status-Code 203: Non-Authoritative Information.
`Int`	`HTTP_NOT_FOUND` HTTP Status-Code 404: Not Found.
`Int`	`HTTP_NOT_IMPLEMENTED` HTTP Status-Code 501: Not Implemented.
`Int`	`HTTP_NOT_MODIFIED` HTTP Status-Code 304: Not Modified.
`Int`	`HTTP_NO_CONTENT` HTTP Status-Code 204: No Content.
`Int`	`HTTP_OK` HTTP Status-Code 200: OK.
`Int`	`HTTP_PARTIAL` HTTP Status-Code 206: Partial Content.
`Int`	`HTTP_PAYMENT_REQUIRED` HTTP Status-Code 402: Payment Required.
`Int`	`HTTP_PRECON_FAILED` HTTP Status-Code 412: Precondition Failed.
`Int`	`HTTP_PROXY_AUTH` HTTP Status-Code 407: Proxy Authentication Required.
`Int`	`HTTP_REQ_TOO_LONG` HTTP Status-Code 414: Request-URI Too Large.
`Int`	`HTTP_RESET` HTTP Status-Code 205: Reset Content.
`Int`	`HTTP_SEE_OTHER` HTTP Status-Code 303: See Other.
`Int`	`HTTP_SERVER_ERROR` HTTP Status-Code 500: Internal Server Error.
`Int`	`HTTP_UNAUTHORIZED` HTTP Status-Code 401: Unauthorized.
`Int`	`HTTP_UNAVAILABLE` HTTP Status-Code 503: Service Unavailable.
`Int`	`HTTP_UNSUPPORTED_TYPE` HTTP Status-Code 415: Unsupported Media Type.
`Int`	`HTTP_USE_PROXY` HTTP Status-Code 305: Use Proxy.
`Int`	`HTTP_VERSION` HTTP Status-Code 505: HTTP Version Not Supported.

Protected constructors
`HttpsURLConnection(url: URL!)` Creates an `HttpsURLConnection` using the URL specified.

Public methods
abstract String!	`getCipherSuite()` Returns the cipher suite in use on this connection.
open static HostnameVerifier!	`getDefaultHostnameVerifier()` Gets the default `HostnameVerifier` that is inherited by new instances of this class.
open static SSLSocketFactory!	`getDefaultSSLSocketFactory()` Gets the default static `SSLSocketFactory` that is inherited by new instances of this class.
open HostnameVerifier!	`getHostnameVerifier()` Gets the `HostnameVerifier` in place on this instance.
abstract Array<Certificate!>!	`getLocalCertificates()` Returns the certificate(s) that were sent to the server during handshaking.
open Principal!	`getLocalPrincipal()` Returns the principal that was sent to the server during handshaking.
open Principal!	`getPeerPrincipal()` Returns the server's principal which was established as part of defining the session.
open SSLSocketFactory!	`getSSLSocketFactory()` Gets the SSL socket factory to be used when creating sockets for secure https URL connections.
abstract Array<Certificate!>!	`getServerCertificates()` Returns the server's certificate chain which was established as part of defining the session.
open static Unit	`setDefaultHostnameVerifier(v: HostnameVerifier!)` Sets the default `HostnameVerifier` inherited by a new instance of this class.
open static Unit	`setDefaultSSLSocketFactory(sf: SSLSocketFactory!)` Sets the default `SSLSocketFactory` inherited by new instances of this class.
open Unit	`setHostnameVerifier(v: HostnameVerifier!)` Sets the `HostnameVerifier` for this instance.
open Unit	`setSSLSocketFactory(sf: SSLSocketFactory!)` Sets the `SSLSocketFactory` to be used when this instance creates sockets for secure https URL connections.

Inherited functions

From class URLConnection

`Unit`	`addRequestProperty(key: String!, value: String!)` Adds a general request property specified by a key-value pair. This method will not overwrite existing values associated with the same key.
`Unit`	`connect()` Opens a communications link to the resource referenced by this URL, if such a connection has not already been established. If the `connect` method is called when the connection has already been opened (indicated by the `connected` field having the value `true`), the call is ignored. URLConnection objects go through two phases: first they are created, then they are connected. After being created, and before being connected, various options can be specified (e.g., doInput and UseCaches). After connecting, it is an error to try to set them. Operations that depend on being connected, like getContentLength, will implicitly perform the connection, if necessary.
`Boolean`	`getAllowUserInteraction()` Returns the value of the `allowUserInteraction` field for this object.
`Int`	`getConnectTimeout()` Returns setting for connect timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).
`Any!`	`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: 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. If no content handler factory has yet been set up, or if the factory's `createContentHandler` method returns `null`, then the application loads the class named: sun.net.www.content.<<i>contentType</i>> where <contentType> is formed by taking the content-type string, replacing all slash characters with a `period` ('.'), and all other non-alphanumeric characters with the underscore character '`_`'. The alphanumeric characters are specifically the 26 uppercase ASCII letters '`A`' through '`Z`', the 26 lowercase ASCII letters '`a`' through '`z`', and the 10 ASCII digits '`0`' through '`9`'. If the specified class does not exist, or is not a subclass of `ContentHandler`, then an `UnknownServiceException` is thrown.
`Any!`	`getContent(classes: Array<Class<Any!>!>!)` Retrieves the contents of this URL connection.
`String!`	`getContentEncoding()` Returns the value of the `content-encoding` header field.
`Int`	`getContentLength()` Returns the value of the `content-length` header field. Note: `getContentLengthLong()` should be preferred over this method, since it returns a `long` instead and is therefore more portable.
`Long`	`getContentLengthLong()` Returns the value of the `content-length` header field as a long.
`String!`	`getContentType()` Returns the value of the `content-type` header field.
`Long`	`getDate()` Returns the value of the `date` header field.
`Boolean`	`getDefaultAllowUserInteraction()` Returns the default value of the `allowUserInteraction` field. Ths 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.
`String!`	`getDefaultRequestProperty(key: String!)` Returns the value of the default request property. Default request properties are set for every connection.
`Boolean`	`getDefaultUseCaches()` Returns the default value of a `URLConnection`'s `useCaches` flag. Ths 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.
`Boolean`	`getDoInput()` Returns the value of this `URLConnection`'s `doInput` flag.
`Boolean`	`getDoOutput()` Returns the value of this `URLConnection`'s `doOutput` flag.
`Long`	`getExpiration()` Returns the value of the `expires` header field.
`FileNameMap!`	`getFileNameMap()` Returns a `FileNameMap` implementation suitable for guessing a content type based on a URL's "file" component.
`String!`	`getHeaderField(name: String!)` Returns the value of the named header field. If called on a connection that sets the same header multiple times with possibly different values, only the last value is returned.
`Int`	`getHeaderFieldInt(name: String!, Default: Int)` 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.
`Long`	`getHeaderFieldLong(name: String!, Default: Long)` 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.
`MutableMap<String!, MutableList<String!>!>!`	`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.
`Long`	`getIfModifiedSince()` Returns the value of this object's `ifModifiedSince` field.
`InputStream!`	`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.
`Long`	`getLastModified()` Returns the value of the `last-modified` header field. The result is the number of milliseconds since January 1, 1970 GMT.
`OutputStream!`	`getOutputStream()` Returns an output stream that writes to this connection.
`Int`	`getReadTimeout()` Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).
`MutableMap<String!, MutableList<String!>!>!`	`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.
`String!`	`getRequestProperty(key: String!)` Returns the value of the named general request property for this connection.
`URL!`	`getURL()` Returns the value of this `URLConnection`'s `URL` field.
`Boolean`	`getUseCaches()` Returns the value of this `URLConnection`'s `useCaches` field.
`String!`	`guessContentTypeFromName(fname: String!)` Tries to determine the content type of an object, based on the specified "file" component of a URL. This is a convenience method that can be used by subclasses that override the `getContentType` method.
`String!`	`guessContentTypeFromStream(is: InputStream!)` Tries to determine the type of an input stream based on the characters at the beginning of the input stream. This method can be used by subclasses that override the `getContentType` method. Ideally, this routine would not be needed. But many `http` servers return the incorrect content type; in addition, there are many nonstandard extensions. Direct inspection of the bytes to determine the content type is often more accurate than believing the content type claimed by the `http` server.
`Unit`	`setAllowUserInteraction(allowuserinteraction: Boolean)` Set the value of the `allowUserInteraction` field of this `URLConnection`.
`Unit`	`setConnectTimeout(timeout: Int)` 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(). Warning: If the hostname resolves to multiple IP addresses, Android's default implementation of `HttpURLConnection` will try each in RFC 3484 order. If connecting to each of these addresses fails, multiple timeouts will elapse before the connect attempt throws an exception. Host names that support both IPv6 and IPv4 always have at least 2 IP addresses.
`Unit`	`setContentHandlerFactory(fac: ContentHandlerFactory!)` Sets the `ContentHandlerFactory` of an application. It can be called at most once by an application. The `ContentHandlerFactory` instance is used to construct a content handler from a content type If there is a security manager, this method first calls the security manager's `checkSetFactory` method to ensure the operation is allowed. This could result in a SecurityException.
`Unit`	`setDefaultAllowUserInteraction(defaultallowuserinteraction: Boolean)` Sets the default value of the `allowUserInteraction` field for all future `URLConnection` objects to the specified value.
`Unit`	`setDefaultRequestProperty(key: String!, value: String!)` Sets the default value of a general request property. When a `URLConnection` is created, it is initialized with these properties.
`Unit`	`setDefaultUseCaches(defaultusecaches: Boolean)` Sets the default value of the `useCaches` field to the specified value.
`Unit`	`setDoInput(doinput: Boolean)` 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.
`Unit`	`setDoOutput(dooutput: Boolean)` 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.
`Unit`	`setFileNameMap(map: FileNameMap!)` Sets the FileNameMap. If there is a security manager, this method first calls the security manager's `checkSetFactory` method to ensure the operation is allowed. This could result in a SecurityException.
`Unit`	`setIfModifiedSince(ifmodifiedsince: Long)` Sets the value of the `ifModifiedSince` field of this `URLConnection` to the specified value.
`Unit`	`setReadTimeout(timeout: Int)` 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().
`Unit`	`setRequestProperty(key: String!, value: String!)` Sets the general request property. If a property with the key already exists, overwrite its value with the new value. NOTE: HTTP requires all request properties which can legally have multiple instances with the same key to use a comma-separated list syntax which enables multiple properties to be appended into a single property.
`Unit`	`setUseCaches(usecaches: Boolean)` 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.
`String`	`toString()` Returns a `String` representation of this URL connection.

From class HttpURLConnection

`Unit`	`disconnect()` Indicates that other requests to the server are unlikely in the near future. Calling disconnect() should not imply that this HttpURLConnection instance can be reused for other requests.
`InputStream!`	`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.
`Boolean`	`getFollowRedirects()` Returns a `boolean` indicating whether or not HTTP redirects (3xx) should be automatically followed.
`String!`	`getHeaderField(n: Int)` Returns the value for the `n`th header field. Some implementations may treat the `0`th header field as special, i.e. as the status line returned by the HTTP server. This method can be used in conjunction with the `getHeaderFieldKey` method to iterate through all the headers in the message.
`Long`	`getHeaderFieldDate(name: String!, Default: Long)`
`String!`	`getHeaderFieldKey(n: Int)` Returns the key for the `n`th header field. Some implementations may treat the `0`th header field as special, i.e. as the status line returned by the HTTP server. In this case, `getHeaderField(0)` returns the status line, but `getHeaderFieldKey(0)` returns null.
`Boolean`	`getInstanceFollowRedirects()` Returns the value of this `HttpURLConnection`'s `instanceFollowRedirects` field.
`Permission!`	`getPermission()` Returns a `SocketPermission` object representing the permission necessary to connect to the destination host and port.
`String!`	`getRequestMethod()` Get the request method.
`Int`	`getResponseCode()` Gets the status code from an HTTP response message. For example, in the case of the following status lines: HTTP/1.0 200 OK HTTP/1.0 401 Unauthorized It will return 200 and 401 respectively. Returns -1 if no code can be discerned from the response (i.e., the response is not valid HTTP).
`String!`	`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 Extracts the Strings "OK" and "Not Found" respectively. Returns null if none could be discerned from the responses (the result was not valid HTTP).
`Unit`	`setChunkedStreamingMode(chunklen: Int)` 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.
`Unit`	`setFixedLengthStreamingMode(contentLength: Int)` 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. NOTE: `setFixedLengthStreamingMode(long)` is recommended instead of this method as it allows larger content lengths to be set.
`Unit`	`setFixedLengthStreamingMode(contentLength: Long)` 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)`.
`Unit`	`setFollowRedirects(set: Boolean)` Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed by this class. True by default. Applets cannot change this variable. If there is a security manager, this method first calls the security manager's `checkSetFactory` method to ensure the operation is allowed. This could result in a SecurityException.
`Unit`	`setInstanceFollowRedirects(followRedirects: Boolean)` 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.
`Unit`	`setRequestMethod(method: String!)` Set the method for the URL request, one of: GET POST HEAD OPTIONS PUT DELETE TRACE are legal, subject to protocol restrictions. The default method is GET.
`Boolean`	`usingProxy()` Indicates if the connection is going through a proxy.

Properties
HostnameVerifier!	`hostnameVerifier` The `hostnameVerifier` for this object.

Inherited properties

From class URLConnection

`Boolean`	`allowUserInteraction` If `true`, this `URL` is being examined in a context in which it makes sense to allow user interactions such as popping up an authentication dialog. If `false`, then no user interaction is allowed. The value of this field can be set by the `setAllowUserInteraction` method. Its value is returned by the `getAllowUserInteraction` method. Its default value is the value of the argument in the last invocation of the `setDefaultAllowUserInteraction` method.
`Boolean`	`connected` If `false`, this connection object has not created a communications link to the specified URL. If `true`, the communications link has been established.
`Boolean`	`doInput` This variable is set by the `setDoInput` method. Its value is returned by the `getDoInput` method. A URL connection can be used for input and/or output. Setting the `doInput` flag to `true` indicates that the application intends to read data from the URL connection. The default value of this field is `true`.
`Boolean`	`doOutput` This variable is set by the `setDoOutput` method. Its value is returned by the `getDoOutput` method. A URL connection can be used for input and/or output. Setting the `doOutput` flag to `true` indicates that the application intends to write data to the URL connection. The default value of this field is `false`.
`Long`	`ifModifiedSince` Some protocols support skipping the fetching of the object unless the object has been modified more recently than a certain time. A nonzero value gives a time as the number of milliseconds since January 1, 1970, GMT. The object is fetched only if it has been modified more recently than that time. This variable is set by the `setIfModifiedSince` method. Its value is returned by the `getIfModifiedSince` method. The default value of this field is `0`, indicating that the fetching must always occur.
`URL!`	`url` The URL represents the remote object on the World Wide Web to which this connection is opened. The value of this field can be accessed by the `getURL` method. The default value of this variable is the value of the URL argument in the `URLConnection` constructor.
`Boolean`	`useCaches` If `true`, the protocol is allowed to use caching whenever it can. If `false`, the protocol must always try to get a fresh copy of the object. This field is set by the `setUseCaches` method. Its value is returned by the `getUseCaches` method. Its default value is the value given in the last invocation of the `setDefaultUseCaches` method.

From class HttpURLConnection

`Int`	`chunkLength` The chunk-length when using chunked encoding streaming mode for output. A value of `-1` means chunked encoding is disabled for output.
`Int`	`fixedContentLength` The fixed content-length when using fixed-length streaming mode. A value of `-1` means fixed-length streaming mode is disabled for output. NOTE: `fixedContentLengthLong` is recommended instead of this field, as it allows larger content lengths to be set.
`Long`	`fixedContentLengthLong` The fixed content-length when using fixed-length streaming mode. A value of `-1` means fixed-length streaming mode is disabled for output.
`Boolean`	`instanceFollowRedirects` If `true`, the protocol will automatically follow redirects. If `false`, the protocol will not automatically follow redirects. This field is set by the `setInstanceFollowRedirects` method. Its value is returned by the `getInstanceFollowRedirects` method. Its default value is based on the value of the static followRedirects at HttpURLConnection construction time.
`String!`	`method` The HTTP method (GET,POST,PUT,etc.).
`Int`	`responseCode` An `int` representing the three digit HTTP Status-Code. 1xx: Informational 2xx: Success 3xx: Redirection 4xx: Client Error 5xx: Server Error
`String!`	`responseMessage` The HTTP response message.

Protected constructors

HttpsURLConnection

Added in API level 1

protected HttpsURLConnection(url: URL!)

Creates an HttpsURLConnection using the URL specified.

Parameters
`url`	URL!: the URL

Public methods

getCipherSuite

Added in API level 1

abstract fun getCipherSuite(): String!

Returns the cipher suite in use on this connection.

Return
`String!`	the cipher suite

Exceptions
`java.lang.IllegalStateException`	if this method is called before the connection has been established.

getDefaultHostnameVerifier

Added in API level 1

open static fun getDefaultHostnameVerifier(): HostnameVerifier!

Gets the default HostnameVerifier that is inherited by new instances of this class.

Return
`HostnameVerifier!`	the default host name verifier

See Also

#setDefaultHostnameVerifier(HostnameVerifier)

getDefaultSSLSocketFactory

Added in API level 1

open static fun getDefaultSSLSocketFactory(): SSLSocketFactory!

Gets the default static SSLSocketFactory that is inherited by new instances of this class.

The socket factories are used when creating sockets for secure https URL connections.

Return
`SSLSocketFactory!`	the default `SSLSocketFactory`

See Also

#setDefaultSSLSocketFactory(SSLSocketFactory)

getHostnameVerifier

Added in API level 1

open fun getHostnameVerifier(): HostnameVerifier!

Gets the HostnameVerifier in place on this instance.

Return
`HostnameVerifier!`	the host name verifier

See Also

#setHostnameVerifier(HostnameVerifier)
#setDefaultHostnameVerifier(HostnameVerifier)

getLocalCertificates

Added in API level 1

abstract fun getLocalCertificates(): Array<Certificate!>!

Returns the certificate(s) that were sent to the server during handshaking.

Note: This method is useful only when using certificate-based cipher suites.

When multiple certificates are available for use in a handshake, the implementation chooses what it considers the "best" certificate chain available, and transmits that to the other side. This method allows the caller to know which certificate chain was actually sent.

Return
`Array<Certificate!>!`	an ordered array of certificates, with the client's own certificate first followed by any certificate authorities. If no certificates were sent, then null is returned.

Exceptions
`java.lang.IllegalStateException`	if this method is called before the connection has been established.

See Also

#getLocalPrincipal()

getLocalPrincipal

Added in API level 1

open fun getLocalPrincipal(): Principal!

Returns the principal that was sent to the server during handshaking.

Note: Subclasses should override this method. If not overridden, it will default to returning the X500Principal of the end-entity certificate that was sent to the server for certificate-based ciphersuites or, return null for non-certificate based ciphersuites, such as Kerberos.

Return
`Principal!`	the principal sent to the server. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned.

Exceptions
`java.lang.IllegalStateException`	if this method is called before the connection has been established.

See Also

#getLocalCertificates()
#getPeerPrincipal()

getPeerPrincipal

Added in API level 1

open fun getPeerPrincipal(): Principal!

Returns the server's principal which was established as part of defining the session.

Note: Subclasses should override this method. If not overridden, it will default to returning the X500Principal of the server's end-entity certificate for certificate-based ciphersuites, or throw an SSLPeerUnverifiedException for non-certificate based ciphersuites, such as Kerberos.

Return
`Principal!`	the server's principal. Returns an X500Principal of the end-entity certiticate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.

Exceptions
`javax.net.ssl.SSLPeerUnverifiedException`	if the peer was not verified
`java.lang.IllegalStateException`	if this method is called before the connection has been established.

See Also

#getServerCertificates()
#getLocalPrincipal()

getSSLSocketFactory

Added in API level 1

open fun getSSLSocketFactory(): SSLSocketFactory!

Gets the SSL socket factory to be used when creating sockets for secure https URL connections.

Return
`SSLSocketFactory!`	the `SSLSocketFactory`

See Also

#setSSLSocketFactory(SSLSocketFactory)

getServerCertificates

Added in API level 1

abstract fun getServerCertificates(): Array<Certificate!>!

Returns the server's certificate chain which was established as part of defining the session.

Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.

Return
`Array<Certificate!>!`	an ordered array of server certificates, with the peer's own certificate first followed by any certificate authorities.

Exceptions
`javax.net.ssl.SSLPeerUnverifiedException`	if the peer is not verified.
`java.lang.IllegalStateException`	if this method is called before the connection has been established.

See Also

#getPeerPrincipal()

setDefaultHostnameVerifier

Added in API level 1

open static fun setDefaultHostnameVerifier(v: HostnameVerifier!): Unit

Sets the default HostnameVerifier inherited by a new instance of this class.

Developers are strongly discouraged from changing the default HostnameVerifier as getDefaultHostnameVerifier() is used by several classes for hostname verification on Android.

User	Effect
Android's default `TrustManager`, as used with Android's default `SSLContext`, `SSLSocketFactory` and `SSLSocket` implementations.	The `HostnameVerifier` is used to verify the peer's certificate hostname after connecting if `SSLParameters.setEndpointIdentificationAlgorithm("HTTPS")` has been called. Instances use the current default `HostnameVerifier` at verification time.
`android.net.SSLCertificateSocketFactory`	The current default `HostnameVerifier` is used from various `createSocket` methods. See `android.net.SSLCertificateSocketFactory` for details; for example `android.net.SSLCertificateSocketFactory#createSocket(String, int)`.
Android's default `HttpsURLConnection` implementation.	The `HostnameVerifier` is used after a successful TLS handshake to verify the URI host against the TLS session server. Instances use the default `HostnameVerifier` set when they were created unless overridden with `setHostnameVerifier(javax.net.ssl.HostnameVerifier)`. Android's `HttpsURLConnection` relies on the `HostnameVerifier` for the entire hostname verification step.

If this method is not called, the default HostnameVerifier will check the hostname according to RFC 2818.

Parameters
`v`	HostnameVerifier!: the default host name verifier

Exceptions
`java.lang.IllegalArgumentException`	if the `HostnameVerifier` parameter is null.
`java.lang.SecurityException`	if a security manager exists and its `checkPermission` method does not allow `SSLPermission("setHostnameVerifier")`

See Also

#getDefaultHostnameVerifier()

setDefaultSSLSocketFactory

Added in API level 1

open static fun setDefaultSSLSocketFactory(sf: SSLSocketFactory!): Unit

Sets the default SSLSocketFactory inherited by new instances of this class.

The socket factories are used when creating sockets for secure https URL connections.

Parameters
`sf`	SSLSocketFactory!: the default SSL socket factory

Exceptions
`java.lang.IllegalArgumentException`	if the SSLSocketFactory parameter is null.
`java.lang.SecurityException`	if a security manager exists and its `checkSetFactory` method does not allow a socket factory to be specified.

See Also

#getDefaultSSLSocketFactory()

setHostnameVerifier

Added in API level 1

open fun setHostnameVerifier(v: HostnameVerifier!): Unit

Sets the HostnameVerifier for this instance.

New instances of this class inherit the default static hostname verifier set by setDefaultHostnameVerifier. Calls to this method replace this object's HostnameVerifier.

Android's HttpsURLConnection relies on the HostnameVerifier for the entire hostname verification step.

Parameters
`v`	HostnameVerifier!: the host name verifier

Exceptions
`java.lang.IllegalArgumentException`	if the `HostnameVerifier` parameter is null.

See Also

#getHostnameVerifier()
#setDefaultHostnameVerifier(HostnameVerifier)

setSSLSocketFactory

Added in API level 1

open fun setSSLSocketFactory(sf: SSLSocketFactory!): Unit

Sets the SSLSocketFactory to be used when this instance creates sockets for secure https URL connections.

New instances of this class inherit the default static SSLSocketFactory set by setDefaultSSLSocketFactory. Calls to this method replace this object's SSLSocketFactory.

Parameters
`sf`	SSLSocketFactory!: the SSL socket factory

Exceptions
`java.lang.IllegalArgumentException`	if the `SSLSocketFactory` parameter is null.
`java.lang.SecurityException`	if a security manager exists and its `checkSetFactory` method does not allow a socket factory to be specified.

See Also

#getSSLSocketFactory()

Properties

hostnameVerifier

Added in API level 1

protected var hostnameVerifier: HostnameVerifier!

The hostnameVerifier for this object.