io.restassured.internal

Class AuthenticationSpecificationImpl

java.lang.Object

io.restassured.internal.AuthenticationSpecificationImpl

All Implemented Interfaces:

groovy.lang.GroovyObject, AuthenticationSpecification

public class AuthenticationSpecificationImpl
extends Object
implements AuthenticationSpecification, groovy.lang.GroovyObject

Constructor Summary

Constructors

Constructor and Description
AuthenticationSpecificationImpl(RequestSpecification requestSpecification)

Method Summary

Modifier and Type	Method and Description
RequestSpecification	basic(String userName, String password) Use http basic authentication.
RequestSpecification	certificate(String certURL, String password) Sets a certificate to be used for SSL authentication.
RequestSpecification	certificate(String certURL, String password, CertificateAuthSettings settings) Sets a certificate to be used for SSL authentication.
RequestSpecification	digest(String userName, String password) Use http digest authentication.
RequestSpecification	form(String userName, String password) Use form authentication.
RequestSpecification	form(String userName, String password, FormAuthConfig config) Use form authentication with the supplied configuration.
groovy.lang.MetaClass	getMetaClass()
RequestSpecification	none() Explicitly state that you don't which to use any authentication in this request.
RequestSpecification	ntlm(String userName, String password, String workstation, String domain) Use NTLM authentication.
RequestSpecification	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken) Excerpt from the HttpBuilder docs: OAuth sign the request.
RequestSpecification	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken, OAuthSignature signature) Excerpt from the HttpBuilder docs: OAuth sign the request.
RequestSpecification	oauth2(String accessToken) OAuth2 sign the request.
RequestSpecification	oauth2(String accessToken, OAuthSignature signature) OAuth2 sign the request.
PreemptiveAuthSpec	preemptive() Returns the preemptive authentication view.
void	setMetaClass(groovy.lang.MetaClass mc)

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getProperty, invokeMethod, setProperty

Constructor Detail

AuthenticationSpecificationImpl

public AuthenticationSpecificationImpl(RequestSpecification requestSpecification)

Method Detail

basic

public RequestSpecification basic(String userName,
                                  String password)

Description copied from interface: AuthenticationSpecification

Use http basic authentication.

Specified by:

basic in interface AuthenticationSpecification

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

ntlm

public RequestSpecification ntlm(String userName,
                                 String password,
                                 String workstation,
                                 String domain)

Description copied from interface: AuthenticationSpecification

Use NTLM authentication.

Specified by:

ntlm in interface AuthenticationSpecification

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

digest

public RequestSpecification digest(String userName,
                                   String password)

Description copied from interface: AuthenticationSpecification

Use http digest authentication.

Specified by:

digest in interface AuthenticationSpecification

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

certificate

public RequestSpecification certificate(String certURL,
                                        String password)

Description copied from interface: AuthenticationSpecification

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.

Uses keystore: KeyStore.getDefaultType().
Uses port: 443
Uses keystore provider: none

Specified by:

certificate in interface AuthenticationSpecification

Parameters:

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

password - password to decrypt the keystore

Returns:

The request io.restassured.specification

certificate

public RequestSpecification certificate(String certURL,
                                        String password,
                                        CertificateAuthSettings settings)

Description copied from interface: AuthenticationSpecification

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.

Specified by:

certificate in interface AuthenticationSpecification

Parameters:

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

password - The password for the keystore

settings - More advanced settings for the certificate authentication

oauth

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

Description copied from interface: AuthenticationSpecification

Excerpt from the HttpBuilder docs:
OAuth sign the request. 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.

Specified by:

oauth in interface AuthenticationSpecification

Returns:

The request io.restassured.specification

oauth

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

Description copied from interface: AuthenticationSpecification

Excerpt from the HttpBuilder docs:
OAuth sign the request. 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.

Specified by:

oauth in interface AuthenticationSpecification

Returns:

The request io.restassured.specification

oauth2

public RequestSpecification oauth2(String accessToken)

Description copied from interface: AuthenticationSpecification

OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header (so currently it's the same as preemptive oauth2 authentication. The reason why it's located here is to be backward compatible). This assumes you've already generated an accessToken for the site you're targeting. The access token will be put in a header.

Specified by:

oauth2 in interface AuthenticationSpecification

Parameters:

accessToken - The access token

Returns:

The request io.restassured.specification

oauth2

public RequestSpecification oauth2(String accessToken,
                                   OAuthSignature signature)

Description copied from interface: AuthenticationSpecification

OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. This assumes you've already generated an accessToken for the site you're targeting.

Specified by:

oauth2 in interface AuthenticationSpecification

Parameters:

accessToken - The access token

signature - The signature (note that if using OAuthSignature.QUERY_STRING then Scribe must be added to the classpath)

Returns:

The request io.restassured.specification

none

public RequestSpecification none()

Description copied from interface: AuthenticationSpecification

Explicitly state that you don't which to use any authentication in this request. This is useful only in cases where you've specified a default authentication scheme and you wish to override it for a single request.

Specified by:

none in interface AuthenticationSpecification

Returns:

The Request specification

preemptive

public PreemptiveAuthSpec preemptive()

Description copied from interface: AuthenticationSpecification

Returns the preemptive authentication view. This means that the authentication details are sent in the request header regardless if the server has challenged for authentication or not.

Specified by:

preemptive in interface AuthenticationSpecification

Returns:

The preemptive authentication specification.

form

public RequestSpecification form(String userName,
                                 String password)

Description copied from interface: AuthenticationSpecification

Use form authentication. Rest Assured will try to parse the response login page and determine and try find the action, username and password input field automatically.

Specified by:

form in interface AuthenticationSpecification

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

form

public RequestSpecification form(String userName,
                                 String password,
                                 FormAuthConfig config)

Description copied from interface: AuthenticationSpecification

Use form authentication with the supplied configuration.

Specified by:

form in interface AuthenticationSpecification

Parameters:

userName - The user name.

password - The password.

config - The form authentication config

Returns:

The authentication scheme

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject