Java Doc for AggregationClient.java in  » Science » Cougaar12_4 » org » cougaar » lib » aggagent » client » 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 Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net 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.lib.aggagent.client   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.cougaar.lib.aggagent.client.AggregationClient AggregationClient public class AggregationClient (Code) The AggregationPSPClient provides a client-side communication abstraction to a specific Aggregation Servlet. It provides a simple interface to the functionality provided by the Aggregation Agent utilizing the Aggregation PSP's XML interface. It manages both transient requests and persistent sessions using both transient and keep alive connection(s) with the Aggregation Servlet. The core functions provided by the Aggregation Agent that can be accessed via this interface follow: Creation and management of both transient and persistent queries that can gather and aggregate any type of data from a set of clusters. Creation and management of Alerts which can be used to watch for a particular condition to be met in a persistent query's result set. Event driven incremental monitoring of changing result sets and alerts on the Aggregation Agent's blackboard Constructor Summary public   AggregationClient(String clusterURL, String aggregationName, String keepAliveName)      Create a new client interface to a specific Aggregation Agent. Parameters:   clusterURL - text url of the aggregation agent's cluster Parameters:   aggregationName - name given to aggregation servlet on givenaggregation agent. Method Summary public  boolean cancelAlert(String queryId, String alertName)      Request cancelation of an active alert. public  boolean cancelQuery(String queryId)      Request cancelation of an active persistent query. public  boolean createAlert(AlertDescriptor ad)      Request the creation of an alert on aggregation agent. Parameters:   ad - alert descriptor that fully describes the alert. public  AlertMonitor createAlertMonitor()      Create an monitor object that can be used to keep a set of monitored alerts current by using a keep alive session which sends incremental updates from the AggregationPSP. public  AlertMonitor createAlertMonitor(int waitPeriod)      Create an monitor object that can be used to keep a set of monitored alerts current by periodically pulling from a passive session on AggregationPSP. public  Object createQuery(AggregationQuery aq)      Request the creation of a query on aggregation agent. Parameters:   aq - aggregation query object that fully describes the query. public  ResultSetMonitor createResultSetMonitor()      Create an monitor object that can be used to keep a set of monitored result sets current by using a keep alive session which sends incremental updates from the AggregationPSP. public  ResultSetMonitor createResultSetMonitor(int waitPeriod)      Create an monitor object that can be used to keep a set of monitored result sets current by periodically pulling from a passive session on AggregationPSP. public  Collection getActiveAlerts()      Returns a collection of Alert Descriptors for all alerts on the aggregation agent's log plan. public  Collection getActiveQueries()      Returns a collection of all Query Result Adapters on the aggregation agent's log plan. public  Collection getClusterIds()      Request a list of all clusters in the society excluding the aggregation agent. public  String getSystemProperty(String propertyName)      Get the value of a system property from the aggregation agent's environment. public  AggregationResultSet getUpdatedResultSet(String queryId)      Get an updated result set for an active persistent query from blackboard of aggregation agent. Parameters:   queryId - id of query result adapter for needed result set. public  boolean updateQuery(QueryResultAdapter qra)      Send an update to an active persistent query. Constructor Detail AggregationClient public AggregationClient(String clusterURL, String aggregationName, String keepAliveName)(Code) Create a new client interface to a specific Aggregation Agent. Parameters:   clusterURL - text url of the aggregation agent's cluster Parameters:   aggregationName - name given to aggregation servlet on givenaggregation agent. (typical: "aggregator") Parameters:   keepAliveName - name given to keep alive aggregation servlet on thegiven aggregation agent.(typical: "aggregatorkeepalive") Method Detail cancelAlert public boolean cancelAlert(String queryId, String alertName)(Code) Request cancelation of an active alert. Parameters:   queryId - id of alert's query result adapter Parameters:   alertName - name of alert true if successful; false otherwise cancelQuery public boolean cancelQuery(String queryId)(Code) Request cancelation of an active persistent query. Removes query from aggregation agent's blackboard. Cancels all collection activity related to this query. Also cancels all alerts attached to this query. Parameters:   queryId - id of query result adapter to be cancelled. true if successful; false otherwise createAlert public boolean createAlert(AlertDescriptor ad)(Code) Request the creation of an alert on aggregation agent. Parameters:   ad - alert descriptor that fully describes the alert. This alertdescriptor must include the query id of the query result adapterto which this alert should be added. true if successful; false otherwise createAlertMonitor public AlertMonitor createAlertMonitor()(Code) Create an monitor object that can be used to keep a set of monitored alerts current by using a keep alive session which sends incremental updates from the AggregationPSP. Monitored alerts will be updated on the client as soon as they change on the aggregation agent. an object that can be used to monitor alerts on the aggregationagent's log plan. createAlertMonitor public AlertMonitor createAlertMonitor(int waitPeriod)(Code) Create an monitor object that can be used to keep a set of monitored alerts current by periodically pulling from a passive session on AggregationPSP. By using this type of monitor, instead of a keep alive monitor, the load can be reduced on both the client and the aggregation agent. Increasing the wait peroid will reduce the load even more. Updates to objects on the aggregation agent might be reported as long as the wait period late. Parameters:   waitPeriod - wait period between client pulls (update requests)from aggregation agent in seconds. an object that can be used to monitor alerts on the aggregationagent's log plan. createQuery public Object createQuery(AggregationQuery aq)(Code) Request the creation of a query on aggregation agent. Parameters:   aq - aggregation query object that fully describes the query. Querycan be either transient or persistent. If query is a persistent query, a queryId String will be returned.If query is transient an AggregationResultSet will be returned. createResultSetMonitor public ResultSetMonitor createResultSetMonitor()(Code) Create an monitor object that can be used to keep a set of monitored result sets current by using a keep alive session which sends incremental updates from the AggregationPSP. Monitored result sets will be updated on the client as soon as they change on the aggregation agent. an object that can be used to monitor result sets on theaggregation agent's log plan. createResultSetMonitor public ResultSetMonitor createResultSetMonitor(int waitPeriod)(Code) Create an monitor object that can be used to keep a set of monitored result sets current by periodically pulling from a passive session on AggregationPSP. By using this type of monitor, instead of a keep alive monitor, the load can be reduced on both the client and the aggregation agent. Increasing the wait peroid will reduce the load even more. Updates to objects on the aggregation agent might be reported as long as the wait period late. Parameters:   waitPeriod - wait period between client pulls (update requests)from aggregation agent in seconds. an object that can be used to monitor result sets on theaggregation agent's log plan. getActiveAlerts public Collection getActiveAlerts()(Code) Returns a collection of Alert Descriptors for all alerts on the aggregation agent's log plan. Alert descriptors are client-side descriptions of Alerts. These alert descriptors will be orphans (i.e. getQueryResultAdapter() == null) but they will include a reference to the query id of their query result adaptor on the aggregation agent (accessed via getQueryId()). a collection of Alert Descriptors for all alerts on theaggregation agent's log plan. getActiveQueries public Collection getActiveQueries()(Code) Returns a collection of all Query Result Adapters on the aggregation agent's log plan. Each query result adapter includes a query, a result set, and a set of alerts. This is basically a snapshot of everything on the aggregation agent's blackboard. Only persistent queries will be found. a collection of all query result adapters on the aggregationagent's log plan. getClusterIds public Collection getClusterIds()(Code) Request a list of all clusters in the society excluding the aggregation agent. These can all be used as source clusters in future queries. a collection of clusterId Strings. getSystemProperty public String getSystemProperty(String propertyName)(Code) Get the value of a system property from the aggregation agent's environment. (e.g. "org.cougaar.core.agent.startTime") Parameters:   propertyName - the name of the property. the value of the property. getUpdatedResultSet public AggregationResultSet getUpdatedResultSet(String queryId)(Code) Get an updated result set for an active persistent query from blackboard of aggregation agent. Parameters:   queryId - id of query result adapter for needed result set. an updated result set for an active persistent query fromblackboard of aggregation agent. Returns null of query is notfound. updateQuery public boolean updateQuery(QueryResultAdapter qra)(Code) Send an update to an active persistent query. Updates query on aggregation agent's blackboard. Parameters:   qra - the query result adapter to be updated. true if successful; false otherwise 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)