KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > clif > storage > api > StorageProxyAdmin


1 /*
2 * CLIF is a Load Injection Framework
3 * Copyright (C) 2003 France Telecom R&D
4 * Copyright (C) 2003 INRIA
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * CLIF $Name: $
21 *
22 * Contact: clif@objectweb.org
23 */
24
25 package org.objectweb.clif.storage.api;
26
27 import org.objectweb.clif.supervisor.api.ClifException;
28 import java.io.Serializable JavaDoc;
29
30
31 /**
32  * Optional interface for controlling local storage system
33  *
34  * @author Julien Buret
35  * @author Nicolas Droze
36  * @author Bruno Dillenseger
37  */
38 public interface StorageProxyAdmin
39 {
40     static public final String JavaDoc STORAGEPROXY_ADMIN = "Storage proxy administration";
41
42     /**
43      * Initialize the storage proxy
44      */
45     public void init(String JavaDoc bladeId);
46
47     /**
48      * Informs the storage system of a new local test
49      * @param testId test unique identifier
50      */
51     public void newTest(Serializable JavaDoc testId) throws ClifException;
52
53
54     /**
55      * Informs the storage system that the local test is terminated
56      */
57     public void closeTest();
58
59
60     /**
61      * Get the hostName of this interface
62      * @return The host name
63      */
64     public String JavaDoc getBladeId();
65
66
67     /**
68      * Initializes a new collect for a given test
69      * @param testId the test identifier whose results must be collected
70      * @return an identifier for this collect
71      * @see #collect(CollectKey)
72      * @see #getCollectSize(CollectKey)
73      * @see #closeCollect(CollectKey)
74      */
75     public CollectKey initCollect(Serializable JavaDoc testId);
76
77
78     /**
79      * Performs one collect step forward. Repeated calls to this method may be done
80      * to achieve a full collect (until it returns a null value).
81      * @param key the collect identifier
82      * @return null if the collect is completed, or an arbitrary serializable object
83      * whose interpretation depends on the StorageProxy implementation.
84      */
85     public Serializable JavaDoc collect(CollectKey key);
86
87
88     /**
89      *
90      */
91     public long getCollectSize(CollectKey key);
92
93
94     /**
95      *
96      */
97     public void closeCollect(CollectKey key);
98 }
99
Popular Tags