org.apache.manifoldcf.crawler.connectors.webcrawler

Class CredentialsDescription.SessionCredential

java.lang.Object

org.apache.manifoldcf.crawler.connectors.webcrawler.CredentialsDescription.SessionCredential

All Implemented Interfaces:

AuthenticationCredentials, SequenceCredentials

Enclosing class:

CredentialsDescription

protected static class CredentialsDescription.SessionCredential
extends java.lang.Object
implements SequenceCredentials

Session credentials

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	sequenceKey
protected java.util.List<CredentialsDescription.SessionCredentialItem>	sessionPages

Fields inherited from interface org.apache.manifoldcf.crawler.connectors.webcrawler.SequenceCredentials

_rcsid

Constructor Summary

Constructors

Constructor and Description
SessionCredential(java.lang.String sequenceKey) Constructor

Method Summary

Modifier and Type	Method and Description
int	addAuthPage(java.lang.String urlregexp, java.util.regex.Pattern urlPattern, java.lang.String overrideTargetURL, java.lang.String preferredLinkRegexp, java.util.regex.Pattern preferredLinkPattern, java.lang.String formNameRegexp, java.util.regex.Pattern formNamePattern, java.lang.String preferredRedirectionRegexp, java.util.regex.Pattern preferredRedirectionPattern, java.lang.String contentRegexp, java.util.regex.Pattern contentPattern) Add an auth page
void	addPageParameter(int authPageIndex, java.lang.String urlregexp, java.lang.String paramNameRegexp, java.util.regex.Pattern paramNamePattern, java.lang.String paramValue) Add a page parameter
boolean	equals(java.lang.Object o) Compare against another object
java.util.Iterator	findLoginParameters(java.lang.String documentIdentifier) For a given login page, specific information may need to be submitted to the server to properly log in.
java.lang.String	getSequenceKey() Fetch the unique key value for this particular credential.
int	hashCode() Calculate a hash function

Methods inherited from class java.lang.Object

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

Field Detail

sequenceKey

protected final java.lang.String sequenceKey

sessionPages

protected final java.util.List<CredentialsDescription.SessionCredentialItem> sessionPages

Constructor Detail

SessionCredential

public SessionCredential(java.lang.String sequenceKey)

Constructor

Method Detail

addAuthPage

public int addAuthPage(java.lang.String urlregexp,
                       java.util.regex.Pattern urlPattern,
                       java.lang.String overrideTargetURL,
                       java.lang.String preferredLinkRegexp,
                       java.util.regex.Pattern preferredLinkPattern,
                       java.lang.String formNameRegexp,
                       java.util.regex.Pattern formNamePattern,
                       java.lang.String preferredRedirectionRegexp,
                       java.util.regex.Pattern preferredRedirectionPattern,
                       java.lang.String contentRegexp,
                       java.util.regex.Pattern contentPattern)
                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Add an auth page

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

addPageParameter

public void addPageParameter(int authPageIndex,
                             java.lang.String urlregexp,
                             java.lang.String paramNameRegexp,
                             java.util.regex.Pattern paramNamePattern,
                             java.lang.String paramValue)

Add a page parameter

getSequenceKey

public java.lang.String getSequenceKey()

Fetch the unique key value for this particular credential. (This is used to enforce the proper page ordering).

Specified by:

getSequenceKey in interface SequenceCredentials

findLoginParameters

public java.util.Iterator findLoginParameters(java.lang.String documentIdentifier)
                                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

For a given login page, specific information may need to be submitted to the server to properly log in. This information must be specified as part of the login sequence description information. If null is returned, then this page has no specific login information.

Specified by:

findLoginParameters in interface SequenceCredentials

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

equals

public boolean equals(java.lang.Object o)

Compare against another object

Specified by:

equals in interface AuthenticationCredentials

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Calculate a hash function

Specified by:

hashCode in interface AuthenticationCredentials

Overrides:

hashCode in class java.lang.Object