com.jayway.restassured.internal.http

Class AuthConfig

java.lang.Object

com.jayway.restassured.internal.http.AuthConfig

public class AuthConfig
extends Object

Encapsulates all configuration related to HTTP authentication methods.

Author:

Tom Nichols, johanhaleby

Field Summary

Fields

Modifier and Type	Field and Description
protected HTTPBuilder	builder

Constructor Summary

Constructors

Constructor and Description
AuthConfig(HTTPBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	basic(String host, int port, String user, String pass) Set authentication credentials to be used for the given host and port.
void	basic(String user, String pass) Set authentication credentials to be used for the current default host.
void	certificate(String certURL, String password, String certType, int port, KeyStore trustStore, org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier, org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory) Sets a certificate to be used for SSL authentication.
void	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken) OAuth sign all requests.
void	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken, OAuthSignature signature)
void	oauth2(String accessToken) OAuth2 sign all requests.
void	oauth2(String accessToken, OAuthSignature signature)

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected HTTPBuilder builder

Constructor Detail

AuthConfig

public AuthConfig(HTTPBuilder builder)

Method Detail

basic

public void basic(String user,
                  String pass)

Set authentication credentials to be used for the current default host. This method name is a bit of a misnomer, since these credentials will actually work for "digest" authentication as well.

Parameters:

user -

pass -

basic

public void basic(String host,
                  int port,
                  String user,
                  String pass)

Set authentication credentials to be used for the given host and port.

Parameters:

host -

port -

user -

pass -

certificate

public void certificate(String certURL,
                        String password,
                        String certType,
                        int port,
                        KeyStore trustStore,
                        org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier,
                        org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)

Sets a certificate to be used for SSL authentication. See Class.getResource(String) for how to get a URL from a resource on the classpath.

Parameters:

certURL - URL to a JKS keystore where the certificate is stored.

password - password to decrypt the keystore

certType - The certificate type

port - The SSL port

trustStore - The trust store

x509HostnameVerifier - The X509HostnameVerifier to use

sslSocketFactory - The SSLSocketFactory to use

oauth

public void oauth(String consumerKey,
                  String consumerSecret,
                  String accessToken,
                  String secretToken)

OAuth sign all requests. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. All requests to all domains will be signed for this instance.

This assumes you've already generated an accessToken and secretToken for the site you're targeting. For More information on how to achieve this, see the Scribe documentation.

Parameters:

consumerKey - null if you want to unset OAuth handling and stop signing requests.

consumerSecret -

accessToken -

secretToken -

Since:

0.5.1

oauth

public void oauth(String consumerKey,
                  String consumerSecret,
                  String accessToken,
                  String secretToken,
                  OAuthSignature signature)

oauth2

public void oauth2(String accessToken)

OAuth2 sign all requests. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. All requests to all domains will be signed for this instance.

This assumes you've already generated an accessToken for the site you're targeting. For More information on how to achieve this, see the Scribe documentation.

Parameters:

accessToken -

Since:

0.5.1

oauth2

public void oauth2(String accessToken,
                   OAuthSignature signature)