org.eclipse.smila.connectivity.framework.crawler.web.auth
Class HtmlFormAuthentication

java.lang.Object
  org.eclipse.smila.connectivity.framework.crawler.web.auth.HtmlFormAuthentication

public class HtmlFormAuthentication
extends java.lang.Object

HTML form authentication configuration.

Nested Class Summary

static class

HtmlFormAuthentication.HttpMethod Available methods for sending html form.

Constructor Summary

HtmlFormAuthentication()

Method Summary

java.lang.String	getCredentialDomain() Returns the credential domain.
java.util.Map<java.lang.String,java.lang.String>	getFormItems() Returns the mapping of key/value form items pairs.
HtmlFormAuthentication.HttpMethod	getHttpMethod() Returns form http method (GET or POST).
java.lang.String	getLoginUri() Returns relative or absolute URI to the page that the HTML Form submits to.
java.lang.String	putFormItem(java.lang.String key, java.lang.String value) Adds a key/value pair to the map of form item.
void	setCredentialDomain(java.lang.String domain) Assigns credential domain.
void	setHttpMethod(HtmlFormAuthentication.HttpMethod method) Assigns form HTTP method.
void	setLoginUri(java.lang.String uri) Assigns relative or absolute URI to the page that the HTML Form submits to.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlFormAuthentication

public HtmlFormAuthentication()

Method Detail

getCredentialDomain

public java.lang.String getCredentialDomain()

Returns the credential domain. This equates to the canonical root URI of RFC2617.

Returns:

String

setCredentialDomain

public void setCredentialDomain(java.lang.String domain)

Assigns credential domain.

Parameters:

domain - String

getFormItems

public java.util.Map<java.lang.String,java.lang.String> getFormItems()

Returns the mapping of key/value form items pairs.

Returns:

Map

getLoginUri

public java.lang.String getLoginUri()

Returns relative or absolute URI to the page that the HTML Form submits to.

Returns:

String

setLoginUri

public void setLoginUri(java.lang.String uri)

Assigns relative or absolute URI to the page that the HTML Form submits to.

Parameters:

uri - String

getHttpMethod

public HtmlFormAuthentication.HttpMethod getHttpMethod()

Returns form http method (GET or POST).

Returns:

HttpMethod

setHttpMethod

public void setHttpMethod(HtmlFormAuthentication.HttpMethod method)

Assigns form HTTP method.

Parameters:

method - HttpMethod

putFormItem

public java.lang.String putFormItem(java.lang.String key,
                                    java.lang.String value)

Adds a key/value pair to the map of form item.

Parameters:

key - String

value - String

Returns:

String