01: /*
02: * <copyright>
03: *
04: * Copyright 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.plugin;
28:
29: import org.cougaar.core.agent.service.alarm.Alarm;
30: import org.cougaar.core.agent.service.alarm.AlarmBase;
31: import org.cougaar.core.service.BlackboardService;
32:
33: /**
34: * A standard {@link Alarm} implementation.
35: *
36: * @see org.cougaar.core.blackboard.TodoSubscription Also see the "todo"
37: * subscription pattern for handling expired alarms.
38: */
39: public abstract class PluginAlarm extends AlarmBase {
40:
41: /** Construct an alarm to expire */
42: public PluginAlarm(long time) {
43: super (time);
44: }
45:
46: protected abstract BlackboardService getBlackboardService();
47:
48: public final void onExpire() {
49: BlackboardService bb = getBlackboardService();
50: if (bb != null) {
51: bb.signalClientActivity();
52: } else {
53: // No blackboard
54: // Possibly a left over alarm from a plugin that has terminated.
55: }
56: }
57: }
|