com.endeca.soleng.eac.toolkit.component

Class BasicCredentialsComponent

java.lang.Object

com.endeca.soleng.eac.toolkit.base.EacElement

com.endeca.soleng.eac.toolkit.component.BasicCredentialsComponent

All Implemented Interfaces:

Credentials

public class BasicCredentialsComponent
extends com.endeca.soleng.eac.toolkit.base.EacElement
implements Credentials

Component that adds basic authentication elements to the request

Field Summary

Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir

Constructor Summary

Constructors

Constructor and Description
BasicCredentialsComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCredentials(org.apache.http.impl.client.DefaultHttpClient defaultHttpClient, org.apache.http.client.methods.HttpRequestBase httpRequest) Sets the authentication information in the http client and request.
void	clearCredentials(org.apache.http.impl.client.DefaultHttpClient httpClient, org.apache.http.client.methods.HttpRequestBase httpRequest) Clears the authentication information from the http client and request.
AccessCredentials	getAccessCredentials()
String	getCredentialsKey()
CSFManager	getCredentialStore()
void	setCredentialsKey(String credentialsKey)
void	setCredentialStore(CSFManager credentialStore)

Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicCredentialsComponent

public BasicCredentialsComponent()

Method Detail

getCredentialStore

public CSFManager getCredentialStore()

setCredentialStore

public void setCredentialStore(CSFManager credentialStore)

getCredentialsKey

public String getCredentialsKey()

setCredentialsKey

public void setCredentialsKey(String credentialsKey)

getAccessCredentials

public AccessCredentials getAccessCredentials()

applyCredentials

public void applyCredentials(org.apache.http.impl.client.DefaultHttpClient defaultHttpClient,
                    org.apache.http.client.methods.HttpRequestBase httpRequest)
                      throws org.apache.http.auth.AuthenticationException

Description copied from interface: Credentials

Sets the authentication information in the http client and request.

Specified by:

applyCredentials in interface Credentials

Parameters:

defaultHttpClient - the client being authenticated

httpRequest - the request being authenticated

Throws:

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

clearCredentials

public void clearCredentials(org.apache.http.impl.client.DefaultHttpClient httpClient,
                    org.apache.http.client.methods.HttpRequestBase httpRequest)

Description copied from interface: Credentials

Clears the authentication information from the http client and request.

Specified by:

clearCredentials in interface Credentials

Parameters:

httpClient - the client being authenticated

httpRequest - the request being authenticated