com.highdeal.cnd.message
Class BatchServiceClient

java.lang.Object
  com.highdeal.cnd.message.AsyncBatchServiceClient
      com.highdeal.cnd.message.BatchServiceClient

All Implemented Interfaces:

com.highdeal.barbus.ISSLContextProvider

public class BatchServiceClient
extends AsyncBatchServiceClient

This main Java class provides the necessary operations to implement Offline Charging Services (OFCS) in your SAP system landscape to send chargeable items to the connected SAP CC Core Server system to charge the past usage (consumption) of a marketable service by end customers; This class enables synchronous communications via the Message TCP high-speed technical interface.

Recommendation

You can implement the AsyncBatchServiceClient class to speed up the processing.

Consider the following information in this topic:

• Synchronous Services and Operations
• Features
• Implementation in Your Client Application
• Notes on SAP CC Implementation

Example

For test, demo, or training purposes, a program (SAP CC Message Client) is provided with the SAP CC Core Tool software unit: It allows you to send some charging operation requests to the SAP CC system. The SAP CC Message Client user interface implements some methods of this Java class.

Synchronous Services and Operations

• Offline acquisition step of the Deferred charging service - see acquire(java.util.List)
• Offline charging service (batch mode or single chargeable item)
• Quote service (blank charging)
• Recharging step for the Rerating end-to-end service (based on subscriptions or on provider contracts)

With this Java class, you can implement offline charging services via the Message TCP high-speed technical interface. Charging is based on acquired events.

Business Services: Offline Charging Services	Operations	Technical Names (Consider the methods in this Java class)
Chargeable item acquisition (for deferred charging managed in SAP CI)	Batch acquisition operation	acquire(..)
Batch charging	Batch charging operation (*)	batchCharge(..) to a contract or subscription already identified
Event-based charging without credit control	Single charging operation	charge(..)
Event-based advice of charge	Blank charging operation	blankCharge(..)
Offline recharging	Peration	For each subscription or provider contract to re-charge: Lock and restore the customer master data with startSubscriptionRerating(..) Send the corrected chargeable items to recharge with charge(..) Unlock the customer master data with stopSubscriptionRerating(..)

Recommendation

You can implement the rerating end-to-end service (based on provider contracts) by using another technical interface based on SOAP APIs: SAP CC provides Web Services that your client application can consume.

Note

Consult all the offline charging services that you can implement in your Java-based client application used as a mediation system. Refer to the AsyncBatchServiceClient class for asynchronous communications and very high throughput performances.

Features

This charging client benefits from the functions provided by the Message TCP technical interface. Refer to its features about:

• High Availability Management
• High Volume Management
• High Performance Management

Operation Results

The connected SAP CC system replies to operation requests with the following data:

• AcquisitionResult
• BatchChargeResult
• PurchaseOrder

Charging Contract Operational Status

All services and operations take into account the operational status of a charging contract. This means that an operation exception can be thrown if the operational status of a charging contract is locked or closed.

Communication Timeout

You can define a client-side timeout associated to a charging client based on this BatchServiceClient class: The connected SAP CC system must process your operation request during this limited time.

If the limited time is exceeded, the operation is automatically rolled back:

• An operation is sent to the SAP CC system in background to cancel the initial operation request.
• An exception is thrown in the charging client of your client application.

This client-side timeout does not guarantee that related operations successfully ended (see SAP CC Library (Application Help)).

Security

Use the SSL context.

Implementation in Your Client Application

Implementing Batch Acquisition Services

You can implement this business operation if both SAP Convergent Charging and SAP Convergent Invoicing (SAP CI) are available in your system landscape. The consumption item management function must be enable in SAP CI (in the SAP ERP/FI-CA system).

Use the method acquire(..) .

Implementing Batch Charging Services

Customizing Sequence

• guiderLookup(..)
• batchCharge(..)

Advanced Implementation

The following advanced implementation activities are possible. Refer to the implementation note section for more information.

• Spending status monitoring function

Notes on SAP CC Implementation

Implementing Recharging for Rerating Services

To provide your system landscape with rerating services, you must implement the Recharging step of this process. This step follows the correction of the source(s) of the mistakes.

Recommendation

Before implementing these operations, refer to the SAP CC Library (Application Help) for more information about these processes.

Customizing Sequence

Develop the following sequence of operations to recharge the usage and to correct the related subsriptions or charging contracts:

• Identify the subscriptions or the charging contracts to re-charge
• Generate a reratingLockCode
• Call the startSubscriptionRerating operation for each subscription or charging contract to lock it and restore the values of its counters
• Send the corrected chargeable items to recharge for all subscriptions or charging contracts in chronological order (by calling the charge operation )
• Call the stopSubscriptionRerating operation for each subscription or charging contract to unlock it

Additional Information

Consult all the online and offline charging services that you can implement in your Java-based client application.

Consult the SAP CC Library (Application Help) for more information about the Offline Charging Services and the charging process in batch mode.

Related Information

See Also:

ChargeableItem, AcquisitionResult, PurchaseOrder, BatchChargeResult, AsyncBatchServiceClient

Nested Class Summary

protected static interface	AsyncRatingServiceClient.RegisterListener
static class	BatchServiceClient.ReratingClientRequestHandler Rerating service client request handler: always refuse rerating information, except if a rerating information handler has been set.

Field Summary

static int	ALL_TRANSACTION Constant to return all the usage transactions
static int	ALL_TRANSACTION_AND_RECURRING Constant to return all the usage transactions and all the recurring/one-shot transactions
static int	CANCELLED Constant to set up the resolution used when the time to live (TTL) is expired as canceled
static int	CONFIRMED Constant to set up the resolution used when the time to live (TTL) is expired as confirmed
protected java.util.List<AsyncRatingServiceClient.RegisterListener>	listeners
static int	MASTER_TRANSACTION Constant to return the master usage transaction
static int	NONE_TRANSACTION Constant to return no usage transaction
protected com.highdeal.cnd.message.AsyncRatingServiceClient.RLListener	ratingListListener
static int	RERATING_STATUS_PING
static int	RERATING_STATUS_START
static int	RERATING_STATUS_STOP
static int	RERATING_STATUS_UPDATE

Constructor Summary

BatchServiceClient()
Creates a non-initialized charging client for implementing the offline charging services in your Java-based client application; One of the {TEST #connect(java.lang.String, int) connect(..)} methods must then be used to connect this MessageClient to the distant SAP CC system.

Method Summary

java.util.List<AcquisitionResult>	acquire(java.util.List<AcquisitionParameters> parameters) Requests the connected SAP CC Core Server system to collect a list of chargeable items included in an acquisition parameter.
protected void	addListener(AsyncRatingServiceClient.RegisterListener listener)
protected void	asyncSend(com.highdeal.cnd.message.common.CollectorMessage m, int maxTimeout, ResponseHandlerWrapper handler, com.highdeal.util.IEventListener eventListener) FOR INTERNAL USE ONLY - Sends asynchronously the message m; When a response or an exception is received by the client application, it must back the response handler.
BatchChargeResult	batchCharge(java.util.Vector<ChargeParameters> parameters, java.lang.Long subscriptionOrContractID, short partitionID, AccessibleChargeType chargeType, int ts, boolean ft, MessageHeader.TransactionMode tm, java.lang.String reratingLockCode) This operation allows you to request the connected SAP CC Core Server system to charge in batch mode a sorted set of chargeable items for the specified user service ID (USID) and service ID (SID) and relating to an already identified subscription or charging contract.
BatchChargeResult	batchCharge(java.util.Vector<ChargeParameters> parameters, java.lang.Long subscriptionID, short partitionID, int ts) This main operation allows you to request the connected SAP CC Core Server system to charge in batch mode a chronologically sorted set of chargeable items for a particular past service consumption by a individual end customer; or the specified user service ID (USID) and service ID (SID) and relating to an already identified subscription (and database partition).
BatchChargeResult	batchCharge(java.util.Vector<ChargeParameters> parameters, java.lang.Long subscriptionID, short partitionID, int ts, boolean ft, MessageHeader.TransactionMode tm, java.lang.String reratingLockCode) Consult the main batch charging operation and consider the supplementary options: ft, tm, and reratingLockCode.
protected void	beginSession() FOR INTERNAL USE ONLY - Begins a client session for this thread; All the messages are stored in memory and are not sent until the method sendSession() is called.
PurchaseOrder	blankCharge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, int ts) Main blank charge opertation; Requests the connected SAP CC Core Server system to charge in blank mode the specified chargeable item for the specified user service ID and service ID at the specified date.
PurchaseOrder	blankCharge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, int ts, boolean ft) Refer to the main operation request; Requests the connected SAP CC Core Server system to charge in blank mode the specified chargeable item for the specified user service ID and service ID at the specified date.
PurchaseOrder	charge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, int ts) Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and the specified service ID at the specified date with transaction filtered selection.
PurchaseOrder	charge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, java.lang.String reratingLockCode) Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and the specified service ID at the specified date without transaction selection.
PurchaseOrder	charge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, java.lang.String reratingLockCode, ChargeExecutionContext context) Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and service ID at the specified date.
PurchaseOrder	charge(ChargeableItem ci, java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate, java.lang.String reratingLockCode, int ts, boolean ft) Requests the connected SAP CC Core Server system to charge in offline environment a unit chargeable item (service consumption information data) for the specified user service ID and the specified service ID at the specified date; Operation request is sent in synchronous mode.
void	close() Closes the connection with the connected SAP CC system; This method allows to release all the resources attached (sockets and buffers) in the charging client.
void	connect(InstanceMap imap, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener, ServiceClientTuning config) Connects this charging client with the SAP CC system by using an instance map; A timeout must be specified.
void	connect(java.lang.String systemName, java.net.InetSocketAddress... bootDispatcherAddresses) Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape.
void	connect(java.lang.String systemName, com.highdeal.barbus.InstanceAddress... bootDispatcherAddresses) Connects this charging client with the Rating Instances.
void	connect(java.lang.String hostname, int hostport) Connects this charging client to the distant SAP CC Core Server system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; No client timeout is specified.
void	connect(java.lang.String hostname, int port, boolean secure, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener, ServiceClientTuning config) Connects this message client with the Rating Instances.
void	connect(java.lang.String hostname, int hostport, FoundLostRatingListener ratingListener) Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; No client timeout is specified.
void	connect(java.lang.String systemName, int lookupDuration, java.net.InetSocketAddress discoveryAddress, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener, ServiceClientTuning config, java.net.InetSocketAddress... bootDispatcherAddresses) Connects this message client with the Rating Instances.
void	connect(java.lang.String systemName, int lookupDuration, java.net.InetSocketAddress discoveryAddress, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener, ServiceClientTuning config, com.highdeal.barbus.InstanceAddress... bootDispatcherAddresses) Connects this charging client with the SAP CC system by using the UDP discovery function.
void	connect(java.lang.String hostname, int hostport, int timeout) Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; A client timeout must be specified.
void	connect(java.lang.String hostname, int hostport, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener) Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape.
void	connect(java.lang.String hostname, int port, java.lang.String bindAddress, int timeout, FoundLostRatingListener ratingListener, ServiceClientTuning config) Connects this message client with the Rating Instances.
static com.highdeal.cnd.message.common.AcceptableResponse	generateResponse(com.highdeal.cnd.message.common.ReratingInfoRequest request, boolean isAccepted)
BootMode	getBootMode() Returns which API is used to retrieve from the remote instances, the Instance Map needed for the connection.
protected com.highdeal.barbus.RoundRobinClient	getClient() Deprecated. Deprecated since version 2.0 of SAP CC and should not be called anymore
ClientOpEventListener	getClientOpEventListener(ClientOpEventTopic topic) Gets the client operation event listener used by the client for the specified topic.
protected java.lang.String	getClusterName() Deprecated. Deprecated since version 2.0 of SAP CC Gets the system name.
protected com.highdeal.util.IEventListener	getEventListenerFromListener(java.lang.Object listener)
protected FoundLostRatingListener	getFoundLostRatingListener() Returns the rating listener previously set.
static com.highdeal.cnd.message.common.ReratingInfoRequest	getRequestFromBuffer(com.highdeal.hmi.IDataBuffer buf)
static com.highdeal.cnd.message.common.AcceptableResponse	getResponseFromBuffer(com.highdeal.hmi.IDataBuffer buf)
protected com.highdeal.cnd.message.sensor.SensorsManager	getSensorsManager()
javax.net.ssl.SSLContext	getSslContext() Returns the SSL context used with secure connections.
int	getTimeout() Returns the client communication timeout in milliseconds for each request (or -1 to wait indefinitely).
GuidingEntry	guiderLookup(GuidingRequest request) Requests the connected SAP CC Core Server system for the guiding entry relating to the specified guiding request;
LookedUpGuidingEntry[]	guiderLookup(GuidingRequest[] requests) Requests the connected SAP CC Core Server system for processing in batch mode a set of guiding requests.
GuidingEntry	guiderLookup(java.lang.String serviceID, java.lang.String userServiceID, java.util.Date consumptionDate) Requests the connected SAP CC Core Server system for the guiding entry that relates to the specified user service ID (USID) and service ID (SID) at the specified consumption date of the digital service;
boolean	isConnected() Gets the connected connection status.
boolean	isNoTimeout() Checks if this charging client handles timeout.
protected boolean	isValid(ChargeableItem ci, InvalidItemListener listener) Checks whether the specified chargeable item is valid or not; A call back listener has to be given to handle errors.
protected void	notifyHeartBeat(com.highdeal.barbus.Client client)
boolean	pingReratingOperation(java.lang.String reratingLockCode) Checks if a rerating operation identified is running.
protected void	register(com.highdeal.hmi.IConnectable connectable)
protected void	sendSession() FOR INTERNAL USE ONLY - All the messages between the last call of the method beginSession() and now for this thread are sent.
void	setBootMode(BootMode mode) Deprecated.
void	setClientOpEventListener(ClientOpEventTopic topic, ClientOpEventListener listener) Sets the client operation event listener to the specified topics; It will be notified each time an event corresponding to the registered topics.
protected void	setClusterName(java.lang.String name) Deprecated. Deprecated since version 2.0 of SAP CC
protected void	setFoundLostRatingListener(FoundLostRatingListener ratingListener) Sets the rating listener that will be notified each time a rater instance of the SAP CC system will be found or lost.
void	setHAEventListener(HAEventListener listener) Deprecated. Deprecated since version 0.0 of SAP CC Sets the HA listener dedicated to High Availability events; It will be notified each time the status of an instance of the connected SAP CC system has changed.
void	setNoTimeout(boolean noTimeout) Sets that this charging client handles timeout.
void	setReratingInfoRequestHandler(com.highdeal.barbus.RequestHandler newHandler) Sets an handler that will react to rerating information published by the distant SAP CC system.
void	setSslContext(javax.net.ssl.SSLContext sslContext) Sets the SSL context used with secure connections.
StartSubscriptionReratingResult	startContractCollectionRerating(java.lang.String reratingLockCode, short partitionId, java.util.Date restorationDate, java.util.List<java.lang.Long> contractIdList) Starts the rerating of a collection of charging contracts.
StartSubscriptionReratingResult	startSubscriptionRerating(java.lang.String reratingLockCode, long subscriptionId, short partitionId, AccessibleChargeType accessibleChargeType, java.util.Date restorationDate) Starts the rerating of a subscription or charging contract.
boolean	stopSubscriptionRerating(java.lang.String reratingLockCode, long subscriptionId, java.util.Date maxConsumptionDate, java.util.Date activationDate, short partitionId, AccessibleChargeType accessibleChargeType) Stops the rerating of a subscription or charging contract.
boolean	unlockSubscription(java.lang.String reratingLockCode, long subscriptionId, java.util.Date maxConsumptionDate, java.util.Date activationDate, short partitionId) Deprecated.

Methods inherited from class com.highdeal.cnd.message.AsyncBatchServiceClient

acquire, batchCharge, batchCharge, blankCharge, charge, charge, charge, charge, getDefaultServiceClientTuning, getRatingTopic, getTopicsToSubscribe, guiderLookup, guiderLookup, guiderLookup, informStartContractCollectionRerating, informStartSubscriptionRerating, informStopSubscriptionRerating, informUnlockSubscription, updateHandler

Methods inherited from class java.lang.Object

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

Field Detail

RERATING_STATUS_START

public static final int RERATING_STATUS_START

See Also:

Constant Field Values

RERATING_STATUS_UPDATE

public static final int RERATING_STATUS_UPDATE

See Also:

Constant Field Values

RERATING_STATUS_STOP

public static final int RERATING_STATUS_STOP

See Also:

Constant Field Values

RERATING_STATUS_PING

public static final int RERATING_STATUS_PING

See Also:

Constant Field Values

listeners

protected java.util.List<AsyncRatingServiceClient.RegisterListener> listeners

ratingListListener

protected final com.highdeal.cnd.message.AsyncRatingServiceClient.RLListener ratingListListener

NONE_TRANSACTION

public static final int NONE_TRANSACTION

Constant to return no usage transaction

See Also:

Constant Field Values

MASTER_TRANSACTION

public static final int MASTER_TRANSACTION

Constant to return the master usage transaction

See Also:

Constant Field Values

ALL_TRANSACTION

public static final int ALL_TRANSACTION

Constant to return all the usage transactions

See Also:

Constant Field Values

ALL_TRANSACTION_AND_RECURRING

public static final int ALL_TRANSACTION_AND_RECURRING

Constant to return all the usage transactions and all the recurring/one-shot transactions

See Also:

Constant Field Values

CANCELLED

public static final int CANCELLED

Constant to set up the resolution used when the time to live (TTL) is expired as canceled

See Also:

Constant Field Values

CONFIRMED

public static final int CONFIRMED

Constant to set up the resolution used when the time to live (TTL) is expired as confirmed

See Also:

Constant Field Values

Constructor Detail

BatchServiceClient

public BatchServiceClient()

Creates a non-initialized charging client for implementing the offline charging services in your Java-based client application; One of the {TEST #connect(java.lang.String, int) connect(..)} methods must then be used to connect this MessageClient to the distant SAP CC system.

Method Detail

setReratingInfoRequestHandler

public void setReratingInfoRequestHandler(com.highdeal.barbus.RequestHandler newHandler)

Sets an handler that will react to rerating information published by the distant SAP CC system.

Overrides:

setReratingInfoRequestHandler in class AsyncBatchServiceClient

Parameters:

newHandler - An implementation of an handler

charge

public PurchaseOrder charge(ChargeableItem ci,
                            java.lang.String serviceID,
                            java.lang.String userServiceID,
                            java.util.Date consumptionDate,
                            java.lang.String reratingLockCode,
                            int ts,
                            boolean ft)
                     throws InvalidItemException,
                            ForbiddenChargeException,
                            TransactionClearingException,
                            ServerFailureException,
                            CommunicationFailureException

Requests the connected SAP CC Core Server system to charge in offline environment a unit chargeable item (service consumption information data) for the specified user service ID and the specified service ID at the specified date; Operation request is sent in synchronous mode.

This operation may conflict with the prerating feature. Do not use this operation if some prerating operatoins are not post-rated.

Parameters:

ci - The chargeable item to charge and that represents the consumption of a customer service

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

reratingLockCode - The rerating lock code in case of recharging

ts - The transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

ft - Sets if the returned transactions must be filtered according to the transactionTemplate

Returns:

The transaction's PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the distant SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

charge

public PurchaseOrder charge(ChargeableItem ci,
                            java.lang.String serviceID,
                            java.lang.String userServiceID,
                            java.util.Date consumptionDate,
                            java.lang.String reratingLockCode,
                            ChargeExecutionContext context)
                     throws InvalidItemException,
                            ForbiddenChargeException,
                            TransactionClearingException,
                            ServerFailureException,
                            CommunicationFailureException

Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and service ID at the specified date.
The result can be retrieved using the method PurchaseOrder.getChargingResults(). The content of the result can be configured using the specified context.
This operation may conflict with the prerating feature. Do not use this operation if some preratings are not post-rated.

Parameters:

ci - the ChargeableItem to charge

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

reratingLockCode - the rerating operation lock code

context - the conditions under which the charge operation must be executed (can be null)

Returns:

the transaction's PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the server is not available

CommunicationFailureException - if a communication failure occurs

charge

public PurchaseOrder charge(ChargeableItem ci,
                            java.lang.String serviceID,
                            java.lang.String userServiceID,
                            java.util.Date consumptionDate,
                            int ts)
                     throws InvalidItemException,
                            ForbiddenChargeException,
                            TransactionClearingException,
                            ServerFailureException,
                            CommunicationFailureException

Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and the specified service ID at the specified date with transaction filtered selection.

This operation may conflict with the pre-rating feature. Don't use this operation if some pre-ratings are not post-rated.

Parameters:

ci - the ChargeableItem to rate

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

ts - the transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

Returns:

the transaction's PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the server is not available

CommunicationFailureException - if a communication failure occurs

charge

public PurchaseOrder charge(ChargeableItem ci,
                            java.lang.String serviceID,
                            java.lang.String userServiceID,
                            java.util.Date consumptionDate,
                            java.lang.String reratingLockCode)
                     throws InvalidItemException,
                            ForbiddenChargeException,
                            TransactionClearingException,
                            ServerFailureException,
                            CommunicationFailureException

Requests the connected SAP CC Core Server system to charge the specified chargeable item for the specified user service ID and the specified service ID at the specified date without transaction selection.

This operation may conflict with the pre-rating feature. Don't use this operation if some pre-ratings are not post-rated.

Parameters:

ci - the ChargeableItem to rate

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

reratingLockCode - the rerating operation code

Returns:

the transaction's PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the server is not available

CommunicationFailureException - if a communication failure occurs

blankCharge

public PurchaseOrder blankCharge(ChargeableItem ci,
                                 java.lang.String serviceID,
                                 java.lang.String userServiceID,
                                 java.util.Date consumptionDate,
                                 int ts)
                          throws InvalidItemException,
                                 ForbiddenChargeException,
                                 TransactionClearingException,
                                 ServerFailureException,
                                 CommunicationFailureException

Main blank charge opertation; Requests the connected SAP CC Core Server system to charge in blank mode the specified chargeable item for the specified user service ID and service ID at the specified date. This operation is equivalent to a charge operation but the blank mode means that no data is committed to the database.

Caution

If the transaction processor does not take care about the database transaction (transaction processor which stores the transactions into a file by example), the transaction processor action will not be rollbacked.

Parameters:

ci - the chargeable item to be charged by the distant SAP CC system

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

ts - the transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

Returns:

The PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging operation is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the distant SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

blankCharge

public PurchaseOrder blankCharge(ChargeableItem ci,
                                 java.lang.String serviceID,
                                 java.lang.String userServiceID,
                                 java.util.Date consumptionDate,
                                 int ts,
                                 boolean ft)
                          throws InvalidItemException,
                                 ForbiddenChargeException,
                                 TransactionClearingException,
                                 ServerFailureException,
                                 CommunicationFailureException

Refer to the main operation request; Requests the connected SAP CC Core Server system to charge in blank mode the specified chargeable item for the specified user service ID and service ID at the specified date. This operation is equivalent to charge operation but the blank mode means that no data is committed to the database. WARNING : if the transaction processor doesn't take care about the DB transaction (transaction processor which stores the transactions into a file by example), the transaction processor action will not be rollbacked.

Parameters:

ci - the ChargeableItem to rate.

serviceID - the service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - the user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - the date the service was consumed by the end customer

ts - the transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

ft - sets if the returned transactions must be filtered according to the transactionTemplate

Returns:

the transaction's PurchaseOrder

Throws:

InvalidItemException - if the chargeable item is not valid

ForbiddenChargeException - if charging is forbidden

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the server is not available

CommunicationFailureException - if a communication failure occurs

guiderLookup

public GuidingEntry guiderLookup(java.lang.String serviceID,
                                 java.lang.String userServiceID,
                                 java.util.Date consumptionDate)
                          throws ForbiddenChargeException,
                                 ServerFailureException,
                                 CommunicationFailureException

Requests the connected SAP CC Core Server system for the guiding entry that relates to the specified user service ID (USID) and service ID (SID) at the specified consumption date of the digital service;

Parameters:

serviceID - The service identifier (SID), which represents a technical identifier of the service provided by the service provider

userServiceID - The user service identifier (USID), which represents a technical identifier of the end customer consuming the service

consumptionDate - The date when the digital service was consumed by the end customer

Returns:

A guiding entry

Throws:

ForbiddenChargeException - if charging is forbidden

ServerFailureException - if the SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

guiderLookup

public GuidingEntry guiderLookup(GuidingRequest request)
                          throws ForbiddenChargeException,
                                 ServerFailureException,
                                 CommunicationFailureException

Requests the connected SAP CC Core Server system for the guiding entry relating to the specified guiding request;

Parameters:

request - A guiding request

Returns:

A guiding entry

Throws:

ForbiddenChargeException - if charging is forbidden

ServerFailureException - if the SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

guiderLookup

public LookedUpGuidingEntry[] guiderLookup(GuidingRequest[] requests)
                                    throws ForbiddenChargeException,
                                           ServerFailureException,
                                           CommunicationFailureException

Requests the connected SAP CC Core Server system for processing in batch mode a set of guiding requests. It returns an overall result that contains the expected guiding entries associated to an operation status for each initial request; see the status details in the LookedUpGuidingEntry class.

Customizing

You implement this batch operation in your client appliucation. Design and develop the error and exception handling.

Parameters:

requests - A set of guiding requests

Returns:

GuidingEntry[]

Throws:

ForbiddenChargeException - if charging is forbidden

ServerFailureException - if the SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

batchCharge

public BatchChargeResult batchCharge(java.util.Vector<ChargeParameters> parameters,
                                     java.lang.Long subscriptionID,
                                     short partitionID,
                                     int ts)
                              throws BatchChargeException,
                                     ForbiddenChargeException,
                                     ServerFailureException,
                                     CommunicationFailureException,
                                     TransactionClearingException

This main operation allows you to request the connected SAP CC Core Server system to charge in batch mode a chronologically sorted set of chargeable items for a particular past service consumption by a individual end customer; or the specified user service ID (USID) and service ID (SID) and relating to an already identified subscription (and database partition).

The system returns the resulting purchase orders that includes transactions computed according to the ts parameter.

Prerequisites

• The subscription to charge is already identified.
• The database partition of the identified subscription is already determined.

Note

• The SAP CC system filters the computed transactions according to the transaction templates assigned to the subscribed offer.
• This business operation may conflict with prerating operations. Do not use this operation when there are some pending prerating operations.

Parameters:

parameters - The USID, SID, and the chronological set of past chargeable items to charge in batch mode

subscriptionID - The already identifed unique ID of the selected subscription

partitionID - The already identified ID of the database partition that contains the subscription and related customer master data

ts - The transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

Returns:

A set of computed purchase orders and business subexceptions

Throws:

BatchChargeException - if an error occurs during batch charging

ServerFailureException - if the SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the SAP CC system is not available

ForbiddenChargeException - if charging is forbidden

batchCharge

public BatchChargeResult batchCharge(java.util.Vector<ChargeParameters> parameters,
                                     java.lang.Long subscriptionID,
                                     short partitionID,
                                     int ts,
                                     boolean ft,
                                     MessageHeader.TransactionMode tm,
                                     java.lang.String reratingLockCode)
                              throws BatchChargeException,
                                     CommunicationFailureException,
                                     ForbiddenChargeException,
                                     ServerFailureException,
                                     TransactionClearingException

Consult the main batch charging operation and consider the supplementary options: ft, tm, and reratingLockCode.

Requests the connected SAP CC Core Server system to charge in batch mode a sorted set of chargeable items for the specified user service ID (USID) and service ID (SID) and relating to an already identified subscription. The system returns the resulting purchase orders that includes transactions computed according to the ts parameter.

Note

• The SAP CC system filters the computed transactions according to the transaction templates assigned to the subscribed offer.
• This business operation may conflict with prerating operations. Do not use this operation there are some pending prerating operations.

Parameters:

parameters - The chronological set of ChargeParameters to charge in batch mode

subscriptionID - The unique ID of the selected subscription

partitionID - The identifier of the rating partition

ts - The transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

ft - Optional flag to enable the filtering of resulting transactions according to the transaction template configured in the subscribed offer

tm - The transaction mode

reratingLockCode - The rerating operation code

Returns:

A set of computed purchase orders and business subexceptions

Throws:

BatchChargeException - if an error occurs during batch charging

ServerFailureException - if the server is not available

CommunicationFailureException - if a communication failure occurs

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the server is not available

ForbiddenChargeException - if charging is forbidden

batchCharge

public BatchChargeResult batchCharge(java.util.Vector<ChargeParameters> parameters,
                                     java.lang.Long subscriptionOrContractID,
                                     short partitionID,
                                     AccessibleChargeType chargeType,
                                     int ts,
                                     boolean ft,
                                     MessageHeader.TransactionMode tm,
                                     java.lang.String reratingLockCode)
                              throws BatchChargeException,
                                     CommunicationFailureException,
                                     ForbiddenChargeException,
                                     ServerFailureException,
                                     TransactionClearingException

This operation allows you to request the connected SAP CC Core Server system to charge in batch mode a sorted set of chargeable items for the specified user service ID (USID) and service ID (SID) and relating to an already identified subscription or charging contract. The system returns the resulting purchase orders that includes transactions computed according to the ts parameter.

Note

When dealing with subscriptions:

• The SAP CC system filters the computed transactions according to the transaction templates assigned to the subscribed offer.
• This operation may conflict with prerating operations. Do not use this operation there are some pending prerating operations.

Parameters:

parameters - The USID, the SID, the chronological set of past chargeable items to charge in batch mode

subscriptionOrContractID - The unique ID of the selected subscription or charging contract

partitionID - The identifier of the rating partition

chargeType - The type of accessible charge depending on the scope of the batch charging operation: subscription or charging contract

ts - The transaction selection NONE_TRANSACTION, MASTER_TRANSACTION, ALL_TRANSACTION, ALL_TRANSACTION_AND_RECURRING

ft - Optional flag to enable the filtering of resulting transactions according to the transaction template configured in the subscribed offer (only relevant for subscriptions)

tm - The {#@link TransactionMode transaction mode}

reratingLockCode - The rerating operation code

Returns:

A set of computed purchase orders and business subexceptions

Throws:

BatchChargeException - if an error occurs during batch charging

ServerFailureException - if the SAP CC system is not available

CommunicationFailureException - if a communication failure occurs

TransactionClearingException - if a transaction clearing error occurs

ServerFailureException - if the SAP CC system is not available

ForbiddenChargeException - if charging is forbidden

acquire

public java.util.List<AcquisitionResult> acquire(java.util.List<AcquisitionParameters> parameters)
                                          throws CommunicationFailureException,
                                                 ServerFailureException

Requests the connected SAP CC Core Server system to collect a list of chargeable items included in an acquisition parameter. The SAP CC Core Server system processes these chargeable items and stores them in temporary files.

Note

The SAP CC system executes the acquisition request in the most processing mode: The failure of a single acquisition does not stop the global acquisition. Most ot the single acquisition are processed.

Acquisition parameters contains a chargeable item and access information (service identifier, user identifier and consumption date). The acquisition consists in finding the charging contract targetted by the access specified, and then to export the chargeable item with additional information using the CIF, without performing rating or charging, for storage purposes.

The acquisition operations are executed in mode most, meaning that if an acquisition operation for a chargeable item fails, the following acquisition operations are executed anyway.

The method waits for the end of the processing by the connected SAP CC system. It returns a list of acquisition operation results, each one corresponding to the acquisition parameters in the same position in the list of parameters specified as argument of the method.

Error Handling:

If a single acquisition operation fails, the corresponding result contains an exception which contains details on the error.

Note

This business operation is not allowed if the CIF of the rater instances does not contain a chargeable item processor.

Parameters:

parameters - A set of single acquisition operations to execute

Returns:

A set of single acquisition results, in the same order as the single operation requests specified as arguments in this method; the result may include business subexceptions.

Throws:

CommunicationFailureException - if a communication failure occurs during the acquisition of the chargeable items

ServerFailureException - if an unexpected exception occurs during the acquisition of the chargeable items

startSubscriptionRerating

public StartSubscriptionReratingResult startSubscriptionRerating(java.lang.String reratingLockCode,
                                                                 long subscriptionId,
                                                                 short partitionId,
                                                                 AccessibleChargeType accessibleChargeType,
                                                                 java.util.Date restorationDate)
                                                          throws CommunicationFailureException,
                                                                 ServerFailureException,
                                                                 RerateSubscriptionException

Starts the rerating of a subscription or charging contract.

This operation does the following:

• Lock the subscription or charging contract using the rerating lock code specified, so that it cannot be used by other processes
• Restore the values of the counters of the subscription or charging contract at the date specified
• Perform additional verifications with an external system using the Rerating Integration Framework (RIF)

Parameters:

reratingLockCode - The rerating operation code

subscriptionId - The unique identifier of the subscription or charging contract to rerate

partitionId - The partition identifier of the subscription or charging contract to rerate

accessibleChargeType - The type of object on which the rerating is performed (subscription or charging contract)

restorationDate - The date from which the rerating will be performed

Returns:

A start rerating result containing information on the execution of the operation

Throws:

CommunicationFailureException - if a communication failure occurs during the execution of the operation

ServerFailureException - if an unexpected failure occurs during the execution of the operation

RerateSubscriptionException - if the rerating operation cannot be performed

startContractCollectionRerating

public StartSubscriptionReratingResult startContractCollectionRerating(java.lang.String reratingLockCode,
                                                                       short partitionId,
                                                                       java.util.Date restorationDate,
                                                                       java.util.List<java.lang.Long> contractIdList)
                                                                throws CommunicationFailureException,
                                                                       ServerFailureException,
                                                                       RerateSubscriptionException

Starts the rerating of a collection of charging contracts.

This operation does the following:

• Lock the charging contracts using the rerating lock code specified, so that they cannot be used by other processes
• Restore the values of the counters of the charging contracts at the date specified
• Perform additional verifications with an external system using the Rerating Integration Framework (RIF)

Parameters:

reratingLockCode - The rerating operation code

partitionId - The partition identifier of the charging contracts to rerate

restorationDate - The date from which the rerating will be performed

contractIdList - The list of unique identifiers of the charging contracts to rerate

Returns:

A start rerating result containing information on the execution of the operation

Throws:

CommunicationFailureException - if a communication failure occurs during the execution of the operation

ServerFailureException - if an unexpected failure occurs during the execution of the operation

RerateSubscriptionException - if the rerating operation cannot be performed

unlockSubscription

@Deprecated
public boolean unlockSubscription(java.lang.String reratingLockCode,
                                             long subscriptionId,
                                             java.util.Date maxConsumptionDate,
                                             java.util.Date activationDate,
                                             short partitionId)
                           throws CommunicationFailureException,
                                  ForbiddenChargeException,
                                  ServerFailureException,
                                  TransactionClearingException

Deprecated.

Stops the rerating of a subscription.

This operation does the following:

• Optionally activate the subscription until the activate date specified
• Unlock the subscription, so that it can be used by other processes again

Parameters:

reratingLockCode - The rerating operation code

subscriptionId - The unique identifier of the subscription to rerate

maxConsumptionDate - The maximum consumption date of the CDRs rated during the rerating operation

activationDate - The date to be used to activate the subscription (if no date is specified, the activation is not performed)

partitionId - The partition identifier of the subscription to rerate

Returns:

true if subscription has been successfully unlocked, false otherwise

Throws:

CommunicationFailureException - if a communication failure occurs during the execution of the operation

ServerFailureException - if an unexpected failure occurs during the execution of the operation

ForbiddenChargeException - if the rerating operation cannot be performed

TransactionClearingException - if the rerating operation cannot be performed

stopSubscriptionRerating

public boolean stopSubscriptionRerating(java.lang.String reratingLockCode,
                                        long subscriptionId,
                                        java.util.Date maxConsumptionDate,
                                        java.util.Date activationDate,
                                        short partitionId,
                                        AccessibleChargeType accessibleChargeType)
                                 throws CommunicationFailureException,
                                        ForbiddenChargeException,
                                        ServerFailureException,
                                        TransactionClearingException

Stops the rerating of a subscription or charging contract.

This operation does the following:

• Optionally activate the subscription or charging contract until the activate date specified
• Unlock the subscription or charging contract, so that it can be used by other processes again

Parameters:

reratingLockCode - The rerating operation code

subscriptionId - The unique identifier of the subscription or charging contract to rerate

maxConsumptionDate - The maximum consumption date of the CDRs rated during the rerating operation

activationDate - The date to be used to activate the subscription or charging contract (if no date is specified, the activation is not performed)

partitionId - The partition identifier of the subscription or charging contract to rerate

accessibleChargeType - The type of object on which the rerating is performed (subscription or charging contract)

Returns:

true if subscription or charging contract has been successfully unlocked, false otherwise

Throws:

CommunicationFailureException - if a communication failure occurs during the execution of the operation

ServerFailureException - if an unexpected failure occurs during the execution of the operation

ForbiddenChargeException - if the rerating operation cannot be performed

TransactionClearingException - if the rerating operation cannot be performed

pingReratingOperation

public boolean pingReratingOperation(java.lang.String reratingLockCode)
                              throws CommunicationFailureException

Checks if a rerating operation identified is running.

Overrides:

pingReratingOperation in class AsyncBatchServiceClient

Parameters:

reratingLockCode - The rerating operation code to check

Returns:

true if the rerating operation is alive, false otherwise

Throws:

CommunicationFailureException - if a communication failure occurs during the execution of the operation

generateResponse

public static com.highdeal.cnd.message.common.AcceptableResponse generateResponse(com.highdeal.cnd.message.common.ReratingInfoRequest request,
                                                                                  boolean isAccepted)

getResponseFromBuffer

public static com.highdeal.cnd.message.common.AcceptableResponse getResponseFromBuffer(com.highdeal.hmi.IDataBuffer buf)

getRequestFromBuffer

public static com.highdeal.cnd.message.common.ReratingInfoRequest getRequestFromBuffer(com.highdeal.hmi.IDataBuffer buf)

getSslContext

public javax.net.ssl.SSLContext getSslContext()

Returns the SSL context used with secure connections.

Specified by:

getSslContext in interface com.highdeal.barbus.ISSLContextProvider

Returns:

The SSL context used with secure connections

setSslContext

public void setSslContext(javax.net.ssl.SSLContext sslContext)

Sets the SSL context used with secure connections.

Parameters:

sslContext - The SSL context used with secure connections

connect

public final void connect(java.lang.String hostname,
                          int hostport)
                   throws java.io.IOException

Connects this charging client to the distant SAP CC Core Server system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; No client timeout is specified.

This method is equivalent to: connect(hostname, hostport, -1, null);.

Parameters:

hostname - The name of the machine that hosts a dispatcher instance of the SAP CC Core Server system

hostport - The communication port on which the server system waits for requests on TCP/IP channel used by the Message TCP/IP technical interface

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if the server system is not running, for example).

connect

public final void connect(java.lang.String hostname,
                          int hostport,
                          int timeout)
                   throws java.io.IOException

Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; A client timeout must be specified.

This method is equivalent to: connect(hostname, hostport, null, timeout);.

Parameters:

hostname - The name of the machine that hosts a dispatcher instance of the SAP CC Core Server system

hostport - The port on which the server waits for requests

timeout - The timeout in milliseconds for each operation request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending the operation request.

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if the server system is not running for example)

connect

public final void connect(java.lang.String hostname,
                          int hostport,
                          FoundLostRatingListener ratingListener)
                   throws java.io.IOException

Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape; No client timeout is specified.

Parameters:

hostname - The host name of the server

hostport - The port on which the server waits for request

ratingListener - The FoundLostRatingListener that will be notified each time a rating instance will be found or lost

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if server is not running, for example)

connect

public final void connect(java.lang.String hostname,
                          int hostport,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener)
                   throws java.io.IOException

Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape.

Parameters:

hostname - The host name of the server

hostport - The port on which the server waits for request

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending the request.

ratingListener - The FoundLostRatingListener that will be notified each time a rating instance will be found or lost.

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if server is not running, for example)

java.lang.IllegalArgumentException - if hostname is null or if the port is out of range

connect

public final void connect(java.lang.String hostname,
                          int port,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener,
                          ServiceClientTuning config)
                   throws java.io.IOException

Connects this message client with the Rating Instances.

First of all, this client contacts the boot instance defined by the arguments hostname and port to get its instance map. Then this client opens connections with all the rating instances defined in the instance map.

Parameters:

hostname - The host name of the server

port - The port on which the server waits for request

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending the request.

ratingListener - The FoundLostRatingListener that will be notified each time a rating instance will be found or lost

config - The service tuning configuration

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if server is not running, for example).

java.lang.IllegalArgumentException - if hostname is null or if the port is out of range.

connect

public final void connect(java.lang.String hostname,
                          int port,
                          boolean secure,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener,
                          ServiceClientTuning config)
                   throws java.io.IOException

Connects this message client with the Rating Instances.

First of all, this client contacts the boot instance defined by the arguments hostname and port to get its instance map. Then this client opens connections with all the rating instances defined in the instance map.

Parameters:

hostname - The host name of the server

port - The port on which the server waits for request

secure - true if the connection to the server is secure

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending request.

ratingListener - The FoundLostRatingListener that will be notified each time a Rating Instance will be found or lost.

config - The service tuning configuration

Throws:

java.io.IOException - if the client cannot connect to the server (if server is not running, for example).

java.lang.IllegalArgumentException - if hostname is null or if the port is out if range.

connect

public final void connect(java.lang.String systemName,
                          java.net.InetSocketAddress... bootDispatcherAddresses)
                   throws java.io.IOException

Connects this charging client to the distant SAP CC system that is the Online Charging System (OCS) or Offline Charging System (OFCS) in your SAP system landscape.

If systemName is not null, this charging client looks up for an SAP CC system named systemName during 2 seconds to discover some rating boot instances registered to the distant system. The charging client uses the IPv4 multicast address 234.5.6.7:8910. If some instances have been found, your charging client opens connections with the discovered rater instances. If the provided systemName is null or empty, or if preceding discovery has failed, this client will use bootDispatcherAddresses as a boot rating instance address list to connect to the SAP CC system. Again, the client opens connections with the discovered rater instances.

Prerequisites: At least systemName or bootDispatcherAddresses must be provided.

Parameters:

systemName - The SAP CC system name

bootDispatcherAddresses - A backup rating instance boot dispatcher list, provided only if for some reasons

Throws:

java.io.IOException - if the client cannot connect to the server (if server is not running, for example)

java.lang.IllegalArgumentException - if some arguments are badly provided

connect

public final void connect(java.lang.String systemName,
                          int lookupDuration,
                          java.net.InetSocketAddress discoveryAddress,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener,
                          ServiceClientTuning config,
                          java.net.InetSocketAddress... bootDispatcherAddresses)
                   throws java.io.IOException

Connects this message client with the Rating Instances.

If systemName is not null, this client lookups for a rating system named systemName during lookupDuration milliseconds in order to discover some rating boot instances registered to the system. If some instances have been found, this client opens connections with the discovered rating instances. If provided systemName is null or empty, or if preceding discovery has failed, this client will use bootDispatcherAddresses as a boot rating instance address list to connect to the rating system. Again, the client opens connections with the discovered rating instances. At least systemName or bootDispatcherAddresses must be provided.

Parameters:

systemName - The SAP CC system name

lookupDuration - The system discovery lookup duration

discoveryAddress - The lookup discovery address, which must be an IPv4 multicast address

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending request.

ratingListener - The FoundLostRatingListener that will be notified each time a Rating Instance will be found or lost.

config - The service tuning configuration

bootDispatcherAddresses - A backup rating instance boot dispatcher list, provided only if for some reasons

Throws:

java.io.IOException - if the client cannot connect to the server (if server is not running, for example).

java.lang.IllegalArgumentException - if some arguments are badly provided

connect

public final void connect(java.lang.String systemName,
                          com.highdeal.barbus.InstanceAddress... bootDispatcherAddresses)
                   throws java.io.IOException

Connects this charging client with the Rating Instances.

If systemName is not null, this client lookups for a rating system named systemName during 2 seconds in order to discover some rating boot instances registered to the system. This client will use IPv4 multicast address 234.5.6.7:8910. If some instances have been found, this charging client opens connections with the discovered rating instances. If provided systemName is null or empty, or if preceding discovery has failed, this client will use bootDispatcherAddresses as a boot rating instance address list to connect to the rating system. Again, the client opens connections with the discovered rating instances.

At least systemName or bootDispatcherAddresses must be provided.

Parameters:

systemName - The SAP CC system name

bootDispatcherAddresses - a backup rating instance boot dispatcher list, provided only if for some reasons

Throws:

java.io.IOException - if the client cannot connect to the server (if server is not running, for example).

java.lang.IllegalArgumentException - if some arguments are badly provided

connect

public final void connect(java.lang.String systemName,
                          int lookupDuration,
                          java.net.InetSocketAddress discoveryAddress,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener,
                          ServiceClientTuning config,
                          com.highdeal.barbus.InstanceAddress... bootDispatcherAddresses)
                   throws java.io.IOException

Connects this charging client with the SAP CC system by using the UDP discovery function.

If systemName is not null, this client looks up for a rating system named systemName during lookupDuration milliseconds in order to discover some rating boot instances registered to the system. If some instances have been found, this client opens connections with the discovered rating instances. If provided systemName is null or empty, or if preceding discovery has failed, this client will use bootDispatcherAddresses as a boot rating instance address list to connect to the rating system. Again, the client opens connections with the discovered rating instances. At least systemName or bootDispatcherAddresses must be provided.

Parameters:

systemName - The Rating system name

lookupDuration - The system discovery lookup duration

discoveryAddress - The lookup discovery address, which must be an IPv4 multicast address

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending the request.

ratingListener - The FoundLostRatingListener that will be notified each time a Rating Instance will be found or lost.

config - The service tuning configuration

bootDispatcherAddresses - A backup rating instance boot dispatcher list, provided only if for some reasons

Throws:

java.io.IOException - if the client cannot connect to the server (if server is not running, for example)

java.lang.IllegalArgumentException - if some arguments are badly provided

connect

public final void connect(InstanceMap imap,
                          java.lang.String bindAddress,
                          int timeout,
                          FoundLostRatingListener ratingListener,
                          ServiceClientTuning config)
                   throws java.io.IOException

Connects this charging client with the SAP CC system by using an instance map; A timeout must be specified.

Parameters:

imap - The instance map that describes the SAP CC system to connect to; Cannot be null.

bindAddress - The address to bind to, can be null

timeout - The timeout in milliseconds for each request (or -1 to wait indefinitely). If you use zero and acknowledgments are requested then a CommunicationFailureException will be thrown without sending the request.

ratingListener - The FoundLostRatingListener that will be notified each time a rater instance will be found or lost.

config - The service tuning configuration

Throws:

java.io.IOException - if the client cannot connect to the distant SAP CC system (if the server system is not running, for example).

isNoTimeout

public final boolean isNoTimeout()

Checks if this charging client handles timeout.

Returns:

true if the charging client handles timeout

setNoTimeout

public final void setNoTimeout(boolean noTimeout)

Sets that this charging client handles timeout.

Parameters:

noTimeout - true if your client handles timeout

setClientOpEventListener

public final void setClientOpEventListener(ClientOpEventTopic topic,
                                           ClientOpEventListener listener)

Sets the client operation event listener to the specified topics; It will be notified each time an event corresponding to the registered topics.

• It is not possible to set null for the default topic.
• If the listener is null, then the default listener is set (@link ClientOpEventTopic#DEFAULT).

Parameters:

topic - The topic to plug the client operation event listener to

listener - The client operation event listener

getClientOpEventListener

public final ClientOpEventListener getClientOpEventListener(ClientOpEventTopic topic)

Gets the client operation event listener used by the client for the specified topic. If the topic is null the default topic listener is returned ( getClientOpEventListener(ClientOpEventTopic.DEFAULT) ). There is always a default listener for a specific topic.

Parameters:

topic - The topic plugged the client operation event listener

Returns:

not null

getTimeout

public final int getTimeout()

Returns the client communication timeout in milliseconds for each request (or -1 to wait indefinitely).

Returns:

The timeout in milliseconds, or -1 if no timeout has been defined

isConnected

public final boolean isConnected()

Gets the connected connection status.

Returns:

true if the charging client is connected and false otherwise.

close

public final void close()

Closes the connection with the connected SAP CC system; This method allows to release all the resources attached (sockets and buffers) in the charging client.

setBootMode

@Deprecated
public final void setBootMode(BootMode mode)

Deprecated.

Defines which API will be used to retrieve from the remote instances, the Instance Map needed for the connection. As BootMode.HTTP_BOOT_MODE and BootMode.HTTPS_BOOT_MODE are deprecated, this method is deprecated too.

Parameters:

mode - Is this method is deprecated and to use the Message TCP communication or is HTTP_BOOT_MODE to use the HTTP communication.

getBootMode

public final BootMode getBootMode()

Returns which API is used to retrieve from the remote instances, the Instance Map needed for the connection.

Returns:

MESSAGE_BOOT_MODE because BootMode.HTTP_BOOT_MODE and BootMode.HTTPS_BOOT_MODE are deprecated.

isValid

protected final boolean isValid(ChargeableItem ci,
                                InvalidItemListener listener)

Checks whether the specified chargeable item is valid or not; A call back listener has to be given to handle errors.

Parameters:

ci - The chargeable item to check

listener - The call back listener

Returns:

true if chargeable item is valid, false otherwise

asyncSend

protected final void asyncSend(com.highdeal.cnd.message.common.CollectorMessage m,
                               int maxTimeout,
                               ResponseHandlerWrapper handler,
                               com.highdeal.util.IEventListener eventListener)

FOR INTERNAL USE ONLY - Sends asynchronously the message m; When a response or an exception is received by the client application, it must back the response handler.

Parameters:

m - The message that must be sent asynchronously

maxTimeout - The maximum timeout before getting a communication failure

handler - The call back handler

beginSession

protected final void beginSession()

FOR INTERNAL USE ONLY - Begins a client session for this thread; All the messages are stored in memory and are not sent until the method sendSession() is called. If there is already a session, the session is sent by a call of the method sendSession() and a new session is created.

sendSession

protected final void sendSession()

FOR INTERNAL USE ONLY - All the messages between the last call of the method beginSession() and now for this thread are sent. The memory session is closed.

getEventListenerFromListener

protected com.highdeal.util.IEventListener getEventListenerFromListener(java.lang.Object listener)

setClusterName

@Deprecated
protected final void setClusterName(java.lang.String name)

Deprecated. Deprecated since version 2.0 of SAP CC

Sets the system name from the cluster name.

Parameters:

name - The system name

getClusterName

@Deprecated
protected final java.lang.String getClusterName()

Deprecated. Deprecated since version 2.0 of SAP CC Gets the system name.

Returns:

The system name

setHAEventListener

@Deprecated
public final void setHAEventListener(HAEventListener listener)

Deprecated. Deprecated since version 0.0 of SAP CC

Sets the HA listener dedicated to High Availability events; It will be notified each time the status of an instance of the connected SAP CC system has changed.

Parameters:

listener - The listener for High Availability events

setFoundLostRatingListener

protected final void setFoundLostRatingListener(FoundLostRatingListener ratingListener)

Sets the rating listener that will be notified each time a rater instance of the SAP CC system will be found or lost.

Parameters:

ratingListener - The rating listener

See Also:

getFoundLostRatingListener()

getFoundLostRatingListener

protected final FoundLostRatingListener getFoundLostRatingListener()

Returns the rating listener previously set.

Returns:

The rating listener previously set

See Also:

setFoundLostRatingListener(FoundLostRatingListener)

getClient

@Deprecated
protected final com.highdeal.barbus.RoundRobinClient getClient()

Deprecated. Deprecated since version 2.0 of SAP CC and should not be called anymore

Gets the inner client.

Returns:

inner client

notifyHeartBeat

protected final void notifyHeartBeat(com.highdeal.barbus.Client client)

register

protected final void register(com.highdeal.hmi.IConnectable connectable)

addListener

protected void addListener(AsyncRatingServiceClient.RegisterListener listener)

getSensorsManager

protected com.highdeal.cnd.message.sensor.SensorsManager getSensorsManager()