Java Doc for AgentsServlet.java in  » Science » Cougaar12_4 » org » cougaar » lib » web » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The supported URL-parameter arguments are:

• "?suffix=" -- list the local agent names (default)
• "?suffix=text" -- list the agent names in the global white pages with the matching suffix, where "." is the root. If the suffix doesn't start with ".", the substring starting at the first "." is used, and if there is no "." then the root (".") is used.
• "?format=text" -- specify the output format, where the options are:
  • "html" (default)
  • "text" for plain text, one agent name per line
  • "input" for HTML text form for typing in an agent name, plus a link to the "?format=select" page. See the javascript notes below.
  • "select" for an interactive html form that uses javascript reloading. This can be embedded in an html frame or popup window. The selected name can be accessed by using javascript:

     var name = top.frame.document.agent.name.value;
     

    This only works if both frames were generated by the same host:port, otherwise javascript will throw a "permission denied" error.
• "?depth=int -- if the suffix is specified, this limits the recursion depth, where -1 is no limit (default is specified by the "-Dorg.cougaar.lib.web.list.depth" system property, which defaults to 1)
• "?size=int -- limit the list length, where -1 is no limit (default is specified by the "-Dorg.cougaar.lib.web.list.size" system property, which defaults to -1)
• "?time=long -- if the suffix is specified, this limits any single lookup time in milliseconds, where 0 is no limit and -1 is cache-only (default is specified by the "-Dorg.cougaar.lib.web.list.timeout" system property, which defaults to 0)
• "?sorted=boolean -- sort the names in alphabetical order (default is "true")
• "?split=boolean -- for "?format=html", should links be split along hierarchy levels (default is "true")
• "?scope=all" -- backwards compatibility for listing agents, equivalent to "?suffix=."

For example: "/agents?suffix=.&format=text"

Note this nice feature: With the normal "/$name" redirects and this servlet, the client can request "/$name/agents" to list all co-located agents, regardless of where the named agent happens to be located.