Apache CXF API

org.apache.cxf.transport.https
Class HttpsURLConnectionFactory

java.lang.Object
  extended by org.apache.cxf.transport.https.HttpsURLConnectionFactory
All Implemented Interfaces:
HttpURLConnectionFactory

public final class HttpsURLConnectionFactory
extends Object
implements HttpURLConnectionFactory

This HttpsURLConnectionFactory implements the HttpURLConnectionFactory for using the given SSL Policy to configure TLS connections for "https:" URLs.


Field Summary
static String HTTPS_URL_PROTOCOL_ID
          This constant holds the URL Protocol Identifier for HTTPS
 
Constructor Summary
HttpsURLConnectionFactory(TLSClientParameters params)
          This constructor initialized the factory with the configured TLS Client Parameters for the HTTPConduit for which this factory is used.
 
Method Summary
protected  void addLogHandler(Handler handler)
           
 HttpURLConnection createConnection(Proxy proxy, URL url)
          Create a HttpURLConnection, proxified if necessary.
protected  void decorateWithTLS(HttpURLConnection connection)
          This method assigns the various TLS parameters on the HttpsURLConnection from the TLS Client Parameters.
 HttpURLConnectionInfo getConnectionInfo(HttpURLConnection connection)
          This operation returns an HttpsURLConnectionInfo for the given HttpsURLConnection.
 String getProtocol()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTTPS_URL_PROTOCOL_ID

public static final String HTTPS_URL_PROTOCOL_ID
This constant holds the URL Protocol Identifier for HTTPS

See Also:
Constant Field Values
Constructor Detail

HttpsURLConnectionFactory

public HttpsURLConnectionFactory(TLSClientParameters params)
This constructor initialized the factory with the configured TLS Client Parameters for the HTTPConduit for which this factory is used.

Parameters:
params - The TLS Client Parameters. This parameter is guaranteed to be non-null.
Method Detail

createConnection

public HttpURLConnection createConnection(Proxy proxy,
                                          URL url)
                                   throws IOException
Create a HttpURLConnection, proxified if necessary.

Specified by:
createConnection in interface HttpURLConnectionFactory
Parameters:
proxy - This parameter is non-null if connection should be proxied.
url - The target URL. This parameter must be an https url.
Returns:
The HttpsURLConnection for the given URL.
Throws:
IOException - This exception is thrown if the "url" is not "https" or other IOException is thrown.

decorateWithTLS

protected void decorateWithTLS(HttpURLConnection connection)
                        throws GeneralSecurityException
This method assigns the various TLS parameters on the HttpsURLConnection from the TLS Client Parameters. Connection parameter is of supertype HttpURLConnection, which allows internal cast to potentially divergent subtype (https) implementations.

Throws:
GeneralSecurityException

addLogHandler

protected void addLogHandler(Handler handler)

getConnectionInfo

public HttpURLConnectionInfo getConnectionInfo(HttpURLConnection connection)
                                        throws IOException
This operation returns an HttpsURLConnectionInfo for the given HttpsURLConnection.

Specified by:
getConnectionInfo in interface HttpURLConnectionFactory
Parameters:
connection - The HttpsURLConnection
Returns:
The HttpsURLConnectionInfo object for the given HttpsURLConnection.
Throws:
IOException - Normal IO Exceptions.
ClassCastException - If "connection" is not an HttpsURLConnection (or a supported subtype of HttpURLConnection)

getProtocol

public String getProtocol()
Specified by:
getProtocol in interface HttpURLConnectionFactory
Returns:
the protocol that this connection supports (http or https)

Apache CXF API

Apache CXF