com.github.restdriver.clientdriver

Class SecureClientDriverFactory

java.lang.Object

com.github.restdriver.clientdriver.SecureClientDriverFactory

public class SecureClientDriverFactory
extends Object

Factory to create a ClientDriver object which supports SSL. To arrange that a key store has to be provided. The required password has to be the password of the certificate's private key as well as of the key store. This is usually the case if the certificate is exported via OpenSSL e.g. as PKCS#12 format. An example to create a certificate with keytool provided in the JDK:

  $ keytool -genkey -keyalg RSA -dname "cn=SecureClientDriver" \ 
  -alias certificate -keystore keystore.jks -keypass password \ 
  -storepass password -validity 360 -keysize 2048
 

Constructor Summary

Constructors

Constructor and Description
SecureClientDriverFactory()

Method Summary

Modifier and Type	Method and Description
SecureClientDriver	build() Create SecureClientDriver with the given configuration.
SecureClientDriverFactory	certAlias(String certAlias) Sets the certificate alias.
SecureClientDriver	createClientDriver(int port, KeyStore keyStore, String password, String certAlias) Factory method to create and start a ClientDriver on a specific port.
SecureClientDriver	createClientDriver(KeyStore keyStore, String password, String certAlias) Factory method to create and start ClientDriver.
SecureClientDriverFactory	keyStore(KeyStore keyStore) Sets the key store.
SecureClientDriverFactory	password(String password) Sets the password.
SecureClientDriverFactory	port(int port) Sets the port.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureClientDriverFactory

public SecureClientDriverFactory()

Method Detail

createClientDriver

public SecureClientDriver createClientDriver(KeyStore keyStore,
                                             String password,
                                             String certAlias)

Factory method to create and start ClientDriver. The port will be chosen automatically.

Parameters:

keyStore - The KeyStore that contains the necessary certificate.

password - The password for the certificate private key and the container.

certAlias - the alias of the certificate in the key store

Returns:

a ClientDriver object

createClientDriver

public SecureClientDriver createClientDriver(int port,
                                             KeyStore keyStore,
                                             String password,
                                             String certAlias)

Factory method to create and start a ClientDriver on a specific port. The port can be set, the following arguments are to setup SSL.

Parameters:

port - The port that should be used.

keyStore - The KeyStore that contains the necessary certificate.

password - The password for the certificate private key and the container.

certAlias - the alias of the certificate in the key store

Returns:

a ClientDriver object

port

public SecureClientDriverFactory port(int port)

Sets the port. By default the port is set to 0, which results in a freely chosen port.

Parameters:

port - the port

Returns:

the factory object

password

public SecureClientDriverFactory password(String password)

Sets the password. Password may not be null or empty when building.

Parameters:

password - the certificate's password

Returns:

the factory object

certAlias

public SecureClientDriverFactory certAlias(String certAlias)

Sets the certificate alias. Certificate alias may not be null or empty when building.

Parameters:

certAlias - the certificate alias

Returns:

the factory object

keyStore

public SecureClientDriverFactory keyStore(KeyStore keyStore)

Sets the key store. Key store may not be null or empty when building. It has to contain a certificate.

Parameters:

keyStore - the key store

Returns:

the factory object

build

public SecureClientDriver build()

Create SecureClientDriver with the given configuration.

Returns:

the newly-created driver