org.apache.manifoldcf.crawler.connectors.webcrawler

Class CookieManager.CookiesExecutor

java.lang.Object

org.apache.manifoldcf.core.cachemanager.ExecutorBase

org.apache.manifoldcf.crawler.connectors.webcrawler.CookieManager.CookiesExecutor

All Implemented Interfaces:

org.apache.manifoldcf.core.interfaces.ICacheExecutor

Enclosing class:

CookieManager

protected static class CookieManager.CookiesExecutor
extends org.apache.manifoldcf.core.cachemanager.ExecutorBase

This is the executor object for locating cookies session objects. This object furnishes the operations the cache manager needs to rebuild objects that it needs that are not in the cache at the moment.

Field Summary

Fields

Modifier and Type	Field and Description
protected LoginCookies	returnValue
protected CookieManager.CookiesDescription	thisDescription
protected CookieManager	thisManager

Fields inherited from class org.apache.manifoldcf.core.cachemanager.ExecutorBase

_rcsid

Constructor Summary

Constructors

Constructor and Description
CookiesExecutor(CookieManager manager, CookieManager.CookiesDescription objectDescription) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	create(org.apache.manifoldcf.core.interfaces.ICacheDescription[] objectDescriptions) Create a set of new objects to operate on and cache.
void	execute() Perform the desired operation.
void	exists(org.apache.manifoldcf.core.interfaces.ICacheDescription objectDescription, java.lang.Object cachedObject) Notify the implementing class of the existence of a cached version of the object.
LoginCookies	getResults() Get the result.

Methods inherited from class java.lang.Object

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

Field Detail

thisManager

protected CookieManager thisManager

returnValue

protected LoginCookies returnValue

thisDescription

protected CookieManager.CookiesDescription thisDescription

Constructor Detail

CookiesExecutor

public CookiesExecutor(CookieManager manager,
                       CookieManager.CookiesDescription objectDescription)

Constructor.

Parameters:

manager - is the RobotsManager class instance.

objectDescription - is the desired object description.

Method Detail

getResults

public LoginCookies getResults()

Get the result.

Returns:

the looked-up or read cached instance.

create

public java.lang.Object[] create(org.apache.manifoldcf.core.interfaces.ICacheDescription[] objectDescriptions)
                          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Create a set of new objects to operate on and cache. This method is called only if the specified object(s) are NOT available in the cache. The specified objects should be created and returned; if they are not created, it means that the execution cannot proceed, and the execute() method will not be called.

Parameters:

objectDescriptions - is the set of unique identifier of the object.

Returns:

the newly created objects to cache, or null, if any object cannot be created. The order of the returned objects must correspond to the order of the object descriptinos.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

exists

public void exists(org.apache.manifoldcf.core.interfaces.ICacheDescription objectDescription,
                   java.lang.Object cachedObject)
            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Notify the implementing class of the existence of a cached version of the object. The object is passed to this method so that the execute() method below will have it available to operate on. This method is also called for all objects that are freshly created as well.

Parameters:

objectDescription - is the unique identifier of the object.

cachedObject - is the cached object.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

execute

public void execute()
             throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Perform the desired operation. This method is called after either createGetObject() or exists() is called for every requested object.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException