public class CommunicationFailureException extends Exception
customized charging client.
(in opposite
to the ServerFailureException that denotes a failure which occurred on server side in the connected SAP CC system).
Note
This exception incorporates all nonbusiness exceptions that can occur on
client side when your charging client
requests some service operations from the SAP CC system
via the Message TCP high-speed technical interface.
Refer also to the business exceptions specified by this Java API Reference documentation.
The available reasons that are carried by this exception are:
| Failure | Reason Code | Customizing and Integration | Troubleshooting (Next Steps) |
|---|---|---|---|
Unsupported failure |
0 |
Note To design the exception and error handling functions (automated treatments, logging and manual treatments), see the Field Detail section in this topic. Refer to the information available in the Customizing subsection of each failure to develop your integration code. |
Note For troubleshooting investigations, see the Field Detail section in this topic. Refer to the information available in the Next Steps subsection of each failure. |
Connection closed |
1 | ||
Too long message |
2 | ||
Interrupted timeout communication |
3 | ||
Server system unreachable |
4 | ||
Connection queue full (deprecated and now revoked) |
5 |
Consider the detailed information in the Field Detail section.
Note
See the Field Detail section for more information about troubleshooting:
Depending on your business requirements design and develop the handling functions in your client application.
For each exception reason, you determine the expected treatments in your
charging client.
| Modifier and Type | Field and Description |
|---|---|
static int |
CONNECTION_CLOSED
1: Failure when the communication between your client application and the SAP CC Core Server system is closed or is
closing.
|
static int |
CONNECTION_QUEUE_FULL
Deprecated.
This reason code is deprecated and can no longer be create in your
charging client.
5: Failure when the connection queue is full in your client application (mediation system).
|
static int |
INTERRUPTED_TIMEOUT_COMMUNICATION
3: Failure when the comunication has been interrupted due
to timeout specified by
the
charging client in your client application. |
static int |
SERVER_UNREACHABLE
4: Your
charging client has lost all connections to
the dispatcher instances of the SAP CC Core Server system. |
static int |
TOO_LONG_MESSAGE
2: Failure whn the sent or received message cannot be managed by the communication
protocol because it is too long.
|
static int |
UNSUPPORTED_FAILURE
0: The reason is unknown or unsupported; If this reason is signaled,
it could denote a bug in the SAP CC software.
|
| Constructor and Description |
|---|
CommunicationFailureException(int reason,
String msg)
The reason/message exception builder.
|
CommunicationFailureException(int reason,
String msg,
Throwable t)
Full
Exception builder. |
CommunicationFailureException(int reason,
Throwable t)
The reason/throwable exception builder.
|
| Modifier and Type | Method and Description |
|---|---|
void |
attach(Object attachment) |
Object |
attachment() |
String |
getMessage()
Returns a comprehensive description of the exception.
|
int |
getReason()
Returns the numerical reason code of the exception.
|
String |
reasonToString()
Returns the reason code as a string; Prefer the numerical codes and available
Java constants. |
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic static final int UNSUPPORTED_FAILURE
Recommendation
In a production system landscape, please contact a support specialist from your SAP Support Team and report an incident.
public static final int CONNECTION_CLOSED
Perform the following investigations to troubleshoot your problem:
public static final int TOO_LONG_MESSAGE
Perform the following investigations to troubleshoot your problem:
public static final int INTERRUPTED_TIMEOUT_COMMUNICATION
charging client in your client application.public static final int SERVER_UNREACHABLE
charging client has lost all connections to
the dispatcher instances of the SAP CC Core Server system.
Monitor the connections between your client application (mediation system) and the SAP CC system:
list_clients command.
Refer to the SAP CC Operations Guide for more information about monitoring the SAP CC system landscape.
@Deprecated public static final int CONNECTION_QUEUE_FULL
charging client.
public CommunicationFailureException(int reason,
String msg,
Throwable t)
Exception builder.reason - The exception reasonmsg - The exception messaget - The nested (Throwable) exceptionpublic CommunicationFailureException(int reason,
String msg)
reason - The exception reasonmsg - The exception messagepublic CommunicationFailureException(int reason,
Throwable t)
reason - The exception reasont - The nested (Throwable) exceptionpublic int getReason()
public String getMessage()
getMessage in class Throwablepublic void attach(Object attachment)
public Object attachment()
public String reasonToString()
Java constants.
The available codes are:
unsupportedFailureconnectionClosedtooLongMessageinterruptedTimeoutCommunicationserverUnreachableconnectionQueueFull (deprecated and revoked)