KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > mobilitools > smi > api > AgentInfo


1 /*
2 * MobiliTools: an implementation of the Object Management Group's
3 * Mobile Agent Facility specification.
4 * Copyright (C) 2003 France Telecom R&D
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 * MobiliTools $Name: $
21 *
22 * Contact: mobilitools-smi@lists.debian-sf.objectweb.org
23 *
24 * Authors: Bruno Dillenseger
25 */
26
27
28 package org.objectweb.mobilitools.smi.api;
29
30
31 import java.util.Properties JavaDoc;
32
33
34 /**
35  * MobiliTools $Name: $, $Id: AgentInfo.java,v 1.1.1.1 2003/03/28 14:48:05 dillense Exp $
36  * <P>
37  * Interface for getting information about an agent.
38 */
39 public interface AgentInfo
40 {
41     /**
42         @return the Java object reference to the agent.
43     */
44     public MobileObject getAgent();
45
46     /**
47         @return the agent's name.
48     */
49     public Name getName();
50
51     /**
52         @return the name of the place where the agent resides.
53     */
54     public String JavaDoc getPlace();
55
56     /**
57         @return true if the agent is currently active,
58         false if it is suspended.
59     */
60     public boolean isRunning();
61
62     /**
63         Toggle the activity status between running and suspended.
64         @return true if the agent is now running,
65         false if it is suspended.
66     */
67     public boolean toggleRunning();
68
69     /**
70         @return the codebase of the agent's classes.
71     */
72     public String JavaDoc getCodebase();
73
74     /**
75         @return the set of properties attached to the agent.
76     */
77     public Properties JavaDoc getProperties();
78
79     /**
80         @return the opaque data set by an agency personality.
81     */
82     public Object JavaDoc getData();
83 }
84
Popular Tags