org.archive.modules.forms

Class HTMLForm

java.lang.Object

org.archive.modules.forms.HTMLForm

public class HTMLForm
extends Object

Simple representation of a discovered HTML Form.

Contributor:

gojomo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HTMLForm.FormInput

Constructor Summary

Constructors

Constructor and Description
HTMLForm()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(String type, String name, String value) Add a discovered INPUT, tracking it as potential username/password receiver.
String	asAnnotation() Provide abbreviated annotation, of the form...
org.apache.commons.httpclient.NameValuePair[]	asHttpClientDataWith(String username, String password) Create the NameValuePair array expected by HttpClient, merging username and password into the appropriate value slots.
String	getAction()
boolean	seemsLoginForm() For now, we consider a POST form with only 1 password field and 1 potential username field (type text or email) to be a likely login form.
void	setAction(String action)
void	setMethod(String method)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLForm

public HTMLForm()

Method Detail

addField

public void addField(String type,
            String name,
            String value)

Add a discovered INPUT, tracking it as potential username/password receiver.

Parameters:

type -

name -

value -

setMethod

public void setMethod(String method)

getAction

public String getAction()

setAction

public void setAction(String action)

seemsLoginForm

public boolean seemsLoginForm()

For now, we consider a POST form with only 1 password field and 1 potential username field (type text or email) to be a likely login form.

Returns:

boolean likely login form

asHttpClientDataWith

public org.apache.commons.httpclient.NameValuePair[] asHttpClientDataWith(String username,
                                                                 String password)

Create the NameValuePair array expected by HttpClient, merging username and password into the appropriate value slots.

Parameters:

username -

password -

Returns:

toString

public String toString()

Overrides:

toString in class Object

asAnnotation

public String asAnnotation()

Provide abbreviated annotation, of the form... "form:Phhpt" ...where the first capital letter indicates submission type, G[ET] or P[OST], and following lowercase letters types of inputs in order, by their first letter.

Returns:

String suitable for brief crawl.log annotation