javax.net.ssl.HttpsURLConnection — clojure-interop/javax.net 1.0.5

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.

*get-default-hostname-verifier clj

(*get-default-hostname-verifier)

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

returns: the default host name verifier - javax.net.ssl.HostnameVerifier

*get-default-ssl-socket-factory clj

(*get-default-ssl-socket-factory)

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.

returns: the default SSLSocketFactory - javax.net.ssl.SSLSocketFactory

*set-default-hostname-verifier clj

(*set-default-hostname-verifier v)

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

If this method is not called, the default HostnameVerifier assumes the connection should not be permitted.

v - the default host name verifier - javax.net.ssl.HostnameVerifier

throws: java.lang.IllegalArgumentException - if the HostnameVerifier parameter is null.

*set-default-ssl-socket-factory clj

(*set-default-ssl-socket-factory sf)

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

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

sf - the default SSL socket factory - javax.net.ssl.SSLSocketFactory

throws: java.lang.IllegalArgumentException - if the SSLSocketFactory parameter is null.

get-cipher-suite clj

(get-cipher-suite this)

Returns the cipher suite in use on this connection.

returns: the cipher suite - java.lang.String

throws: java.lang.IllegalStateException - if this method is called before the connection has been established.

get-hostname-verifier clj

(get-hostname-verifier this)

Gets the HostnameVerifier in place on this instance.

returns: the host name verifier - javax.net.ssl.HostnameVerifier

get-local-certificates clj

(get-local-certificates this)

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.

returns: 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. - java.security.cert.Certificate[]

throws: java.lang.IllegalStateException - if this method is called before the connection has been established.

get-local-principal clj

(get-local-principal this)

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.

returns: 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. - java.security.Principal

throws: java.lang.IllegalStateException - if this method is called before the connection has been established.

get-peer-principal clj

(get-peer-principal this)

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.

returns: the server's principal. Returns an X500Principal of the end-entity certiticate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. - java.security.Principal

throws: javax.net.ssl.SSLPeerUnverifiedException - if the peer was not verified

get-server-certificates clj

(get-server-certificates this)

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.

returns: an ordered array of server certificates, with the peer's own certificate first followed by any certificate authorities. - java.security.cert.Certificate[]

throws: javax.net.ssl.SSLPeerUnverifiedException - if the peer is not verified.

get-ssl-socket-factory clj

(get-ssl-socket-factory this)

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

returns: the SSLSocketFactory - javax.net.ssl.SSLSocketFactory

set-hostname-verifier clj

(set-hostname-verifier this v)

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.

v - the host name verifier - javax.net.ssl.HostnameVerifier

throws: java.lang.IllegalArgumentException - if the HostnameVerifier parameter is null.

set-ssl-socket-factory clj

(set-ssl-socket-factory this sf)

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.

sf - the SSL socket factory - javax.net.ssl.SSLSocketFactory

throws: java.lang.IllegalArgumentException - if the SSLSocketFactory parameter is null.