01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.core.node;
28:
29: import java.util.Set;
30:
31: import org.cougaar.core.component.Service;
32: import org.cougaar.core.mts.MessageAddress;
33: import org.cougaar.core.service.AgentIdentificationService;
34:
35: /**
36: * This service is used by agents to note when they are busy in
37: * an action that may block communication, such as persistence.
38: * <p>
39: * This service is advertised in the root service broker for
40: * access by all agents on the node.
41: */
42: public interface NodeBusyService extends Service {
43: /**
44: * The component using this must supply AgentIdentificationService
45: * capable of correctly identifying the agent using the service
46: * before it can call the setAgentBusy method.
47: */
48: void setAgentIdentificationService(AgentIdentificationService ais);
49:
50: /**
51: * The agent using this service must have already identified itself
52: * using the setAgentIdentificationService before calling this
53: * method. This avoids the possibilility of misrepresenting the
54: * agent.
55: */
56: void setAgentBusy(boolean busy);
57:
58: /**
59: * Anybody can check if an agent is busy.
60: */
61: boolean isAgentBusy(MessageAddress agent);
62:
63: /**
64: * @return an unmodifiable set of busy agents (MessageAddress elements).
65: */
66: Set getBusyAgents();
67: }
|