HttxURLConnection (slcshttps)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

nl.nikhef.slcshttps.trust
Class HttxURLConnection

java.lang.Object
  java.net.URLConnection
      java.net.HttpURLConnection
          javax.net.ssl.HttpsURLConnection
              nl.nikhef.slcshttps.trust.HttxURLConnection

public class HttxURLConnection
extends HttpsURLConnection
extends HttpsURLConnection

This class extends a HttpsURLConnection that can use a TrustManager that not only can check the certificate chain but also the hostname against the server certificate. More details can be found in the package description.
In addition it can also warn the user when his/her client certificate is about to expire or has already expired. Communication about this is handled by an implementation of HttxURLConnection.HttxClientCommunicator. An implementation using just stdio is given by HttxURLConnection.StdioComm. It can be configured using the following system properties:

"nl.nikhef.slcshttps.httxclientwarn" - true or false, whether to warn for (almost) expired client certificates. Can also be set using setExpire(String).
"nl.nikhef.slcshttps.httxclientwarntime" - time before expiry, in seconds, to give a warning. Another warning will be given first time after expiry. Can also be set using setExpireWarnTime(String).
"nl.nikhef.slcshttps.comm" - type of communication, either "stdio" or "popup", when unset, "stdio" is used. Can also be set using setCommunicator(String).

HttxURLConnection is implemented as a delegate class for HttpsURLConnection since that class is abstract while its actual implementation is kept internal in the JDK API. Note that undocumented overriding methods just call the corresponding overridden method of the implementation, see the overridden methods for documentation.

Version:: 0.1
Author:: Mischa Sallé

Nested Class Summary
`static interface`	`HttxURLConnection.HttxClientCommunicator` Interface for `HttxURLConnection` communication about client certificate expiration.
`(package private) static class`	`HttxURLConnection.StdioComm` This Implementation uses only `stdio/stderr` for I/O.

Field Summary
`private static boolean`	`clientExpireAcknowl` Whether a warning has been given about expiry.
`private static Date`	`clientExpireDate` Expiry time of client side certificate (`null` for unset), can be set using `setClientExpireDate(Date)`.
`private static boolean`	`clientExpireWarn` Whether we want warnings, set at class initialization using the property "nl.nikhef.slcshttps.httxclientwarn" or using `setExpire(String)`.
`private static boolean`	`clientExpireWarnAcknowl` Whether a warning has been given about imminent expiry.
`private static long`	`clientExpireWarnTime` Time in milliseconds before expiry to warn the user, use 0 for warning only after actual expiry, set at class initialization using the property "nl.nikhef.slcshttps.httxclientwarntime" or using `setExpireWarnTime(String)`.
`private static HttxURLConnection.HttxClientCommunicator`	`comm` The `HttxURLConnection.HttxClientCommunicator` used for communication about client certificate expiry, can be set using `setCommunicator(String)`.
`private static String`	`COMMPROP` Name of property that sets the type of communicator: "nl.nikhef.slcshttps.comm", can be overridden using `setCommunicator(String)`.
`private static String`	`commString` describes the type of communicator in use, initialized using the value of property "nl.nikhef.slcshttps.comm" by `setCommunicator(String)`.
`private static SSLSocketFactory`	`defaultSSLSocketFactory` Default `SSLSocketFactory`, is initialized with an empty set of `KeyManager` and a `TrustManagerImpl`.
`private static String`	`EXPIREPROP` Name of property that determines whether to warn: "nl.nikhef.slcshttps.httxclientwarn", default is true, see also `EXPIRETIMEPROP`, can be overridden using `setExpire(String)`.
`private static String`	`EXPIRETIMEPROP` Name of property that determines when to give an 'about-to-expire' warning: "nl.nikhef.slcshttps.httxclientwarntime", value is number of seconds; when it is unspecified or invalid, 0 is assumed and only a warning upon actual expiry is given, see also `EXPIREPROP`, can be overridden using `setExpireWarnTime(String)`.
`private String`	`hostName` hostname part of the `URL`.
`private static HostnameVerifier`	`hostVerifier` Default `HostnameVerifier`, is initialized to a trivial one, since all functionality is in the `TrustManagerImpl`.
`private HttpURLConnection`	`httpImpl` Masked `HttpURLConnection` or `HttpsURLConnection`.
`private int`	`portNumber` portnumber of the `URL`.
`private boolean`	`ssl` whether this is a HTTPS or HTTP connection.
`private URL`	`url` `URL` of the connection.

Fields inherited from class javax.net.ssl.HttpsURLConnection
`hostnameVerifier`

Fields inherited from class java.net.HttpURLConnection
chunkLength, fixedContentLength, HTTP_ACCEPTED, HTTP_BAD_GATEWAY, HTTP_BAD_METHOD, HTTP_BAD_REQUEST, HTTP_CLIENT_TIMEOUT, HTTP_CONFLICT, HTTP_CREATED, HTTP_ENTITY_TOO_LARGE, HTTP_FORBIDDEN, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_INTERNAL_ERROR, HTTP_LENGTH_REQUIRED, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_MULT_CHOICE, HTTP_NO_CONTENT, HTTP_NOT_ACCEPTABLE, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_PARTIAL, HTTP_PAYMENT_REQUIRED, HTTP_PRECON_FAILED, HTTP_PROXY_AUTH, HTTP_REQ_TOO_LONG, HTTP_RESET, HTTP_SEE_OTHER, HTTP_SERVER_ERROR, HTTP_UNAUTHORIZED, HTTP_UNAVAILABLE, HTTP_UNSUPPORTED_TYPE, HTTP_USE_PROXY, HTTP_VERSION, instanceFollowRedirects, method, responseCode, responseMessage

Fields inherited from class java.net.HttpURLConnection

chunkLength, fixedContentLength, HTTP_ACCEPTED, HTTP_BAD_GATEWAY, HTTP_BAD_METHOD, HTTP_BAD_REQUEST, HTTP_CLIENT_TIMEOUT, HTTP_CONFLICT, HTTP_CREATED, HTTP_ENTITY_TOO_LARGE, HTTP_FORBIDDEN, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_INTERNAL_ERROR, HTTP_LENGTH_REQUIRED, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_MULT_CHOICE, HTTP_NO_CONTENT, HTTP_NOT_ACCEPTABLE, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_PARTIAL, HTTP_PAYMENT_REQUIRED, HTTP_PRECON_FAILED, HTTP_PROXY_AUTH, HTTP_REQ_TOO_LONG, HTTP_RESET, HTTP_SEE_OTHER, HTTP_SERVER_ERROR, HTTP_UNAUTHORIZED, HTTP_UNAVAILABLE, HTTP_UNSUPPORTED_TYPE, HTTP_USE_PROXY, HTTP_VERSION, instanceFollowRedirects, method, responseCode, responseMessage

Fields inherited from class java.net.URLConnection
`allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, useCaches`

Constructor Summary
`HttxURLConnection(HttpURLConnection httpConnection)` Constructs a `HttxURLConnection` from given `HttpURLConnection` or `HttpsURLConnection` (a subclass of the former).
`HttxURLConnection(URL url)` Constructs a `HttxURLConnection` to `url`.

Method Summary
`void`	`addRequestProperty(String arg0, String arg1)`
`static boolean`	`checkClientExpire()` Static method checking the client certificate, using status flags to determine whether to warn the user the certificate expiry is imminent, is already expired etc.
`void`	`connect()` Connects an opened `HttxURLConnection`.
`void`	`disconnect()` Disconnects an opened `HttxURLConnection`, which also resets the hostname and portnumber for the `TrustManagerImpl`.
`boolean`	`equals(Object arg0)`
`boolean`	`getAllowUserInteraction()`
`String`	`getCipherSuite()`
`static Date`	`getClientExpireDate()` Method to get the expiry `Date` of the client side certificate, `null` for no certificate.
`static String`	`getCommunicator()` Returns the type of `HttxURLConnection.HttxClientCommunicator` used for user interaction.
`int`	`getConnectTimeout()`
`Object`	`getContent()`
`Object`	`getContent(Class[] arg0)`
`String`	`getContentEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`long`	`getDate()`
`static boolean`	`getDefaultAllowUserInteraction()` Calls `URLConnection.getDefaultAllowUserInteraction()`.
`static HostnameVerifier`	`getDefaultHostnameVerifier()` Method to get the default `HostnameVerifier` for `HttxURLConnection`.
`static SSLSocketFactory`	`getDefaultSSLSocketFactory()` Method to get the default `SSLSocketFactory` for `HttxURLConnection`.
`boolean`	`getDefaultUseCaches()`
`boolean`	`getDoInput()`
`boolean`	`getDoOutput()`
`InputStream`	`getErrorStream()`
`long`	`getExpiration()`
`static boolean`	`getExpire()` Returns whether to check for client certificate expiry and warn about it.
`static long`	`getExpireWarnTime()` Returns the number of milliseconds before actual expiry when a warning about imminent expiry of the client certificate is given.
`static FileNameMap`	`getFileNameMap()` Calls `URLConnection.getFileNameMap()`.
`static boolean`	`getFollowRedirects()` Calls `HttpURLConnection.getFollowRedirects()`.
`String`	`getHeaderField(int arg0)`
`String`	`getHeaderField(String arg0)`
`long`	`getHeaderFieldDate(String arg0, long arg1)`
`int`	`getHeaderFieldInt(String arg0, int arg1)`
`String`	`getHeaderFieldKey(int arg0)`
`Map<String,List<String>>`	`getHeaderFields()`
`HostnameVerifier`	`getHostnameVerifier()` Method to get the `HostnameVerifier` for `HttxURLConnection`.
`long`	`getIfModifiedSince()`
`InputStream`	`getInputStream()`
`boolean`	`getInstanceFollowRedirects()`
`long`	`getLastModified()`
`Certificate[]`	`getLocalCertificates()`
`Principal`	`getLocalPrincipal()`
`OutputStream`	`getOutputStream()`
`Principal`	`getPeerPrincipal()`
`Permission`	`getPermission()`
`int`	`getReadTimeout()`
`String`	`getRequestMethod()`
`Map<String,List<String>>`	`getRequestProperties()`
`String`	`getRequestProperty(String arg0)`
`int`	`getResponseCode()`
`String`	`getResponseMessage()`
`Certificate[]`	`getServerCertificates()`
`SSLSocketFactory`	`getSSLSocketFactory()`
`URL`	`getURL()`
`boolean`	`getUseCaches()`
`static String`	`guessContentTypeFromName(String arg0)` Calls `URLConnection.guessContentTypeFromName(String)`.
`static String`	`guessContentTypeFromStream(InputStream arg0)` Calls `URLConnection.guessContentTypeFromStream(InputStream)`.
`int`	`hashCode()`
`static HttxURLConnection`	`openConnection(URL url)` Creates and returns a new `HttxURLConnection` for given `url`.
`void`	`setAllowUserInteraction(boolean arg0)`
`void`	`setChunkedStreamingMode(int arg0)`
`static void`	`setClientExpireDate(Date date)` Method to set the expiry `Date` of the client side certificate, `null` for no certificate.
`static String`	`setCommunicator(String commInput)` Sets the type of `HttxURLConnection.HttxClientCommunicator` based on `commInput`.
`void`	`setConnectTimeout(int arg0)`
`static void`	`setContentHandlerFactory(ContentHandlerFactory arg0)` Calls `URLConnection.setContentHandlerFactory(ContentHandlerFactory)`.
`static void`	`setDefaultAllowUserInteraction(boolean arg0)` Calls `URLConnection.setDefaultAllowUserInteraction(boolean)`.
`static void`	`setDefaultHostnameVerifier(HostnameVerifier hostnameVerifier)` Empty setter method, in order to override the method.
`static void`	`setDefaultSSLSocketFactory(SSLSocketFactory sslSocketFactory)` Sets the default `SSLSocketFactory` for `HttxURLConnection`.
`void`	`setDefaultUseCaches(boolean arg0)`
`void`	`setDoInput(boolean arg0)`
`void`	`setDoOutput(boolean arg0)`
`static void`	`setExpire(String setString)` Sets whether to check for client certificate expiry and warn about it.
`static void`	`setExpireWarnTime(String timeString)` Sets the time before expiry of a client certificate to give a warning.
`static void`	`setFileNameMap(FileNameMap arg0)` Calls `URLConnection.setFileNameMap(FileNameMap)`.
`void`	`setFixedLengthStreamingMode(int arg0)`
`static void`	`setFollowRedirects(boolean arg0)` Calls `HttpURLConnection.setFollowRedirects(boolean)`.
`void`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)` Empty setter method, in order to override the method.
`void`	`setIfModifiedSince(long arg0)`
`void`	`setInstanceFollowRedirects(boolean arg0)`
`void`	`setReadTimeout(int arg0)`
`void`	`setRequestMethod(String arg0)`
`void`	`setRequestProperty(String arg0, String arg1)`
`void`	`setSSLSocketFactory(SSLSocketFactory arg0)`
`void`	`setUseCaches(boolean arg0)`
`String`	`toString()`
`boolean`	`usingProxy()`

Methods inherited from class java.net.URLConnection
`getDefaultRequestProperty, setDefaultRequestProperty`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

httpImpl

private HttpURLConnection httpImpl

Masked HttpURLConnection or HttpsURLConnection.

defaultSSLSocketFactory

private static SSLSocketFactory defaultSSLSocketFactory

Default SSLSocketFactory, is initialized with an empty set of KeyManager and a TrustManagerImpl.

clientExpireWarn

private static boolean clientExpireWarn

Whether we want warnings, set at class initialization using the property "nl.nikhef.slcshttps.httxclientwarn" or using setExpire(String).

clientExpireWarnTime

private static long clientExpireWarnTime

Time in milliseconds before expiry to warn the user, use 0 for warning only after actual expiry, set at class initialization using the property "nl.nikhef.slcshttps.httxclientwarntime" or using setExpireWarnTime(String).

EXPIREPROP

private static final String EXPIREPROP

Name of property that determines whether to warn: "nl.nikhef.slcshttps.httxclientwarn", default is true, see also EXPIRETIMEPROP, can be overridden using setExpire(String).

See Also:: Constant Field Values

EXPIRETIMEPROP

private static final String EXPIRETIMEPROP

Name of property that determines when to give an 'about-to-expire' warning: "nl.nikhef.slcshttps.httxclientwarntime", value is number of seconds; when it is unspecified or invalid, 0 is assumed and only a warning upon actual expiry is given, see also EXPIREPROP, can be overridden using setExpireWarnTime(String).

See Also:: Constant Field Values

COMMPROP

private static final String COMMPROP

Name of property that sets the type of communicator: "nl.nikhef.slcshttps.comm", can be overridden using setCommunicator(String).

See Also:: Constant Field Values

clientExpireDate

private static Date clientExpireDate

Expiry time of client side certificate (null for unset), can be set using setClientExpireDate(Date).

clientExpireWarnAcknowl

private static boolean clientExpireWarnAcknowl

Whether a warning has been given about imminent expiry.

clientExpireAcknowl

private static boolean clientExpireAcknowl

Whether a warning has been given about expiry.

commString

private static String commString

describes the type of communicator in use, initialized using the value of property "nl.nikhef.slcshttps.comm" by setCommunicator(String).

comm

private static HttxURLConnection.HttxClientCommunicator comm

The HttxURLConnection.HttxClientCommunicator used for communication about client certificate expiry, can be set using setCommunicator(String).

hostVerifier

private static HostnameVerifier hostVerifier

Default HostnameVerifier, is initialized to a trivial one, since all functionality is in the TrustManagerImpl.

url

private URL url

URL of the connection.

hostName

private String hostName

hostname part of the URL.

portNumber

private int portNumber

portnumber of the URL.

ssl

private boolean ssl

whether this is a HTTPS or HTTP connection.

Constructor Detail