com.cloudant.http.interceptors

Class BasicAuthInterceptor

java.lang.Object

com.cloudant.http.interceptors.BasicAuthInterceptor

All Implemented Interfaces:

HttpConnectionInterceptor, HttpConnectionRequestInterceptor

public class BasicAuthInterceptor
extends java.lang.Object
implements HttpConnectionRequestInterceptor

Adds basic authentication support to HTTP requests by adding an Authorization header. Direct use of this class is rarely required as the client will construct one as needed.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	authHeader
protected java.lang.String	encodedAuth

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasicAuthInterceptor(java.lang.String userinfo) Constructs a BasicAuthInterceptor using userinfo details.
protected	BasicAuthInterceptor(java.lang.String userinfo, java.lang.String authHeader)

Method Summary

Modifier and Type	Method and Description
static BasicAuthInterceptor	createFromCredentials(java.lang.String username, java.lang.String password) Returns a BasicAuthInterceptor configured using the username and password provided.
HttpConnectionInterceptorContext	interceptRequest(HttpConnectionInterceptorContext context) Intercept the request.

Methods inherited from class java.lang.Object

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

Field Detail

authHeader

protected final java.lang.String authHeader

encodedAuth

protected final java.lang.String encodedAuth

Constructor Detail

BasicAuthInterceptor

public BasicAuthInterceptor(java.lang.String userinfo)

Constructs a BasicAuthInterceptor using userinfo details.

Parameters:

userinfo - the username and password separated by a single colon (":") character

BasicAuthInterceptor

protected BasicAuthInterceptor(java.lang.String userinfo,
                               java.lang.String authHeader)

Method Detail

createFromCredentials

public static BasicAuthInterceptor createFromCredentials(java.lang.String username,
                                                         java.lang.String password)

Returns a BasicAuthInterceptor configured using the username and password provided.

Parameters:

username - the username to use

password - the password to use

Returns:

configured BasicAuthInterceptor

interceptRequest

public HttpConnectionInterceptorContext interceptRequest(HttpConnectionInterceptorContext context)

Description copied from interface: HttpConnectionRequestInterceptor

Intercept the request. This method must not do any of the following:

• Return null
• Call methods on the underlying HttpURLConnection which initiate a request such as HttpURLConnection.getResponseCode()

Specified by:

interceptRequest in interface HttpConnectionRequestInterceptor

Parameters:

context - Input context

Returns:

Output context