edu.uci.ics.crawler4j.crawler.authentication

Class AuthInfo

java.lang.Object

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

Direct Known Subclasses:

BasicAuthInfo, FormAuthInfo, NtAuthInfo

public abstract class AuthInfo
extends Object

Created by Avi Hayun on 11/23/2014. Abstract class containing authentication information needed to login into a user/password protected site
This class should be extended by specific authentication types like form authentication and basic authentication etc

This class contains all of the mutual authentication data for all authentication types

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthInfo.AuthenticationType

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthInfo.AuthenticationType	authenticationType
protected String	host
protected FormSubmitEvent.MethodType	httpMethod
protected String	loginTarget
protected String	password
protected int	port
protected String	protocol
protected String	username

Constructor Summary

Constructors

Modifier	Constructor and Description
	AuthInfo() Constructs a new AuthInfo.
protected	AuthInfo(AuthInfo.AuthenticationType authenticationType, FormSubmitEvent.MethodType httpMethod, String loginUrl, String username, String password) This constructor should only be used by extending classes

Method Summary

Modifier and Type	Method and Description
AuthInfo.AuthenticationType	getAuthenticationType()
String	getHost()
FormSubmitEvent.MethodType	getHttpMethod()
String	getLoginTarget()
String	getPassword()
int	getPort()
String	getProtocol()
String	getUsername()
void	setAuthenticationType(AuthInfo.AuthenticationType authenticationType)
void	setHost(String host)
void	setHttpMethod(FormSubmitEvent.MethodType httpMethod)
void	setLoginTarget(String loginTarget)
void	setPassword(String password)
void	setPort(int port)
void	setProtocol(String protocol)
void	setUsername(String username)

Methods inherited from class java.lang.Object

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

Field Detail

authenticationType

protected AuthInfo.AuthenticationType authenticationType

httpMethod

protected FormSubmitEvent.MethodType httpMethod

protocol

protected String protocol

host

protected String host

loginTarget

protected String loginTarget

port

protected int port

username

protected String username

password

protected String password

Constructor Detail

AuthInfo

public AuthInfo()

Constructs a new AuthInfo.

AuthInfo

protected AuthInfo(AuthInfo.AuthenticationType authenticationType,
                   FormSubmitEvent.MethodType httpMethod,
                   String loginUrl,
                   String username,
                   String password)
            throws MalformedURLException

This constructor should only be used by extending classes

Parameters:

authenticationType - Pick the one which matches your authentication

httpMethod - Choose POST / GET

loginUrl - Full URL of the login page

username - Username for Authentication

password - Password for Authentication

Throws:

MalformedURLException - Make sure your URL is valid

Method Detail

getAuthenticationType

public AuthInfo.AuthenticationType getAuthenticationType()

Returns:

Authentication type (BASIC, FORM)

setAuthenticationType

public void setAuthenticationType(AuthInfo.AuthenticationType authenticationType)

Parameters:

authenticationType - Should be set only by extending classes (BASICAuthInfo, FORMAuthInfo)

getHttpMethod

public FormSubmitEvent.MethodType getHttpMethod()

Returns:

httpMethod (POST, GET)

setHttpMethod

public void setHttpMethod(FormSubmitEvent.MethodType httpMethod)

Parameters:

httpMethod - Should be set by extending classes (POST, GET)

getProtocol

public String getProtocol()

Returns:

protocol type (http, https)

setProtocol

public void setProtocol(String protocol)

Parameters:

protocol - Don't set this one unless you know what you are doing (protocol: http, https)

getHost

public String getHost()

Returns:

host (www.sitename.com)

setHost

public void setHost(String host)

Parameters:

host - Don't set this one unless you know what you are doing (sets the domain name)

getLoginTarget

public String getLoginTarget()

Returns:

file/path which is the rest of the url after the domain name (eg: /login.php)

setLoginTarget

public void setLoginTarget(String loginTarget)

Parameters:

loginTarget - Don't set this one unless you know what you are doing (eg: /login.php)

getPort

public int getPort()

Returns:

port number (eg: 80, 443)

setPort

public void setPort(int port)

Parameters:

port - Don't set this one unless you know what you are doing (eg: 80, 443)

getUsername

public String getUsername()

Returns:

username used for Authentication

setUsername

public void setUsername(String username)

Parameters:

username - username used for Authentication

getPassword

public String getPassword()

Returns:

password used for Authentication

setPassword

public void setPassword(String password)

Parameters:

password - password used for Authentication