Package com.highdeal.admin.hci

Class ClientInfo

java.lang.Object
com.highdeal.admin.hci.ClientInfo
All Implemented Interfaces:
XMLMarshallable, Comparable<ClientInfo>
public class ClientInfo extends Object implements XMLMarshallable, Comparable<ClientInfo>
This Java class represents information about a charging client application or system that is connected to the SAP CC Core Server system; Implement the List Clients operation to handle this information in your client application.

This information includes:

  • The ID of the charging client in the dispatcher instance
  • The name of the host the charging client is connecting from
  • The port number the charging client is connecting from
  • The name of the charging client
  • The process identifier of the charging client
  • The date when the charging client started
  • The date when the charging client connected to the SAP CC system
  • Whether statistics are enabled for the charging client

More Information

Consult the list_clients command in the SAP CC Admin+ user interface for more information.

See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="clientInfo">
   <xs:complexType>
     <xs:attribute name="dispatcherClientId" type="xs:integer" use="required"/>
     <xs:attribute name="hostname" type="xs:string" use="required"/>
     <xs:attribute name="port" type="xs:integer" use="required"/>
     <xs:attribute name="name" type="xs:string" use="required"/>
     <xs:attribute name="startDate" type="xs:dateTime" use="required"/>
     <xs:attribute name="pid" type="xs:string"/>
     <xs:attribute name="statisticsEnabled" type="xs:boolean" use="required"/>
     <xs:attribute name="connectionDate" type="xs:dateTime" use="required"/>
     <xs:attribute name="login" type="xs:string"/>
   </xs:complexType>
 </xs:element>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TAG_NAME
    The XLM element name of this data model: clientInfo

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClientInfo()
    Creates a client information object.

  • 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.
    int
    compareTo(ClientInfo o)
     
    Date
    getConnectionDate()
    Gets the date when the charging client connected to the SAP CC system.
    int
    getDispatcherClientId()
    Gets the identifier of the charging client in the dispatcher instance of the SAP CC system.
    String
    getHostname()
    Gets the name of the host the charging client is connecting from.
    String
    getLogin()
    Gets the login used to authenticate the client.
    String
    getName()
    Gets the name of the charging client.
    String
    getPid()
    Gets the process identifier of the charging client.
    int
    getPort()
    Gets the port number the charging client is connecting from.
    Date
    getStartDate()
    Gets the date when the charging client started.
    boolean
    isStatisticsEnabled()
    Gets whether statistics are enabled for the charging client.
    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
    setConnectionDate(Date connectionDate)
    Sets the date when the charging client connected to the SAP CC system.
    void
    setDispatcherClientId(int dispatcherClientId)
    Sets the identifier of the charging client in the dispatcher instance.
    void
    setHostname(String hostname)
    Sets the name of the host the charging client is connecting from.
    void
    setLogin(String login)
    Sets the login used to authenticate the client.
    void
    setName(String name)
    Sets the name of the charging client.
    void
    setPid(String pid)
    Sets the process identifier of the charging client.
    void
    setPort(int port)
    Sets the port number the charging client is connecting from.
    void
    setStartDate(Date startDate)
    Sets the date when the charging client started.
    void
    setStatisticsEnabled(boolean statisticsEnabled)
    Sets whether statistics are enabled for the charging client.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ClientInfo

      public ClientInfo()
      Creates a client information object.

  • Method Details

    • 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

    • 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

    • 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

    • 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

    • getDispatcherClientId

      public int getDispatcherClientId()
      Gets the identifier of the charging client in the dispatcher instance of the SAP CC system.
      Returns:
      The identifier of the charging client in the dispatcher instance

    • setDispatcherClientId

      public void setDispatcherClientId(int dispatcherClientId)
      Sets the identifier of the charging client in the dispatcher instance.
      Parameters:
      dispatcherClientId - The identifier of the charging client in the dispatcher instance

    • getHostname

      public String getHostname()
      Gets the name of the host the charging client is connecting from.
      Returns:
      The name of the host machine of the charging client

    • setHostname

      public void setHostname(String hostname)
      Sets the name of the host the charging client is connecting from.
      Parameters:
      hostname - The name of the host the charging client is connecting from

    • getPort

      public int getPort()
      Gets the port number the charging client is connecting from.
      Returns:
      The port number the charging client is connecting from

    • setPort

      public void setPort(int port)
      Sets the port number the charging client is connecting from.
      Parameters:
      port - The port number the charging client is connecting from

    • getName

      public String getName()
      Gets the name of the charging client.
      Returns:
      The name of the charging client

    • setName

      public void setName(String name)
      Sets the name of the charging client.
      Parameters:
      name - The name of the charging client

    • getPid

      public String getPid()
      Gets the process identifier of the charging client.
      Returns:
      The process identifier of the charging client

    • setPid

      public void setPid(String pid)
      Sets the process identifier of the charging client.
      Parameters:
      pid - The process identifier of the charging client

    • getStartDate

      public Date getStartDate()
      Gets the date when the charging client started.
      Returns:
      The date when the charging client started

    • setStartDate

      public void setStartDate(Date startDate)
      Sets the date when the charging client started.
      Parameters:
      startDate - The date when the charging client started

    • getConnectionDate

      public Date getConnectionDate()
      Gets the date when the charging client connected to the SAP CC system.
      Returns:
      The date when the charging client connected to the SAP CC system

    • setConnectionDate

      public void setConnectionDate(Date connectionDate)
      Sets the date when the charging client connected to the SAP CC system.
      Parameters:
      connectionDate - The date when the charging client connected to the SAP CC system

    • isStatisticsEnabled

      public boolean isStatisticsEnabled()
      Gets whether statistics are enabled for the charging client.
      Returns:
      true if statistics are enabled for the charging client, false otherwise

    • setStatisticsEnabled

      public void setStatisticsEnabled(boolean statisticsEnabled)
      Sets whether statistics are enabled for the charging client.
      Parameters:
      statisticsEnabled - true if statistics are enabled for the charging client, false otherwise

    • getLogin

      public String getLogin()
      Gets the login used to authenticate the client.
      Returns:
      the login used to authenticate the client

    • setLogin

      public void setLogin(String login)
      Sets the login used to authenticate the client.
      Parameters:
      login - the login used to authenticate the client

    • compareTo

      public int compareTo(ClientInfo o)
      Specified by:
      compareTo in interface Comparable<ClientInfo>