com.jayway.restassured.authentication

Class CertificateAuthSettings

java.lang.Object

com.jayway.restassured.authentication.CertificateAuthSettings

public class CertificateAuthSettings
extends Object

A specification for more advanced usages of certificate authentication. Example usage:

 given().auth().certificate("keystore.jks", "my_password", certAuthSettings().allowAllHostNames());
 

Constructor Summary

Constructors

Constructor and Description
CertificateAuthSettings() Create a new instance of the Certificate Authentication Options with the default settings of: keystoreType = KeyStore.getDefaultType() port = 443 trustStore = null x509HostnameVerifier = SSLSocketFactory.STRICT_HOSTNAME_VERIFIER

Method Summary

Methods

Modifier and Type	Method and Description
CertificateAuthSettings	allowAllHostnames() Configure the CertificateAuthSettings to allow all host names.
CertificateAuthSettings	and() Syntactic sugar.
static CertificateAuthSettings	certAuthSettings() Create a new instance of CertificateAuthSettings with default values.
String	getKeystoreType()
int	getPort()
KeyStore	getTrustStore()
org.apache.http.conn.ssl.X509HostnameVerifier	getX509HostnameVerifier()
CertificateAuthSettings	keystoreType(String keystoreType)
CertificateAuthSettings	port(int port)
CertificateAuthSettings	strictHostnames() Configure the CertificateAuthSettings to use strict host name verification (this is the default behavior).
CertificateAuthSettings	trustStore(KeyStore trustStore)
CertificateAuthSettings	using() Syntactic sugar.
CertificateAuthSettings	with() Syntactic sugar.
CertificateAuthSettings	x509HostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier) Configure the CertificateAuthSettings to use the provided X509HostnameVerifier instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateAuthSettings

public CertificateAuthSettings()

Create a new instance of the Certificate Authentication Options with the default settings of:

• keystoreType = KeyStore.getDefaultType()
• port = 443
• trustStore = null
• x509HostnameVerifier = SSLSocketFactory.STRICT_HOSTNAME_VERIFIER

See Also:

certAuthSettings()

Method Detail

getKeystoreType

public String getKeystoreType()

getPort

public int getPort()

getTrustStore

public KeyStore getTrustStore()

strictHostnames

public CertificateAuthSettings strictHostnames()

Configure the CertificateAuthSettings to use strict host name verification (this is the default behavior).

Returns:

A new CertificateAuthSettings instance

See Also:

SSLSocketFactory.STRICT_HOSTNAME_VERIFIER

allowAllHostnames

public CertificateAuthSettings allowAllHostnames()

Configure the CertificateAuthSettings to allow all host names.

Returns:

A new CertificateAuthSettings instance

See Also:

SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER

x509HostnameVerifier

public CertificateAuthSettings x509HostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier)

Configure the CertificateAuthSettings to use the provided X509HostnameVerifier instance.

Returns:

A new CertificateAuthSettings instance

See Also:

SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER, allowAllHostnames()

getX509HostnameVerifier

public org.apache.http.conn.ssl.X509HostnameVerifier getX509HostnameVerifier()

Returns:

The configured X509HostnameVerifier

keystoreType

public CertificateAuthSettings keystoreType(String keystoreType)

Parameters:

keystoreType - The keystore type, by default KeyStore.getDefaultType().

Returns:

A new instance of CertificateAuthSettings with the updated setting.

port

public CertificateAuthSettings port(int port)

Parameters:

port - The port, by default 443.

Returns:

A new instance of CertificateAuthSettings with the updated setting.

trustStore

public CertificateAuthSettings trustStore(KeyStore trustStore)

Parameters:

trustStore - The trust store to use, by default no (null) trust store is used.

Returns:

A new instance of CertificateAuthSettings with the updated setting.

and

public CertificateAuthSettings and()

Syntactic sugar.

Returns:

The same CertificateAuthOptions instance.

with

public CertificateAuthSettings with()

Syntactic sugar.

Returns:

The same CertificateAuthOptions instance.

using

public CertificateAuthSettings using()

Syntactic sugar.

Returns:

The same CertificateAuthOptions instance.

certAuthSettings

public static CertificateAuthSettings certAuthSettings()

Create a new instance of CertificateAuthSettings with default values. Same as called CertificateAuthSettings() but a bit more "fluent".

Returns:

a new instance of CertificateAuthSettings with default values.