edu.uci.ics.crawler4j.crawler.authentication

Class FormAuthInfo

java.lang.Object

edu.uci.ics.crawler4j.crawler.authentication.AuthInfo

edu.uci.ics.crawler4j.crawler.authentication.FormAuthInfo

public class FormAuthInfo
extends AuthInfo

Created by Avi Hayun on 11/25/2014. FormAuthInfo contains the authentication information needed for FORM authentication (extending AuthInfo which has all common auth info in it) Basically, this is the most common authentication, where you will get to a site and you will need to enter a username and password into an HTML form

Nested Class Summary

Nested classes/interfaces inherited from class edu.uci.ics.crawler4j.crawler.authentication.AuthInfo

AuthInfo.AuthenticationType

Field Summary

Fields inherited from class edu.uci.ics.crawler4j.crawler.authentication.AuthInfo

authenticationType, host, httpMethod, loginTarget, password, port, protocol, username

Constructor Summary

Constructors

Constructor and Description
FormAuthInfo(String username, String password, String loginUrl, String usernameFormStr, String passwordFormStr) Constructor

Method Summary

Modifier and Type	Method and Description
String	getPasswordFormStr()
String	getUsernameFormStr()
void	setPasswordFormStr(String passwordFormStr)
void	setUsernameFormStr(String usernameFormStr)

Methods inherited from class edu.uci.ics.crawler4j.crawler.authentication.AuthInfo

getAuthenticationType, getHost, getHttpMethod, getLoginTarget, getPassword, getPort, getProtocol, getUsername, setAuthenticationType, setHost, setHttpMethod, setLoginTarget, setPassword, setPort, setProtocol, setUsername

Methods inherited from class java.lang.Object

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

Constructor Detail

FormAuthInfo

public FormAuthInfo(String username,
                    String password,
                    String loginUrl,
                    String usernameFormStr,
                    String passwordFormStr)
             throws MalformedURLException

Constructor

Parameters:

username - Username to login with

password - Password to login with

loginUrl - Full login URL, starting with "http"... ending with the full URL

usernameFormStr - "Name" attribute of the username form field

passwordFormStr - "Name" attribute of the password form field

Throws:

MalformedURLException - Make sure your URL is valid

Method Detail

getUsernameFormStr

public String getUsernameFormStr()

Returns:

username html "name" form attribute

setUsernameFormStr

public void setUsernameFormStr(String usernameFormStr)

Parameters:

usernameFormStr - username html "name" form attribute

getPasswordFormStr

public String getPasswordFormStr()

Returns:

password html "name" form attribute

setPasswordFormStr

public void setPasswordFormStr(String passwordFormStr)

Parameters:

passwordFormStr - password html "name" form attribute