com.highdeal.admin.hci
Class ClientInfo

java.lang.Object
  com.highdeal.admin.hci.ClientInfo

All Implemented Interfaces:

XMLMarshallable, java.lang.Comparable<ClientInfo>

public class ClientInfo
extends java.lang.Object
implements XMLMarshallable, java.lang.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:

ListClientsOp

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:complexType>
 </xs:element>

Field Summary

static java.lang.String

TAG_NAME The XLM element name of this data model: clientInfo

Constructor Summary

ClientInfo()
Creates a client information object.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.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)
java.util.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.
java.lang.String	getHostname() Gets the name of the host the charging client is connecting from.
java.lang.String	getName() Gets the name of the charging client.
java.lang.String	getPid() Gets the process identifier of the charging client.
int	getPort() Gets the port number the charging client is connecting from.
java.util.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(java.util.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(java.lang.String hostname) Sets the name of the host the charging client is connecting from.
void	setName(java.lang.String name) Sets the name of the charging client.
void	setPid(java.lang.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(java.util.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

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

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The XLM element name of this data model: clientInfo

See Also:

Constant Field Values

Constructor Detail

ClientInfo

public ClientInfo()

Creates a client information object.

Method Detail

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(java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getName()

Gets the name of the charging client.

Returns:

The name of the charging client

setName

public void setName(java.lang.String name)

Sets the name of the charging client.

Parameters:

name - The name of the charging client

getPid

public java.lang.String getPid()

Gets the process identifier of the charging client.

Returns:

The process identifier of the charging client

setPid

public void setPid(java.lang.String pid)

Sets the process identifier of the charging client.

Parameters:

pid - The process identifier of the charging client

getStartDate

public java.util.Date getStartDate()

Gets the date when the charging client started.

Returns:

The date when the charging client started

setStartDate

public void setStartDate(java.util.Date startDate)

Sets the date when the charging client started.

Parameters:

startDate - The date when the charging client started

getConnectionDate

public java.util.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(java.util.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

compareTo

public int compareTo(ClientInfo o)

Specified by:

compareTo in interface java.lang.Comparable<ClientInfo>