Package 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.

Author:

gojomo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	HTMLForm.FormInput
static class	HTMLForm.NameValue

Field Summary

Fields

Modifier and Type	Field	Description
protected String	action
protected List<HTMLForm.FormInput>	allInputs
protected List<HTMLForm.FormInput>	candidatePasswordInputs
protected List<HTMLForm.FormInput>	candidateUsernameInputs
protected String	enctype
protected String	method

Constructor Summary

Constructors

Constructor	Description
HTMLForm()

Method Summary

Modifier and Type	Method	Description
void	addField(String type, String name, String value)	Add a discovered INPUT, tracking it as potential username/password receiver.
void	addField(String type, String name, String value, boolean checked)	Add a discovered INPUT, tracking it as potential username/password receiver.
String	asAnnotation()	Provide abbreviated annotation, of the form...
LinkedList<HTMLForm.NameValue>	formData(String username, String password)
String	getAction()
String	getEnctype()
boolean	isMultipleFormSubmitInputs(String type)
protected HTMLForm.FormInput	presumedUsernameInput()
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	setEnctype(String enctype)
void	setMethod(String method)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

method

protected String method

action

protected String action

enctype

protected String enctype

allInputs

protected List<HTMLForm.FormInput> allInputs

candidateUsernameInputs

protected List<HTMLForm.FormInput> candidateUsernameInputs

candidatePasswordInputs

protected List<HTMLForm.FormInput> candidatePasswordInputs

Constructor Details

HTMLForm

public HTMLForm()

Method Details

addField

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

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

Parameters:

type -

name -

value -

checked - true if "checked" attribute is present (for radio buttons and checkboxes)

isMultipleFormSubmitInputs

public boolean isMultipleFormSubmitInputs(String type)

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)

getEnctype

public String getEnctype()

setEnctype

public void setEnctype(String enctype)

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

presumedUsernameInput

protected HTMLForm.FormInput presumedUsernameInput()

formData

public LinkedList<HTMLForm.NameValue> formData(String username,
 String password)

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