Design: Control BES Debugging: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
Line 7: Line 7:
=== Getting the list of contexts ===
=== Getting the list of contexts ===


  <hai:GetBESContexts/>
  <hai:GetBESLogContexts/>


==== Responses ====
==== Responses ====
Line 13: Line 13:
If the BES daemon is successful, it will return a response that lists each debug context and its current state:
If the BES daemon is successful, it will return a response that lists each debug context and its current state:


  <hai:Context name="''name''" state="''on|off''"/>
  <hai:LogContext name="''name''" state="''on|off''"/>
  ...
  ...


Other possible responses are:
Other possible responses (errors) are:
 
<?xml version="1.0" encoding="UTF-8"?>
  <hai:ParseError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
      ''message text''
  </hai:ParseError>
 
<?xml version="1.0" encoding="UTF-8"?>
  <hai:BESError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
      ''message text''
  </hai:BESError>
 
=== Setting the state of a context ===
 
<hai:SetLogContext name="''name''" state="''on|off''"/>
 
==== Responses ====
 
Success:
 
<?xml version="1.0" encoding="UTF-8"?>
  <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
      <hai:OK/>
  </hai:BesAdminCmd>
 
Errors:


  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>

Revision as of 22:49, 14 June 2011

Control BES Debugging

The HAI will be able to send a command to the BES daemon that enables it to see a list of available debug contexts as well as their status (on or off).

The HAI will be able to send a message to the BES daemon that sets/clears the state of any given context.

Getting the list of contexts

<hai:GetBESLogContexts/>

Responses

If the BES daemon is successful, it will return a response that lists each debug context and its current state:

<hai:LogContext name="name" state="on|off"/>
...

Other possible responses (errors) are:

<?xml version="1.0" encoding="UTF-8"?>
 <hai:ParseError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
     message text
 </hai:ParseError>
<?xml version="1.0" encoding="UTF-8"?>
 <hai:BESError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
     message text
 </hai:BESError>

Setting the state of a context

<hai:SetLogContext name="name" state="on|off"/>

Responses

Success:

<?xml version="1.0" encoding="UTF-8"?>
 <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
     <hai:OK/>
 </hai:BesAdminCmd>

Errors:

<?xml version="1.0" encoding="UTF-8"?>
 <hai:ParseError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
     message text
 </hai:ParseError>
<?xml version="1.0" encoding="UTF-8"?>
 <hai:BESError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#">
     message text
 </hai:BESError>