Package com.highdeal.admin.hci

Class FetchClientStatisticsOp

java.lang.Object
com.highdeal.admin.hci.FetchClientStatisticsOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class FetchClientStatisticsOp extends Object implements MessageOperation
This operation allows retrieving statistics about a charging client application connected to the SAP CC Core Server system; You specify the host and the communication port previously identified with the List Clients operation.
The corresponding result is FetchClientStatisticsResult.
See Also:

Operation Result

FetchClientStatisticsResult

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="fetchClientStatistics">
   <xs:complexType>
     <xs:attribute name="host" type="xs:string" use="required"/>
     <xs:attribute name="port" type="xs:integer" use="required"/>
   </xs:complexType>
 </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
chargeNoNoNoNoNoYes

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    OPERATION_NAME
    The XML tag name of this service operation: fetchClientStatistics

  • Constructor Summary

    Constructors
    Constructor
    Description
    FetchClientStatisticsOp()
    Creates a fetch client statistics operation.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCharacterData(String cData)
    Adds character data to the content element.
    void
    addChild(String tagName, XMLMarshallable child)
    Adds a child to the object, the child representing the marshallable object which must be added to the element.
    String
    getHost()
    Gets the host of the charging client for which statistics must be retrieved.
    String
    getName()
    Gets the XML name of the service operation.
    int
    getPort()
    Gets the port of the charging client for which statistics must be retrieved.
    void
    marshal(XMLOutputter output)
    Gives an XML representation of this object, including its children.
    void
    setAttributes(XMLAttributes atts)
    Sets the attributes of the XML representation of the element being processed.
    void
    setHost(String host)
    Sets the host of the charging client for which statistics must be retrieved.
    void
    setPort(int port)
    Sets the port of the charging client for which statistics must be retrieved.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • OPERATION_NAME

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

  • Constructor Details

    • FetchClientStatisticsOp

      public FetchClientStatisticsOp()
      Creates a fetch client statistics operation.

  • Method Details

    • getName

      public String getName()
      Description copied from interface: MessageOperation
      Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

      Example

      • activateAll
      • ping
      Specified by:
      getName in interface MessageOperation
      Returns:
      The technical name of the HCI operation

    • 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

    • getHost

      public String getHost()
      Gets the host of the charging client for which statistics must be retrieved.
      Returns:
      The host of the charging client for which statistics must be retrieved

    • setHost

      public void setHost(String host)
      Sets the host of the charging client for which statistics must be retrieved.
      Parameters:
      host - The host of the charging client for which statistics must be retrieved

    • getPort

      public int getPort()
      Gets the port of the charging client for which statistics must be retrieved.
      Returns:
      The port of the charging client for which statistics must be retrieved

    • setPort

      public void setPort(int port)
      Sets the port of the charging client for which statistics must be retrieved.
      Parameters:
      port - The port of the charging client for which statistics must be retrieved