org.rhq.enterprise.agent

Class SecureConnector

java.lang.Object

org.rhq.enterprise.agent.SecureConnector

public class SecureConnector
extends Object

If you need to make a connection to an external HTTP server using the https protocol, use this class to build the connection. You can specify which trusted certificates can be used to verify and authenticate the remote server via truststore file parameters passed into the constructor. In other words, you don't have to rely on the global system properties javax.net.ssl.keyStore and javax.net.ssl.trustStore to make your connection. This is useful if some other object running in your JVM requires javax.net.ssl.keyStore/javax.net.ssl.trustStore set to something other than what you want to use. Since those system properties can only be set once during the lifetime of the JVM, it is not possible to change them at runtime and expect the change to take effect. Besides, even if you could change them, this could then effect the other objects that do need those properties set to particular values. This object has the ability to make an encrypted call without requiring a truststore to exist (that is, you can encrypt the call but you will not have the server endpoint verified and authenticated). This can be useful if you aren't concerned with authenticating the endpoint but do want to encrypt the traffic.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
SecureConnector(String secureSocketProtocol) The secure connections built by this object will not authenticate the server endpoint, but they will use the given secure socket protocol to encrypt the connection traffic.
SecureConnector(String secureSocketProtocol, File truststoreFile, String truststorePassword, String truststoreType, String truststoreAlgorithm) The secure connections built by this object will authenticate the server endpoint using the given truststore file and its related parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSecureSocketProtocol()
String	getTruststoreAlgorithm()
File	getTruststoreFile()
String	getTruststorePassword()
String	getTruststoreType()
static void	main(String[] args)
HttpsURLConnection	openSecureConnection(URL url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecureConnector

public SecureConnector(String secureSocketProtocol)

The secure connections built by this object will not authenticate the server endpoint, but they will use the given secure socket protocol to encrypt the connection traffic.

Parameters:

secureSocketProtocol - the secure socket protocol to use (e.g. "TLS")

SecureConnector

public SecureConnector(String secureSocketProtocol,
               File truststoreFile,
               String truststorePassword,
               String truststoreType,
               String truststoreAlgorithm)

The secure connections built by this object will authenticate the server endpoint using the given truststore file and its related parameters. The connection will use the given secure socket protocol to encrypt the connection traffic. Note that if the given truststoreFile is null, the other truststore parameters are ignored and the secure connections built by this object will not authenticate the server endpoint.

Parameters:

secureSocketProtocol - the secure socket protocol to use (e.g. "TLS")

truststoreFile - the truststore file containing authorized certificates

truststorePassword - the password to the truststore file (if a file is given, this must not be null)

truststoreType - the type of the truststore file (e.g. "JKS"); if null, then the JVM's default type is used (see java.security.KeyStore.getDefaultType())

truststoreAlgorithm - the standard name of the trust management algorithm (e.g. "SunX509"); if null, then the JVM's default algorithm is used (see javax.net.ssl.TrustManagerFactory.getDefaultAlgorithm())

Method Detail

openSecureConnection

public HttpsURLConnection openSecureConnection(URL url)
                                        throws Exception

Throws:

Exception

getSecureSocketProtocol

public String getSecureSocketProtocol()

getTruststoreFile

public File getTruststoreFile()

getTruststorePassword

public String getTruststorePassword()

getTruststoreType

public String getTruststoreType()

getTruststoreAlgorithm

public String getTruststoreAlgorithm()

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception