Class AuthConfig

java.lang.Object

groovyx.net.http.AuthConfig

public class AuthConfig
extends Object

Encapsulates all configuration related to HTTP authentication methods.

See Also:

• HTTPBuilder.getAuth()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AuthConfig.OAuthSigner	This class is used to sign all requests via an HttpRequestInterceptor until the context-aware AuthScheme is released in HttpClient 4.1.

Field Summary

Fields

Modifier and Type	Field	Description
protected HTTPBuilder	builder

Constructor Summary

Constructors

Constructor	Description
AuthConfig(HTTPBuilder builder)

Method Summary

Modifier and Type	Method	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)	Sets a certificate to be used for SSL authentication.
void	ntlm(String host, int port, String user, String pass, String workstation, String domain)	Set NTLM authentication credentials to be used for the given host and port.
void	ntlm(String user, String pass, String workstation, String domain)	Set NTLM authentication credentials to be used for the current default host.
void	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken)	OAuth sign all requests.

Methods inherited from class Object

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

Field Details

builder

protected HTTPBuilder builder

Constructor Details

AuthConfig

public AuthConfig(HTTPBuilder builder)

Method Details

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 -

ntlm

public void ntlm(String user,
 String pass,
 String workstation,
 String domain)

Set NTLM authentication credentials to be used for the current default host.

Parameters:

user -

pass -

workstation -

domain -

ntlm

public void ntlm(String host,
 int port,
 String user,
 String pass,
 String workstation,
 String domain)

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

Parameters:

host -

port -

user -

pass -

workstation -

domain -

certificate

public void certificate(String certURL,
 String password)
                 throws GeneralSecurityException,
IOException

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

Throws:

GeneralSecurityException

IOException

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 Signpost documentation.

Parameters:

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

consumerSecret -

accessToken -

secretToken -

Since:

0.5.1