Package com.highdeal.admin.hci

Class FetchClientStatisticsException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.highdeal.hci.OperationFailureException
com.highdeal.admin.hci.FetchClientStatisticsException
All Implemented Interfaces:
OperationResult, XMLMarshallable, Serializable
public class FetchClientStatisticsException extends OperationFailureException
Exception thrown when an error occurs while retrieving the statistics of a client connected to the SAP CC Core Server system (see the Fetch Client Statistics operation).
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="fetchClientStatisticsException">
  <xs:complexType>
     <xs:attribute name="message" type="xs:string" />
     <xs:attribute name="reason" type="FetchClientStatisticsExceptionReasonType" use="required"/>
     <xs:attribute name="host" type="xs:string" />
     <xs:attribute name="port" type="xs:integer" />
  </xs:complexType>
 </xs:element>

 <xs:simpleType name="FetchClientStatisticsExceptionReasonType">
  <xs:restriction base="xs:string">
    <xs:enumeration value="invalidHostname"/>
    <xs:enumeration value="invalidPort"/>
    <xs:enumeration value="unknownClient"/>
    <xs:enumeration value="unknown"/>
  </xs:restriction>
 </xs:simpleType>

  • Field Details

  • Constructor Details

    • FetchClientStatisticsException

      public FetchClientStatisticsException()
      Creates a fetch client statistics exception.

    • FetchClientStatisticsException

      public FetchClientStatisticsException(int reason, String message, String host, int port)
      Creates a fetch client statistics exception with a reason and a message.
      Parameters:
      reason - The reason of the exception
      message - The message of the exception
      host - The host machine of the client as specified in the FetchClientStatisticsOp operation
      port - The communication port reserved for the client as specified in the FetchClientStatisticsOp operation

  • Method Details

    • getOperandReference

      public String getOperandReference()
      Description copied from interface: OperationResult
      Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
      Specified by:
      getOperandReference in interface OperationResult
      Overrides:
      getOperandReference in class OperationFailureException
      Returns:
      The operand reference of the operation result

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      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.
      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.
      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.
      Parameters:
      output - The XML output to marshal the object into

    • getHost

      public String getHost()
      Gets the host of the client as specified in the related FetchClientStatisticsOp operation.
      Returns:
      The host machine of the client as specified in the related FetchClientStatisticsOp operation

    • setHost

      public void setHost(String host)
      Sets the host of the client as specified in the related FetchClientStatisticsOp operation.
      Parameters:
      host - The host machine of the client as specified in the related FetchClientStatisticsOp operation

    • getPort

      public int getPort()
      Gets the port of the client as specified in the related FetchClientStatisticsOp operation.
      Returns:
      the port of the client as specified in the related FetchClientStatisticsOp operation

    • setPort

      public void setPort(int port)
      Sets the port of the client as specified in the related FetchClientStatisticsOp operation.
      Parameters:
      port - The communication port reserved for the client as specified in the related FetchClientStatisticsOp operation

    • getReason

      public int getReason()
      Gets the reason of the exception.
      Returns:
      The reason of the exception
      See Also:

    • setReason

      public void setReason(int reason)
      Sets the reason of the exception.
      Parameters:
      reason - The reason of the exception
      See Also:

    • getMessage

      public String getMessage()
      Gets the message of the exception.
      Overrides:
      getMessage in class Throwable
      Returns:
      The text message of the exception

    • setMessage

      public void setMessage(String message)
      Sets the message of the exception.
      Parameters:
      message - The text message of the exception