StatelessServiceClient (SAP CC 4.0 Core

Overview

Package

Class

Tree

Deprecated

Index

Help

SAP Convergent Charging

Core APIs (Java and XML)

BART APIs (Java and XML)

IEC APIs (Java)

Java and XML APIs (Core)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.highdeal.cnd.message
Class StatelessServiceClient

java.lang.Object
  com.highdeal.cnd.message.StatelessServiceClient

All Implemented Interfaces:: com.highdeal.barbus.ISSLContextProvider

public class StatelessServiceClient
extends java.lang.Object
extends java.lang.Object

This Java class allows your client application to send some stateless rating and prerating events to the connected SAP CC Core Server system by using the Message TCP high-speed technical interface.

Consider the following information in this topic:

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

Synchronous Services and Operations

Features

This rating and 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

Communication Timeout

When a timeout is associated to a given message client, it must be performed during this limited time. If this limited time is exceeded, the operation is rolled back but client timeout does not guarantee that related operations successfully ended (see Technical Reference Guide).

High Performances

By default, this charging client provides high throughput performances and very low latency responses. For very high troughput performances, consider the fine-tuning activity.

High Availability (HA)

By default, this charging client provides high availability services with an SAP CC system with distributed instances in HA setup.

Security

Use setSslContext(javax.net.ssl.SSLContext )

Implementation in Your Client Application

Initializing and Connecting

Your charging client (based on this StatefulServiceClient class) must be initialized via establishing a connection to one of more dispatcher instances available in the distant SAP CC system. Once at least one dispatcher of the SAP CC system is connected from the client application, the client application retrieves automatically the list of all available dispatcher instances on the server system side. It establishes a connection with every one of them automatically.

Implementing Event-Based Rating Services

Depending on your business requirements, you implement one of the following operations in your Java-based client application:

Additional Information

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

Consult the SAP CC Library (Application Help) for more information about the online charging services, the charging process and its execution modes (stateless, stateful).

Nested Class Summary
`protected static interface`	`AsyncRatingServiceClient.RegisterListener`

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
`static int`	`POST_RATE_CANCELLATION`
`static int`	`POST_RATE_CONFIRMATION`
`protected com.highdeal.cnd.message.AsyncRatingServiceClient.RLListener`	`ratingListListener`

Constructor Summary
`StatelessServiceClient()` Creates a non-initialized stateless service client in your client application.
`StatelessServiceClient(java.lang.String hostName, int port)` Creates a stateless service client and connect it to a server.
`StatelessServiceClient(java.lang.String hostName, int port, FoundLostRatingListener ratingListener)` Creates a stateless service client and connect it to a server.
`StatelessServiceClient(java.lang.String hostName, int port, FoundLostRatingListener ratingListener, int timeout)` Creates a stateless service client and connect it to a server.
`StatelessServiceClient(java.lang.String hostName, int port, int timeout)` Creates a stateless service client and connect it to a server.
`StatelessServiceClient(java.lang.String hostName, int port, java.lang.String bindAddress, FoundLostRatingListener ratingListener, int timeout)` Creates a stateless service client and connect it to a server.

Method Summary
`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`.
`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.
`protected boolean`	`checkDB()` This method is for internal use only.
`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, FoundLostRatingListener ratingListener, int timeout, ServiceClientTuning config)` Deprecated. use `connect(String, int, String, FoundLostRatingListener, int, ServiceClientTuning)`
`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 port, java.lang.String bindAddress, FoundLostRatingListener ratingListener, int timeout)` Connect this stateless service client using the round robin with the server.
`void`	`connect(java.lang.String hostName, int port, java.lang.String bindAddress, FoundLostRatingListener ratingListener, int timeout, ServiceClientTuning config)` Connect this stateless service client using the round robin with the server.
`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.
`protected int`	`currentQueueSize()` This method is for internal use only.
`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 ServiceClientTuning`	`getDefaultServiceClientTuning()` Gets the default `service tuning` of this client useful to configure connections.
`protected com.highdeal.util.IEventListener`	`getEventListenerFromListener(java.lang.Object listener)`
`protected FoundLostRatingListener`	`getFoundLostRatingListener()` Returns the `rating listener` previously set.
`protected com.highdeal.barbus.Topic`	`getRatingTopic()` Gets the `rating topic` of this client used to send rating messages.
`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).
`protected com.highdeal.barbus.Topic[]`	`getTopicsToSubscribe()` Returns an array of `topics` that client must subscribe to.
`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)`
`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`	`setSslContext(javax.net.ssl.SSLContext sslContext)` Sets the SSL context used with secure connections.
`StatelessPostRateResult`	`statelessPostRate(long reservationUID, StatelessPreRatingContext preRatingContext, int resolution, boolean withDetails, ChargeableItem newCi)` This method is dedicated to the stateless post-rating.
`StatelessPostRateResult`	`statelessPostRate(long reservationUID, StatelessPreRatingContext preRatingContext, int resolution, java.lang.String[] retainedDetails, ChargeableItem newCi)` Similar to `statelessPostRate(long, StatelessPreRatingContext, int, boolean, ChargeableItem)`, but with finest selection of resulting transaction details.
`StatelessPreRateResult`	`statelessPreRate(StatelessRatingEvent ratingEvent, java.lang.String chargeCode, StatelessPreRatingContext preRatingContext, java.util.Date ratingDate, long reservationUID, long postrateDeadline, boolean withDetails, boolean checkDates)` This method is dedicated to the stateless pre-rating.
`StatelessPreRateResult`	`statelessPreRate(StatelessRatingEvent ratingEvent, java.lang.String chargeCode, StatelessPreRatingContext preRatingContext, java.util.Date ratingDate, long reservationUID, long postrateDeadline, java.lang.String[] retainedDetails, boolean checkDates)` Similar to `statelessPreRate(StatelessRatingEvent, String, StatelessPreRatingContext, Date, long, long, boolean, boolean)`, but with finest selection of resulting transaction details.
`StatelessRateResult`	`statelessRate(java.lang.String chargeCode, java.util.Date ratingDate, StatelessRatingEvent event, StatelessRatingContext context, boolean withDetails, boolean checkDates)` This main business operation requests the SAP CC system to rate (dynamically determine the price)
`StatelessRateResult`	`statelessRate(java.lang.String chargeCode, java.util.Date ratingDate, StatelessRatingEvent event, StatelessRatingContext context, java.lang.String[] retainedDetails, boolean checkDates)` Similar to `statelessRate(String, Date, StatelessRatingEvent, StatelessRatingContext, boolean, boolean)`, but with finest selection of resulting transaction details.
`java.lang.Object[]`	`translate(java.lang.String tableCode, int operator, java.util.Date date, java.util.Date referenceDate, java.lang.String[] inValues)` Translates some values by using a translation table.
`java.lang.Object[]`	`translate(java.lang.String tableCode, int operator, java.util.Date date, java.lang.String[] inValues)` Translates some values by using an `instance of translation table`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

POST_RATE_CONFIRMATION

public static final int POST_RATE_CONFIRMATION

See Also:: Constant Field Values

POST_RATE_CANCELLATION

public static final int POST_RATE_CANCELLATION

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

StatelessServiceClient

public StatelessServiceClient()
                       throws java.io.IOException

Creates a non-initialized stateless service client in your client application.

One of the methods connect() must then be used to connect it to the SAP CC system.

Throws:: java.io.IOException - if an error occurred reading the currency resources.