CapsConfiguration (CAPS 2.0.2 API)

java.lang.Object
- ch.racic.caps.CapsConfiguration

All Implemented Interfaces:: ICapsConfiguration

public class CapsConfiguration
extends Object
implements ICapsConfiguration

Created by rac on 08.02.15.

Constructor Summary

Constructors
Constructor and Description

CapsConfiguration()
Constructor for the reference implementation of the configuration object.

Constructors
Constructor and Description
`CapsConfiguration()` Constructor for the reference implementation of the configuration object.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getConnectionTimeout()` Get the connection timeout set for the sockets.
`int`	`getProxyListenerPort()` Get the current setting of the proxy listener port.
`SSLContext`	`getProxySslContext()` Used by CAPS to retrieve the SSLContext for the client connection (proxy => client).
`Proxy`	`getTargetProxy()` Get the proxy which is required for the connection to the target server.
`SSLContext`	`getTargetSslContext()` Used by CAPS to retrieve the SSLContext for the target connection (proxy => target)
`int`	`getThreadPoolSize()` Get the desired thread pool size for the ConnectionHandler threads.
`CapsConfiguration`	`setConnectionTimeout(long connectionTimeout)` Set the connection timeout used in the sockets.
`CapsConfiguration`	`setProxyKeyStorePassword(String proxyKeyStorePassword)` Password needed to unlock the proxy KeyStore
`CapsConfiguration`	`setProxyKeyStorePath(String proxyKeyStorePath)` Set the server certificate which the proxy uses for the handshake with the source browser.
`CapsConfiguration`	`setProxyKeyStoreType(String proxyKeyStoreType)` The type of the proxy KeyStore.
`CapsConfiguration`	`setProxyListenerPort(int proxyListenerPort)` Set the proxy listener port to be used.
`CapsConfiguration`	`setProxySslContext(SSLContext proxySslContext)` Set the proxy SSLContext directly, no need to set proxy KeyStore after this.
`CapsConfiguration`	`setTargetKeyStorePassword(String targetKeyStorePassword)` Password needed to unlock the KeyStore
`CapsConfiguration`	`setTargetKeyStorePath(String targetKeyStorePath)` Set the path to the desired KeyStore file.
`CapsConfiguration`	`setTargetKeyStoreType(String targetKeyStoreType)` The type of the target KeyStore.
`CapsConfiguration`	`setTargetProxy(Proxy targetProxy)` Set the proxy which is required for the connection to the target server.
`CapsConfiguration`	`setTargetSslContext(SSLContext targetSslContext)` Set the target SSLContext directly, no need to set target TrustStore or KeyStore after this.
`CapsConfiguration`	`setTargetTrustStorePassword(String targetTrustStorePassword)` Password needed to unlock the TrustStore.
`CapsConfiguration`	`setTargetTrustStorePath(String targetTrustStorePath)` Set the path to the desired TrustStore file.
`CapsConfiguration`	`setTargetTrustStoreType(String targetTrustStoreType)` The type of the target TrustStore.
`void`	`setThreadPoolSize(int threadPoolSize)` Set the thread pool size to limit how many concurrent open connections can be handled, remaining will be queued.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CapsConfiguration
```
public CapsConfiguration()
```
    Constructor for the reference implementation of the configuration object. To use a custom configuration object, you can extend this class and override the public methods or implement ch.racic.caps.ICapsConfiguration.
    This constructor will set default values in case they don't get set: targetTrustStoreType = "pkcs12"; targetKeyStoreType = "pkcs12"; proxyKeyStorePath = "ch.racic.caps.resources/certs/server.p12"; self signed certificate inside this artifact proxyKeyStoreType = "pkcs12"; proxyListenerPort = 0; if port 0 is used, the proxy server takes any free port @see getProxyListenerPort() connectionTimeout = 5000;
- Method Detail
  - getTargetSslContext
```
public SSLContext getTargetSslContext()
                               throws NoSuchAlgorithmException,
                                      CertificateException,
                                      KeyStoreException,
                                      IOException,
                                      UnrecoverableKeyException,
                                      ConfigurationException,
                                      KeyManagementException
```
    Used by CAPS to retrieve the SSLContext for the target connection (proxy => target)
    
    Specified by:
    
    getTargetSslContext in interface ICapsConfiguration
    
    Returns:
    SSLContext to create target socket
    
    Throws:
    
    NoSuchAlgorithmException
    
    CertificateException
    
    KeyStoreException
    
    IOException
    
    UnrecoverableKeyException
    
    ConfigurationException
    
    KeyManagementException
  - setTargetSslContext
```
public CapsConfiguration setTargetSslContext(SSLContext targetSslContext)
```
    Set the target SSLContext directly, no need to set target TrustStore or KeyStore after this.
    
    Parameters:
    targetSslContext -
    
    Returns:
    itself for the dot-notation
  - setTargetTrustStorePath
```
public CapsConfiguration setTargetTrustStorePath(String targetTrustStorePath)
```
    Set the path to the desired TrustStore file. Don't forget to set the target TrustStore type if it's not PKCS12. The file will be taken as stream from the current class loader. It will try to find a the password in default files but only log to debug if this fails. First it will load {targetTrustStorePath}.pwd including the extension (normal append). If first fails, it will try to load a file with .pwd extension instead of the current extension.
    
    Parameters:
    targetTrustStorePath -
    
    Returns:
    itself for the dot-notation
  - setTargetTrustStorePassword
```
public CapsConfiguration setTargetTrustStorePassword(String targetTrustStorePassword)
```
    Password needed to unlock the TrustStore.
    
    Parameters:
    targetTrustStorePassword -
    
    Returns:
    itself for the dot-notation
  - setTargetTrustStoreType
```
public CapsConfiguration setTargetTrustStoreType(String targetTrustStoreType)
```
    The type of the target TrustStore. Defaults to PKCS12 but can take anything that the current runtime system supports.
    
    Parameters:
    targetTrustStoreType -
    
    Returns:
    itself for the dot-notation
  - setTargetKeyStorePath
```
public CapsConfiguration setTargetKeyStorePath(String targetKeyStorePath)
```
    Set the path to the desired KeyStore file. Don't forget to set the target KeyStore type if it's not PKCS12. The file will be taken as stream from the current class loader.
    
    Parameters:
    targetKeyStorePath -
    
    Returns:
    itself for the dot-notation
  - setTargetKeyStorePassword
```
public CapsConfiguration setTargetKeyStorePassword(String targetKeyStorePassword)
```
    Password needed to unlock the KeyStore
    
    Parameters:
    targetKeyStorePassword -
    
    Returns:
    itself for the dot-notation
  - setTargetKeyStoreType
```
public CapsConfiguration setTargetKeyStoreType(String targetKeyStoreType)
```
    The type of the target KeyStore. Defaults to PKCS12 but can take anything that the current runtime system supports.
    
    Parameters:
    targetKeyStoreType -
    
    Returns:
    itself for the dot-notation
  - getTargetProxy
```
public Proxy getTargetProxy()
```
    Get the proxy which is required for the connection to the target server.
    
    Specified by:
    
    getTargetProxy in interface ICapsConfiguration
    
    Returns:
    Proxy object or null
  - setTargetProxy
```
public CapsConfiguration setTargetProxy(Proxy targetProxy)
```
    Set the proxy which is required for the connection to the target server.
    
    Parameters:
    targetProxy -
    
    Returns:
    itself for the dot-notation
  - setProxyKeyStorePath
```
public CapsConfiguration setProxyKeyStorePath(String proxyKeyStorePath)
```
    Set the server certificate which the proxy uses for the handshake with the source browser. If not set, it will default to a self signed certificate which has been used in the unit test of CAPS.
    
    Parameters:
    proxyKeyStorePath -
  - setProxyKeyStorePassword
```
public CapsConfiguration setProxyKeyStorePassword(String proxyKeyStorePassword)
```
    Password needed to unlock the proxy KeyStore
    
    Parameters:
    proxyKeyStorePassword -
    
    Returns:
    itself for the dot-notation
  - setProxyKeyStoreType
```
public CapsConfiguration setProxyKeyStoreType(String proxyKeyStoreType)
```
    The type of the proxy KeyStore. Defaults to PKCS12 but can take anything that the current runtime system supports.
    
    Parameters:
    proxyKeyStoreType -
    
    Returns:
    itself for the dot-notation
  - getProxySslContext
```
public SSLContext getProxySslContext()
                              throws CertificateException,
                                     UnrecoverableKeyException,
                                     NoSuchAlgorithmException,
                                     IOException,
                                     KeyStoreException,
                                     ConfigurationException,
                                     KeyManagementException
```
    Used by CAPS to retrieve the SSLContext for the client connection (proxy => client). This is needed for the MITM interception to inject the client certificate.
    
    Specified by:
    
    getProxySslContext in interface ICapsConfiguration
    
    Returns:
    SSLContext to create the proxy socket for the SSL Upgrade of the connection
    
    Throws:
    
    CertificateException
    
    UnrecoverableKeyException
    
    NoSuchAlgorithmException
    
    IOException
    
    KeyStoreException
    
    ConfigurationException
    
    KeyManagementException
  - setProxySslContext
```
public CapsConfiguration setProxySslContext(SSLContext proxySslContext)
```
    Set the proxy SSLContext directly, no need to set proxy KeyStore after this.
    
    Parameters:
    proxySslContext -
    
    Returns:
    itself for the dot-notation
  - getProxyListenerPort
```
public int getProxyListenerPort()
```
    Get the current setting of the proxy listener port.
    
    Specified by:
    
    getProxyListenerPort in interface ICapsConfiguration
    
    Returns:
    port number
  - setProxyListenerPort
```
public CapsConfiguration setProxyListenerPort(int proxyListenerPort)
```
    Set the proxy listener port to be used. Default value is 0 which means it will use any free port and you can retrieve it from the proxy after its started.
    
    Parameters:
    proxyListenerPort -
    
    Returns:
  - getThreadPoolSize
```
public int getThreadPoolSize()
```
    Description copied from interface: ICapsConfiguration
    
    Get the desired thread pool size for the ConnectionHandler threads.
    
    Specified by:
    
    getThreadPoolSize in interface ICapsConfiguration
    
    Returns:
  - setThreadPoolSize
```
public void setThreadPoolSize(int threadPoolSize)
```
    Set the thread pool size to limit how many concurrent open connections can be handled, remaining will be queued.
    
    Parameters:
    threadPoolSize -
  - getConnectionTimeout
```
public long getConnectionTimeout()
```
    Get the connection timeout set for the sockets.
    
    Specified by:
    
    getConnectionTimeout in interface ICapsConfiguration
    
    Returns:
    timeout in ms
  - setConnectionTimeout
```
public CapsConfiguration setConnectionTimeout(long connectionTimeout)
```
    Set the connection timeout used in the sockets.
    
    Parameters:
    connectionTimeout -
    
    Returns:

Class CapsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CapsConfiguration

Method Detail

getTargetSslContext

setTargetSslContext

setTargetTrustStorePath

setTargetTrustStorePassword

setTargetTrustStoreType

setTargetKeyStorePath

setTargetKeyStorePassword

setTargetKeyStoreType

getTargetProxy

setTargetProxy

setProxyKeyStorePath

setProxyKeyStorePassword

setProxyKeyStoreType

getProxySslContext

setProxySslContext

getProxyListenerPort

setProxyListenerPort

getThreadPoolSize

setThreadPoolSize

getConnectionTimeout

setConnectionTimeout