Package com.highdeal.admin.hci

Class PingOp

java.lang.Object
com.highdeal.admin.hci.PingOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class PingOp extends Object implements MessageOperation
This operation allows you to check if the Administration Service of an instance in the SAP CC Core Server system is alive.

This means, if SAP Convergent Charging is ready to accept usage events and engage the rating process.

Note

This operation does not check if the HCI listener in an instance of the SAP CC system is alive.
If the HTTP (for HCI) listener is not running, this operation will fail.

Operation Result

PingResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="ping">
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeYesYesYesYesYesYes

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag name of this service operation: "ping"
      See Also:

  • Constructor Details

    • PingOp

      public PingOp()

  • Method Details

    • getName

      public String getName()
      Returns the name of the operation, that is "ping".
      Specified by:
      getName in interface MessageOperation
      Returns:
      "ping"

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the operation attributes from the XMLAttributes.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XMLAttributes containing the data

    • addCharacterData

      public void addCharacterData(String cData)
      Adds string data to this operation.

      This data is ignored for this operation.

      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to add to the operation

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child tag to this operation.

      This tag is ignored for this operation.

      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of the tag
      child - The XMLMarshallable child to add

    • marshal

      public void marshal(XMLOutputter output)
      Writes the operation XML data to the given output.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XMLOutputter to write into