SAP CC 1.0
API 4.2 (Core)

com.highdeal.cnd.message
Class ChargeableItemCollectorClient

java.lang.Object
  extended by com.highdeal.cnd.message.AbstractStatefulServiceClient
      extended by com.highdeal.cnd.message.StatefulServiceClient
          extended by com.highdeal.cnd.message.ChargeableItemCollectorClient

Deprecated. Please use the StatefulServiceClient.

@Deprecated
public class ChargeableItemCollectorClient
extends StatefulServiceClient

This class allows a user to send some chargeable items SAP Convergent Charging 1.0 Rating Instances by using an efficient message protocol based on TCP/IP.
This API provides the same features as


Nested Class Summary
 
Nested classes/interfaces inherited from class com.highdeal.cnd.message.AbstractStatefulServiceClient
AbstractStatefulServiceClient.UniversalChargeEventListener
 
Field Summary
static java.lang.String CLUSTER_IPADDRESS_KEY
          Deprecated. Key for the system property that contains the IP address for the SAP Convergent Charging 1.0 cluster service.
static java.lang.String ROUND_ROBIN_PATTERN_KEY
          Deprecated. Key for the system property that contains the regex pattern for the service Ids that must be sent to the rating instances using a round-robin algorithm.
 
Fields inherited from class com.highdeal.cnd.message.AbstractStatefulServiceClient
ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING, asyncClient, CANCELLED, CONFIRMED, MASTER_TRANSACTION, NONE_TRANSACTION
 
Constructor Summary
ChargeableItemCollectorClient()
          Deprecated. Please use the constructor StatefulServiceClient.
ChargeableItemCollectorClient(java.lang.String clusterName)
          Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.
ChargeableItemCollectorClient(java.lang.String clusterName, FoundLostRatingListener listener)
          Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.
ChargeableItemCollectorClient(java.lang.String hostName, int port)
          Deprecated. Please use the constructor StatefulServiceClient(String, int).
ChargeableItemCollectorClient(java.lang.String clusterName, java.lang.String ipAddress)
          Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.
ChargeableItemCollectorClient(java.lang.String clusterName, java.lang.String ipAddress, FoundLostRatingListener listener)
          Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.
 
Method Summary
 void connectCluster(java.lang.String cluster)
          Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.
 void connectCluster(java.lang.String cluster, FoundLostRatingListener listener)
          Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.
 void connectCluster(java.lang.String cluster, java.lang.String ipAddress)
          Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.
 void connectCluster(java.lang.String cluster, java.lang.String ipAddress, FoundLostRatingListener listener)
          Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.
 java.lang.String getRoundRobinServiceRegex()
          Deprecated. Has no more effect.
 void setRoundRobinServiceRegex(java.lang.String serviceRegex)
          Deprecated. Has no more effect.
 
Methods inherited from class com.highdeal.cnd.message.StatefulServiceClient
activate, activate, blankCharge, blankCharge, charge, charge, charge, checkLimit, checkLimit, cleanup, cleanup, exportSubscriberSubsData, getEstimatedPrice, getEstimatedPrice, getEstimatedPrice, postRate, postRate, preRate, preRate, startRate, startRate, stopRate, stopRate, translate, translate, updateRate, updateRate
 
Methods inherited from class com.highdeal.cnd.message.AbstractStatefulServiceClient
checkDB, close, connect, connect, connect, connect, connect, connect, currentQueueSize, getBootMode, getFoundLostRatingListener, getTimeout, isConnected, setBootMode, setClusterName, setFoundLostRatingListener, setHAEventListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROUND_ROBIN_PATTERN_KEY

public static final java.lang.String ROUND_ROBIN_PATTERN_KEY
Deprecated. 
Key for the system property that contains the regex pattern for the service Ids that must be sent to the rating instances using a round-robin algorithm.

See Also:
Constant Field Values

CLUSTER_IPADDRESS_KEY

public static final java.lang.String CLUSTER_IPADDRESS_KEY
Deprecated. 
Key for the system property that contains the IP address for the SAP Convergent Charging 1.0 cluster service.

See Also:
Constant Field Values
Constructor Detail

ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient()
Deprecated. Please use the constructor StatefulServiceClient.

Creates a non-initialized message client.

One of the methods connect()or connectCluster() must then be used to connect it to a Chargeable Item Collector server.


ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient(java.lang.String hostName,
                                                int port)
                              throws java.io.IOException
Deprecated. Please use the constructor StatefulServiceClient(String, int).

Creates a message client and connect it with the Stateful Rating Service server.

Parameters:
hostName - the host name of the server.
port - the port on which the server waits for request.
Throws:
java.io.IOException - if the client cannot connect to the server (if server is not running, for instance).

ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient(java.lang.String clusterName)
                              throws CommunicationFailureException
Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.

In multi-server architecture creates a message client and connect it to a cluster of Transactive Rating servers. Each rating server has a Stateful Rating Service server. Note that the port number of the Rating servers is not necessary because it is already known by the low-level communication layer.

Parameters:
clusterName - the name of the cluster this client should connect to.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient(java.lang.String clusterName,
                                                java.lang.String ipAddress)
                              throws CommunicationFailureException
Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.

In multi-server architecture creates a message client and connect it to a cluster of Transactive Rating servers. Each rating server has a Stateful Rating Service server. Note that the port number of the Rating servers is not necessary because it is already known by the low-level communication layer. This constructor allows to specify the IP address used by the SAP Convergent Charging 1.0 cluster service on the host.

Parameters:
clusterName - the name of the cluster this client should connect to.
ipAddress - the IP address for the SAP Convergent Charging 1.0 cluster service.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient(java.lang.String clusterName,
                                                FoundLostRatingListener listener)
                              throws CommunicationFailureException
Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.

In multi-server architecture creates a message client and connect it to a cluster of Transactive Rating servers. Enables to set a listener that will be notified each time a Rating server is discovered or lost by this client. Each rating server has a Stateful Rating Service server. Note that the port number of the Rating servers is not necessary because it is already known by the low-level communication layer.

Parameters:
clusterName - the name of the cluster this client should connect to.
listener - the listener that will be notified each time a Rating server is discovered or lost by this client.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

ChargeableItemCollectorClient

@Deprecated
public ChargeableItemCollectorClient(java.lang.String clusterName,
                                                java.lang.String ipAddress,
                                                FoundLostRatingListener listener)
                              throws CommunicationFailureException
Deprecated. Please use the constructor StatefulServiceClient(String, int) as clusterName is no more used.

In multi-server architecture creates a message client and connect it to a cluster of Transactive Rating servers. Enables to set a listener that will be notified each time a Rating server is discovered or lost by this client. Each rating server has a Stateful Rating Service server. Note that the port number of the Rating servers is not necessary because it is already known by the low-level communication layer. This constructor allows to specify the IP address used by the SAP Convergent Charging 1.0 cluster service on the host.

Parameters:
clusterName - the name of the cluster this client should connect to.
ipAddress - the IP address used by the SAP Convergent Charging 1.0 cluster service.
listener - the listener that will be notified each time a Rating server is discovered or lost by this client.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.
Method Detail

setRoundRobinServiceRegex

@Deprecated
public void setRoundRobinServiceRegex(java.lang.String serviceRegex)
Deprecated. Has no more effect.

Sets the regex for the services that must be dispatched in round-robin.

Parameters:
serviceRegex - The regex for the services that must be dispatched in round-robin, or null if the round-robin must be deactivated.
Throws:
java.lang.IllegalArgumentException - if the serviceRegex is not a regex.

getRoundRobinServiceRegex

@Deprecated
public java.lang.String getRoundRobinServiceRegex()
Deprecated. Has no more effect.

Returns the regex for the services that must be dispatched in round-robin.

Returns:
The regex for the services that must be dispatched in round-robin, or null if round-robin is not activated.

connectCluster

@Deprecated
public void connectCluster(java.lang.String cluster)
                    throws CommunicationFailureException
Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.

Connect this message client to a cluster of Stateful Rating Service servers.

This method is equivalent to connectCluster(cluster, null, null)

Parameters:
cluster - the name of the cluster this client should connect to.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.
See Also:
connectCluster(String, String, FoundLostRatingListener)

connectCluster

@Deprecated
public void connectCluster(java.lang.String cluster,
                                      FoundLostRatingListener listener)
                    throws CommunicationFailureException
Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.

Connect this message client to a cluster of Stateful Rating Service servers.

This client broadcasts a request to discover nodes in the cluster. The method returns after having discovered at least one node in the cluster. If no nodes are found after a 60 second timeout, then a communication failure exception (timeout) is thrown.

The given listener will be notified each time a Rating server is discovered or lost by this client.

Parameters:
cluster - the name of the cluster this client should connect to.
listener - the listener that will be notified each time a Rating server is discovered or lost by this client.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

connectCluster

@Deprecated
public void connectCluster(java.lang.String cluster,
                                      java.lang.String ipAddress)
                    throws CommunicationFailureException
Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.

Connect this message client to a cluster of Stateful Rating Service servers.

This method allows to specifiy an IP address for the SAP Convergent Charging 1.0 cluster service.

Parameters:
cluster - the name of the cluster this client should connect to.
ipAddress - the IP address for the SAP Convergent Charging 1.0 cluster service.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

connectCluster

@Deprecated
public void connectCluster(java.lang.String cluster,
                                      java.lang.String ipAddress,
                                      FoundLostRatingListener listener)
                    throws CommunicationFailureException
Deprecated. Please use the method AbstractStatefulServiceClient.connect(String, int) as clusterName is no more used.

Connect this message client to a cluster of Stateful Rating Service servers.

This client broadcasts a request to discover nodes in the cluster. The method returns after having discovered at least one node in the cluster. If no nodes are found after a 60 second timeout, then a communication failure exception (timeout) is thrown.

The given listener will be notified each time a Rating server is discovered or lost by this client.

This method allows to specifiy an IP address for the SAP Convergent Charging 1.0 cluster service.

Parameters:
cluster - the name of the cluster this client should connect to.
listener - the listener that will be notified each time a Rating server is discovered or lost by this client.
ipAddress - the IP address for the SAP Convergent Charging 1.0 cluster service.
Throws:
CommunicationFailureException - if the client cannot connect to the cluster or if no cluster nodes are found after a 60 second timeout.

SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.