com.endeca.soleng.eac.toolkit.util.http

Interface Credentials

All Known Implementing Classes:

BasicCredentialsComponent

public interface Credentials

Interface to add authentication components to a HTTP request

Method Summary

Modifier and Type	Method and Description
void	applyCredentials(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder, org.apache.http.client.methods.HttpRequestBase httpRequest) Sets the authentication information in the http client and request.
void	clearCredentials(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder, org.apache.http.client.methods.HttpRequestBase httpRequest) Clears the authentication information from the http client and request.

Method Detail

applyCredentials

void applyCredentials(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder,
                      org.apache.http.client.methods.HttpRequestBase httpRequest)
               throws org.apache.http.auth.AuthenticationException

Sets the authentication information in the http client and request.

Parameters:

httpClientBuilder - the Builder for CloseableHttpClient Instance

httpRequest - the request being authenticated

Throws:

org.apache.http.auth.AuthenticationException - if authorization string cannot be generated due to an authentication failure

clearCredentials

void clearCredentials(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder,
                      org.apache.http.client.methods.HttpRequestBase httpRequest)

Clears the authentication information from the http client and request.

Parameters:

httpClientBuilder - the Builder for CloseableHttpClient Instance

httpRequest - the request being authenticated