| org.cougaar.core.service |
|
This package contains the Cougaar
primary core service APIs.
The general rule is to place service APIs in
"org.cougaar.core.service" if they are used by many clients
(e.g. the {@link org.cougaar.core.service.BlackboardService})
or if the implementation is defined in an external module (e.g.
the {@link org.cougaar.core.service.MessageTransportService}).
However, for legacy reasons, there are several exceptions to this
rule that could be refactored, such as the commonly-used {@link
org.cougaar.core.node.NodeControlService} and restricted
{@link org.cougaar.core.service.DomainForBlackboardService}.
For more detail, see the
Cougaar Developers' Guide.
|
| Java Source File Name | Type | Comment |
| AgentContainmentService.java | Interface | This service allows a component to add/remove components from
its agent. |
| AgentIdentificationService.java | Interface | This service provides the local agent's
MessageAddress . |
| AgentQuiescenceStateService.java | Interface | This service allows a component to query the agents registered
with the node's
QuiescenceReportService and mark agents
as dead (ignorable) when they have been restarted on another
node. |
| AlarmService.java | Interface | This service provides access to the time-based alarm services
(real-time and execution-time). |
| AppletService.java | Interface | This service provides access to Applet methods, and is only available if
the node was launched from within a browser
java.applet.Applet .
There are dozens of Applet methods, including all methods defined in
AWT "Component". |
| BlackboardMetricsService.java | Interface | This service provides primitive blackboard metrics. |
| BlackboardQueryService.java | Interface | This service offers a lightweight query-only version of
BlackboardService . |
| BlackboardService.java | Interface | This service provides transactional publish/subscribe access to
the local agent's blackboard. |
| BlackboardTimestampService.java | Interface | This service tracks timestamps for the ADD (
BlackboardService.publishAdd ) and the more recent modification
(
BlackboardService.publishChange ) of
org.cougaar.core.util.UniqueObject s. |
| ConditionService.java | Interface | This service is used by the
org.cougaar.core.adaptivity.AdaptivityEngine to look up sensor
data on the blackboard. |
| ConfigurationService.java | Interface | This service provides access to the file system by searching
the configuration path.
The standard implementation is backed by the
org.cougaar.util.ConfigFinder . |
| DataProtectionKey.java | Interface | An interface used by the
DataProtectionService . |
| DataProtectionKeyEnvelope.java | Interface | Implementations of this interface contain a secret key used to
encrypt/decrypt persisted data. |
| DataProtectionService.java | Interface | This service is used by persistence to sign/encrypt an
OutputStream and verify/decrypt an
InputStream . |
| DataProtectionServiceClient.java | Interface | Required service requestor API for
DataProtectionService clients. |
| DemoControlService.java | Interface | This service controls the execution time in
AlarmService.currentTimeMillis and
AlarmService.addAlarm . |
| DomainForBlackboardService.java | Interface | This service is an extended
DomainService for the
Blackboard 's use. |
| DomainService.java | Interface | This service provides access to
org.cougaar.core.domain.Domain object
org.cougaar.core.domain.Factory s. |
| EventService.java | Interface | This service is used to log assessment events.
Events are intended for external profiling and monitoring
applications and often follow a strict application-defined
syntax. |
| IncarnationService.java | Interface | This service tracks agent incarnation numbers, which are
updated every time the agent restarts (excluding agent
mobility). |
| JvmStackDumpService.java | Interface | This service requests a JVM-wide stack dump.
Access to this service will likely be restricted to a
limited subset of node-agent components. |
| LoggingService.java | Interface | This Service provides a generic logging API. |
| MessageProtectionService.java | Interface | This service is used to cryptographically protect incoming
and outgoing messages. |
| MessageStatisticsService.java | Interface | This service provides message transport statistics, such as
the total number of messages sent by the local node. |
| MessageTransportService.java | Interface | This service is the node-level message transport that agents
use to send and receive messages. |
| MessageWatcherService.java | Interface | This service allows components to watch message send/receive
activity. |
| NodeMetricsService.java | Interface | This service provides simple node-level metrics. |
| OperatingModeService.java | Interface | This service is used by the
org.cougaar.core.adaptivity.AdaptivityEngine to find
OperatingMode s on the blackboard. |
| PersistenceControlService.java | Interface | This service can be used to view and modify persistence
settings. |
| PersistenceMetricsService.java | Interface | This service provides metrics for recent persistence activity,
such as the most recent snapshot size in bytes. |
| PlaybookConstrainService.java | Interface | This service allows components to modify
org.cougaar.core.adaptivity.AdaptivityEngine plays and playbooks. |
| PlaybookReadService.java | Interface | This service is used by the
org.cougaar.core.adaptivity.AdaptivityEngine to get
the list of current plays. |
| QuiescenceReportForDistributorService.java | Interface | This service is used by the
org.cougaar.core.blackboard.Distributor to tell the node when
a local agent is quiescent or not. |
| QuiescenceReportService.java | Interface | This service is used by components to tell the node the initial
quiescence numbering and to toggle between quiescence and
non-quiescence.
"Quiescence" is partially a node-local concept, where all local
agents have completed processing, and a society-wide concept,
where all inter-agent messages have been delivered. |
| SchedulerService.java | Interface | This service is used to schedule plugins for thread execution. |
| ServletService.java | Interface | This service can be used to register a Servlet
for all HTTP requests that match a specified String path.
This is analogous to a java.util.Map:
- register with "put(name, value)"
- unregister with "remove(name)"
- unregister-all with "clear()"
"unregisterAll" is called automatically when this service
is released back to the ServiceBroker. |
| SocketFactoryService.java | Interface | This service is used to get a socket factory, such as an
java.rmi.server.RMISocketFactory . |
| SuicideService.java | Interface | This service is used to tell the agent (or node) to exit, for
example due to an
java.lang.OutOfMemoryError . |
| ThreadControlService.java | Interface | This service controls the
ThreadService . |
| ThreadListenerService.java | Interface | This service allows components to watch
ThreadService activity. |
| ThreadService.java | Interface | This service provides a
Schedulable s to execute a
Runnable.run method within a pooled thread.
The "consumer" is typically the service requestor.
The "lane" is an option parameter that differentiates service
based on expected thread use, e.g. |
| UIDServer.java | Interface | This service is the backwards-compatible API for the
UIDService . |
| UIDService.java | Interface | This service provides
org.cougaar.core.util.UID s, which
are globally unique object identifiers. |
| WebServicesService.java | Interface | This service allows a component to register a WSDD
(Web Services Deployment Descriptor) to receive
remote Web Services XML-based calls. |