Package com.highdeal.bart.hci

Class RegisterMonitoringClientOp

java.lang.Object
com.highdeal.bart.hci.RegisterMonitoringClientOp
All Implemented Interfaces:
com.highdeal.hci.MessageOperation, XMLMarshallable
public class RegisterMonitoringClientOp extends Object implements com.highdeal.hci.MessageOperation
This operation allows to register a monitoring client.

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="registerMonitoringClient">
   <xs:complexType>
     <xs:attribute name="address" type="xs:string"/>
     <xs:attribute name="port" type="xs:integer"/>
   </xs:complexType>
 </xs:element>

  • Constructor Details

    • RegisterMonitoringClientOp

      public RegisterMonitoringClientOp()
      Builds an empty operation.

  • Method Details

    • getName

      public String getName()
      Gets the XML attribute name.
      Specified by:
      getName in interface com.highdeal.hci.MessageOperation
      Returns:
      the XML attribute name.

    • getAddress

      public String getAddress()
      Gets the listening client address
      Returns:
      the listening client address

    • setAddress

      public void setAddress(String address)
      Sets the listening client address.
      Parameters:
      address - the listening client address

    • getPort

      public int getPort()
      Gets the client listening port
      Returns:
      the client listening port

    • setPort

      public void setPort(int port)
      Sets the client listening port.
      Parameters:
      port - the client listening port

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XML attributes of the current element

    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to be added

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Description copied from interface: XMLMarshallable
      Adds a child to the object, the child representing the marshallable object which must be added to the element.
      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of tag for the child
      child - The child to be added

    • marshal

      public void marshal(XMLOutputter output)
      Description copied from interface: XMLMarshallable
      Gives an XML representation of this object, including its children.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into