SMILA (incubation) API documentation

org.eclipse.smila.connectivity.framework.util
Interface AgentControllerCallback

All Superinterfaces:
ControllerCallback

public interface AgentControllerCallback
extends ControllerCallback

Interface for callbacks on the AgentController. This interface is used by Agents to send add and delete requests and to unregister an agent if a critical error occurred.


Method Summary
 void add(java.lang.String sessionId, DeltaIndexingType deltaIndexingType, Record record, java.lang.String hash)
          Add the given record.
 void delete(java.lang.String sessionId, DeltaIndexingType deltaIndexingType, ConnectivityId id)
          Delete the given id.
 void unregister(java.lang.String sessionId, DeltaIndexingType deltaIndexingType, java.lang.String dataSourceId)
          Removes the Agent using the given DataSourceId from the list of active Agents.
 
Methods inherited from interface org.eclipse.smila.connectivity.framework.util.ControllerCallback
doCheckForUpdate, doDeltaDelete, doDeltaIndexing
 

Method Detail

add

void add(java.lang.String sessionId,
         DeltaIndexingType deltaIndexingType,
         Record record,
         java.lang.String hash)
         throws AgentCriticalException
Add the given record.

Parameters:
sessionId - the delta indexing session Id
deltaIndexingType - the DeltaIndexingType
record - the record to add
hash - the hash value used for delta indexing
Throws:
AgentCriticalException - if agent should abort, because sending further requests does not make any sense.

delete

void delete(java.lang.String sessionId,
            DeltaIndexingType deltaIndexingType,
            ConnectivityId id)
            throws AgentCriticalException
Delete the given id.

Parameters:
sessionId - the delta indexing session Id
deltaIndexingType - the DeltaIndexingType
id - the id of the record to delete
Throws:
AgentCriticalException - if agent should abort, because sending further requests does not make any sense.

unregister

void unregister(java.lang.String sessionId,
                DeltaIndexingType deltaIndexingType,
                java.lang.String dataSourceId)
Removes the Agent using the given DataSourceId from the list of active Agents.

Parameters:
sessionId - the delta indexing session Id
deltaIndexingType - the DeltaIndexingType
dataSourceId - the ID of the data source used by the crawl

SMILA (incubation) API documentation