Java Doc for BlackboardClientComponent.java in » Science » Cougaar12_4 » org » cougaar » core » blackboard » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.core.blackboard

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.cougaar.util .GenericStateModelAdapter

org.cougaar.core.blackboard .BlackboardClientComponent

All known Subclasses:   org.cougaar.community .BlackboardClient,  org.cougaar.core.plugin .ComponentPlugin,
BlackboardClientComponent
abstract public class BlackboardClientComponent extends org.cougaar.util.GenericStateModelAdapter implements Component,BlackboardClient(Code)
This component is a standard base class for Component s that use the BlackboardService .
Plugins are the most common example of such components.
ComponentPlugin is an extension of this class.
Create a derived class by implementing setupSubscriptions() and execute().
Note that both "precycle()" and "cycle()" will be run by the scheduler. This means that the scheduling order in relation to other scheduled Components may be *random* (i.e. this BlackboardClientComponent might load first but be precycled last!). In general a Component should not make assumptions about the load or schedule ordering.
See Also:   org.cougaar.core.plugin.ComponentPlugin

Field Summary
protected MessageAddress agentId

protected AgentIdentificationService agentIdentificationService

protected AlarmService alarmService

protected BlackboardService blackboard

protected String blackboardClientName


Constructor Summary
public BlackboardClientComponent()


Method Summary
public long currentTimeMillis()

protected void cycle()

abstract protected void execute()
     Called every time this component is scheduled to run.
protected MessageAddress getAgentIdentifier()
     Get the local agent's address.
protected AlarmService getAlarmService()
     Get the alarm service, for subclass use.
protected BindingSite getBindingSite()
     Get the binding site, for subclass use.
public String getBlackboardClientName()

protected BlackboardService getBlackboardService()
     Get the blackboard service, for subclass use.
protected MessageAddress getMessageAddress()

public Object getParameter()

public Collection getParameters()
     Get any Component parameters passed by the instantiator.
protected ServiceBroker getServiceBroker()
     Get the ServiceBroker, for subclass use.
public void halt()

public void load()

protected void precycle()

final protected void requestCycle()

public void resume()

final public void setAgentIdentificationService(AgentIdentificationService ais)

final public void setAlarmService(AlarmService s)

public void setBindingSite(BindingSite bs)
     Binding site is set by reflection at creation-time.
final public void setBlackboardService(BlackboardService bs)

public void setParameter(Object param)
     Called just after construction (via introspection) by the loader if a non-null parameter Object was specified by the ComponentDescription.
final public void setSchedulerService(SchedulerService ss)

public void setServiceBroker(ServiceBroker sb)
     ServiceBroker is set by reflection at creation-time.
public void setSuicideService(SuicideService ss)

abstract protected void setupSubscriptions()
     Called once after initialization, as a pre- BlackboardClientComponent.execute .
protected boolean shouldExecute()

public void start()

public void stop()

public void suspend()

public String toString()

public void unload()

final protected boolean wasAwakened()
     True IFF were we awakened explicitly (i.e.

Field Detail
agentId
protected MessageAddress agentId(Code)

agentIdentificationService
protected AgentIdentificationService agentIdentificationService(Code)

alarmService
protected AlarmService alarmService(Code)

blackboard
protected BlackboardService blackboard(Code)

blackboardClientName
protected String blackboardClientName(Code)

Constructor Detail
BlackboardClientComponent
public BlackboardClientComponent()(Code)

Method Detail
currentTimeMillis
public long currentTimeMillis()(Code)

cycle
protected void cycle()(Code)

execute
abstract protected void execute()(Code)
Called every time this component is scheduled to run.

getAgentIdentifier
protected MessageAddress getAgentIdentifier()(Code)
Get the local agent's address. Also consider adding a "getMessageAddress()" method backed by the NodeIdentificationService.

getAlarmService
protected AlarmService getAlarmService()(Code)
Get the alarm service, for subclass use.

getBindingSite
protected BindingSite getBindingSite()(Code)
Get the binding site, for subclass use.

getBlackboardClientName
public String getBlackboardClientName()(Code)

getBlackboardService
protected BlackboardService getBlackboardService()(Code)
Get the blackboard service, for subclass use.

getMessageAddress
protected MessageAddress getMessageAddress()(Code)

getParameter
public Object getParameter()(Code)
the parameter set by BlackboardClientComponent.setParameter

getParameters
public Collection getParameters()(Code)
Get any Component parameters passed by the instantiator. The parameter specifiedif it was a collection, a collection with one element (the parameter) if it wasn't a collection, or an empty collection if the parameter wasn'tspecified.

getServiceBroker
protected ServiceBroker getServiceBroker()(Code)
Get the ServiceBroker, for subclass use.

halt
public void halt()(Code)

load
public void load()(Code)

precycle
protected void precycle()(Code)

requestCycle
final protected void requestCycle()(Code)

resume
public void resume()(Code)

setAgentIdentificationService
final public void setAgentIdentificationService(AgentIdentificationService ais)(Code)

setAlarmService
final public void setAlarmService(AlarmService s)(Code)

setBindingSite
public void setBindingSite(BindingSite bs)(Code)
Binding site is set by reflection at creation-time.

setBlackboardService
final public void setBlackboardService(BlackboardService bs)(Code)

setParameter
public void setParameter(Object param)(Code)
Called just after construction (via introspection) by the loader if a non-null parameter Object was specified by the ComponentDescription.

setSchedulerService
final public void setSchedulerService(SchedulerService ss)(Code)

setServiceBroker
public void setServiceBroker(ServiceBroker sb)(Code)
ServiceBroker is set by reflection at creation-time.

setSuicideService
public void setSuicideService(SuicideService ss)(Code)

setupSubscriptions
abstract protected void setupSubscriptions()(Code)
Called once after initialization, as a pre- BlackboardClientComponent.execute .

shouldExecute
protected boolean shouldExecute()(Code)

start
public void start()(Code)

stop
public void stop()(Code)

suspend
public void suspend()(Code)

toString
public String toString()(Code)

unload
public void unload()(Code)

wasAwakened
final protected boolean wasAwakened()(Code)
True IFF were we awakened explicitly (i.e. we were asked to run even if no subscription activity has happened). The value is valid only within the scope of the cycle() method.

Methods inherited from org.cougaar.util.GenericStateModelAdapter
final public int getModelState()(Code)(Java Doc)
public synchronized void halt() throws StateModelException(Code)(Java Doc)
public synchronized void initialize() throws StateModelException(Code)(Java Doc)
public synchronized void load() throws StateModelException(Code)(Java Doc)
public synchronized void resume() throws StateModelException(Code)(Java Doc)
public synchronized void start() throws StateModelException(Code)(Java Doc)
public synchronized void stop() throws StateModelException(Code)(Java Doc)
public synchronized void suspend() throws StateModelException(Code)(Java Doc)
protected synchronized void transitState(String op, int expectedState, int endState) throws StateModelException(Code)(Java Doc)
public synchronized void unload() throws StateModelException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.