Package groovyx.net.http
Class AuthConfig
java.lang.Object
groovyx.net.http.AuthConfig
Encapsulates all configuration related to HTTP authentication methods.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
This class is used to sign all requests via anHttpRequestInterceptor
until the context-aware AuthScheme is released in HttpClient 4.1. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Set authentication credentials to be used for the given host and port.void
Set authentication credentials to be used for the currentdefault host
.void
certificate
(String certURL, String password) Sets a certificate to be used for SSL authentication.void
Set NTLM authentication credentials to be used for the given host and port.void
Set NTLM authentication credentials to be used for the currentdefault host
.void
OAuth sign all requests.
-
Field Details
-
builder
-
-
Constructor Details
-
AuthConfig
-
-
Method Details
-
basic
Set authentication credentials to be used for the currentdefault 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
Set authentication credentials to be used for the given host and port.- Parameters:
host
-port
-user
-pass
-
-
ntlm
Set NTLM authentication credentials to be used for the currentdefault 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. SeeClass.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 aWWW-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
andsecretToken
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
-