groovyx.net.http

Class HttpConfigs.BasicAuth

java.lang.Object

groovyx.net.http.HttpConfigs.BasicAuth

All Implemented Interfaces:

HttpConfig.Auth

Enclosing class:

HttpConfigs

public static class HttpConfigs.BasicAuth
extends java.lang.Object
implements HttpConfig.Auth

Constructor Summary

Constructors

Constructor and Description
BasicAuth()

Method Summary

Modifier and Type	Method and Description
void	basic(java.lang.String user, java.lang.String password, boolean preemptive) Configures the request to use BASIC authentication with the given username and password.
void	digest(java.lang.String user, java.lang.String password, boolean preemptive) Configures the request to use DIGEST authentication with the given information.
HttpConfig.AuthType	getAuthType() Retrieve the authentication type for the request.
java.lang.String	getPassword() Retrieves the configured password for the request.
java.lang.String	getUser() Retrieves the configured user for the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovyx.net.http.HttpConfig.Auth

basic, digest

Constructor Detail

BasicAuth

public BasicAuth()

Method Detail

basic

public void basic(java.lang.String user,
                  java.lang.String password,
                  boolean preemptive)

Description copied from interface: HttpConfig.Auth

Configures the request to use BASIC authentication with the given username and password.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.auth.basic 'admin', '$3cr3t', true
}

Specified by:

basic in interface HttpConfig.Auth

Parameters:

user - the username

password - the user’s password

preemptive - whether or not this call will override similar configuration in the chain

digest

public void digest(java.lang.String user,
                   java.lang.String password,
                   boolean preemptive)

Description copied from interface: HttpConfig.Auth

Configures the request to use DIGEST authentication with the given information.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.auth.digest 'admin', '$3cr3t', true
}

Specified by:

digest in interface HttpConfig.Auth

Parameters:

user - the username

password - the user’s password

preemptive - whether or not this call will override similar configuration in the chain

getUser

public java.lang.String getUser()

Description copied from interface: HttpConfig.Auth

Retrieves the configured user for the request.

Specified by:

getUser in interface HttpConfig.Auth

Returns:

the configured user

getPassword

public java.lang.String getPassword()

Description copied from interface: HttpConfig.Auth

Retrieves the configured password for the request.

Specified by:

getPassword in interface HttpConfig.Auth

Returns:

the configured password for the request

getAuthType

public HttpConfig.AuthType getAuthType()

Description copied from interface: HttpConfig.Auth

Retrieve the authentication type for the request.

Specified by:

getAuthType in interface HttpConfig.Auth

Returns:

the HttpConfig.AuthType for the Request