org.eclipse.smila.connectivity.deltaindexing
Interface DeltaIndexingManagerAgent

All Known Implementing Classes:

AbstractDeltaIndexingManagerAgent, DeltaIndexingManagerAgentImpl, DeltaIndexingManagerAgentImpl

public interface DeltaIndexingManagerAgent

The Interface DeltaIndexingManagerAgent.

Method Summary

java.lang.String	clear(java.lang.String dataSourceID) Clear all entries of the DeltaIndexingManager for the given dataSourceID.
java.lang.String	clearAll() Clears all entries of the DeltaIndexingManager including entries of any active sessions! Note that this may cause errors in clients currently using any of the closed sessions.
java.lang.Object	getEntryCount(java.lang.String dataSourceID) Get the number of delta indexing entries for the given dataSourceID.
java.util.Map<java.lang.String,java.lang.Long>	getEntryCounts() Get the number of delta indexing entries for all data sources.
java.util.Map<java.lang.String,java.lang.String>	getLockStates() Get an overview what data sources are locked or unlocked.
java.lang.String	unlock(java.lang.String dataSourceID) Unlock the given data source and removes the sessions.
java.lang.String	unlockAll() Unlock all data sources and removes all sessions.

Method Detail

clear

java.lang.String clear(java.lang.String dataSourceID)

Clear all entries of the DeltaIndexingManager for the given dataSourceID. You cannot execute this command on an already locked data source. If you want to clear a locked data source you have to unlock it first.

Parameters:

dataSourceID - the data source id

Returns:

a message saying either "OK" or describing an error cause.

clearAll

java.lang.String clearAll()

Clears all entries of the DeltaIndexingManager including entries of any active sessions! Note that this may cause errors in clients currently using any of the closed sessions.

Returns:

a message saying either "OK" or describing an error cause.

unlock

java.lang.String unlock(java.lang.String dataSourceID)

Unlock the given data source and removes the sessions. Note that this may cause exceptions in a client currently using the closed sessions.

Parameters:

dataSourceID - the data source id

Returns:

a message saying either "OK" or describing an error cause.

unlockAll

java.lang.String unlockAll()

Unlock all data sources and removes all sessions. Note that this may cause exceptions in clients currently using any of the closed sessions.

Returns:

a message saying either "OK" or describing an error cause.

getLockStates

java.util.Map<java.lang.String,java.lang.String> getLockStates()

Get an overview what data sources are locked or unlocked.

Returns:

a map containing the dataSoureId and the LockState

getEntryCount

java.lang.Object getEntryCount(java.lang.String dataSourceID)

Get the number of delta indexing entries for the given dataSourceID.

Parameters:

dataSourceID - the data source id

Returns:

either a Long giving the number of entries or a String with an error message.

getEntryCounts

java.util.Map<java.lang.String,java.lang.Long> getEntryCounts()

Get the number of delta indexing entries for all data sources.

Returns:

a map containing the dataSoureId and the entry count