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, java.io.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:

Serialized Form

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 Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_HOSTNAME 0: Constant when the hostname specified in the FetchClientStatisticsOp operation is invalid.
static int	INVALID_PORT The port specified in the FetchClientStatisticsOp operation is invalid.
static java.lang.String	TAG_NAME The name of the exception: "fetchClientStatisticsException".
static int	UNKNOWN The reason of the exception is unknown.
static int	UNKNOWN_CLIENT The hostname and port specified in the FetchClientStatisticsOp operation do not correspond to a connected client.

Constructor Summary

Constructors

Constructor and Description
FetchClientStatisticsException() Creates a fetch client statistics exception.
FetchClientStatisticsException(int reason, java.lang.String message, java.lang.String host, int port) Creates a fetch client statistics exception with a reason and a message.

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getHost() Gets the host of the client as specified in the related FetchClientStatisticsOp operation.
java.lang.String	getMessage() Gets the message of the exception.
java.lang.String	getOperandReference() 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.
int	getPort() Gets the port of the client as specified in the related FetchClientStatisticsOp operation.
int	getReason() Gets the reason of the exception.
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(java.lang.String host) Sets the host of the client as specified in the related FetchClientStatisticsOp operation.
void	setMessage(java.lang.String message) Sets the message of the exception.
void	setPort(int port) Sets the port of the client as specified in the related FetchClientStatisticsOp operation.
void	setReason(int reason) Sets the reason of the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_HOSTNAME

public static final int INVALID_HOSTNAME

0: Constant when the hostname specified in the FetchClientStatisticsOp operation is invalid.

See Also:

Constant Field Values

INVALID_PORT

public static final int INVALID_PORT

The port specified in the FetchClientStatisticsOp operation is invalid.

See Also:

Constant Field Values

UNKNOWN_CLIENT

public static final int UNKNOWN_CLIENT

The hostname and port specified in the FetchClientStatisticsOp operation do not correspond to a connected client.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

The reason of the exception is unknown.

See Also:

Constant Field Values

TAG_NAME

public static final java.lang.String TAG_NAME

The name of the exception: "fetchClientStatisticsException".

See Also:

Constant Field Values

Constructor Detail

FetchClientStatisticsException

public FetchClientStatisticsException()

Creates a fetch client statistics exception.

FetchClientStatisticsException

public FetchClientStatisticsException(int reason,
                                      java.lang.String message,
                                      java.lang.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 Detail

getOperandReference

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

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 java.lang.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(java.lang.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:

INVALID_HOSTNAME, INVALID_PORT, UNKNOWN_CLIENT, UNKNOWN

setReason

public void setReason(int reason)

Sets the reason of the exception.

Parameters:

reason - The reason of the exception

See Also:

INVALID_HOSTNAME, INVALID_PORT, UNKNOWN_CLIENT, UNKNOWN

getMessage

public java.lang.String getMessage()

Gets the message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The text message of the exception

setMessage

public void setMessage(java.lang.String message)

Sets the message of the exception.

Parameters:

message - The text message of the exception