Package org.ow2.clif.storage.api

Interface StorageProxyAdmin

All Known Implementing Classes:

FileStorageProxyImpl

public interface StorageProxyAdmin

Optional interface for controlling local storage system

Author:

Julien Buret, Nicolas Droze, Bruno Dillenseger

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STORAGEPROXY_ADMIN

Method Summary

Modifier and Type	Method	Description
void	closeCollect(UniqueKey key)
void	closeTest()	Informs the storage system that the local test is terminated
java.io.Serializable	collect(UniqueKey key)	Performs one collect step forward.
java.lang.String	getBladeId()	Get the hostName of this interface
long	getCollectSize(UniqueKey key)
void	init(java.lang.String bladeId)	Initialize the storage proxy
UniqueKey	initCollect(java.io.Serializable testId)	Initializes a new collect for a given test
void	newTest(java.io.Serializable testId)	Informs the storage system of a new local test

Field Detail

STORAGEPROXY_ADMIN

static final java.lang.String STORAGEPROXY_ADMIN

See Also:

Constant Field Values

Method Detail

init

void init(java.lang.String bladeId)

Initialize the storage proxy

newTest

void newTest(java.io.Serializable testId)
      throws ClifException

Informs the storage system of a new local test

Parameters:

testId - test unique identifier

Throws:

ClifException

closeTest

void closeTest()

Informs the storage system that the local test is terminated

getBladeId

java.lang.String getBladeId()

Get the hostName of this interface

Returns:

The host name

initCollect

UniqueKey initCollect(java.io.Serializable testId)

Initializes a new collect for a given test

Parameters:

testId - the test identifier whose results must be collected

Returns:

an identifier for this collect

See Also:

collect(UniqueKey), getCollectSize(UniqueKey), closeCollect(UniqueKey)

collect

java.io.Serializable collect(UniqueKey key)

Performs one collect step forward. Repeated calls to this method may be done to achieve a full collect (until it returns a null value).

Parameters:

key - the collect identifier

Returns:

null if the collect is completed, or an arbitrary serializable object whose interpretation depends on the StorageProxy implementation.

getCollectSize

long getCollectSize(UniqueKey key)

closeCollect

void closeCollect(UniqueKey key)