com.ibm.diameter.ro
Interface DiameterRoService_SEI

All Superinterfaces:
java.rmi.Remote

public interface DiameterRoService_SEI
extends java.rmi.Remote

The Ro accounting Web service is a component of the WebSphere Diameter Enabler base that serves as the interface between an IMS Application Server and an OCS where transactions are processed. The Ro Web service provides a set of operations to perform real time online charging. The collection of methods also includes a "raw" method to send custom online session requests that require more knowlege of the underlying protocol.


Method Summary
 RoChargingResults getCCServicePriceEnquiry(RoChargingInfo roChargingInfo)
          This request is used by the OCT (Online Charging Trigger) to query the OCF (Online Charging Function) for the price of an event service.
 RoChargingResults sendCCDirectDebit(RoChargingInfo roChargingInfo)
          This request is used by the OCT (Online Charging Trigger) to place an immediate charge against the subscriber’s account.
 RoChargingResults sendCCInitial(RoChargingInfo roChargingInfo)
          This request is used to initialize a session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function).
 Avp[] sendCCRaw(Avp[] avp)
          Sends a raw Diameter message via the Ro interface.
 RoChargingResults sendCCRefund(RoChargingInfo roChargingInfo)
          This request is used by the OCT (Online Charging Trigger) to place an immediate refund to the subscriber’s account.
 RoChargingResults sendCCTermination(RoChargingInfo roChargingInfo)
          This request is used to terminate the session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function).
 RoChargingResults sendCCUpdate(RoChargingInfo roChargingInfo)
          This request is used to update the session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function).
 void subscribeCCReAuth(java.lang.String sessionId, java.lang.String destinationRealm, java.net.URI callbackUri, int subscriptionDuration, java.lang.String userid, java.lang.String password)
          This request is used by the CTF (Charging Trigger Function) IMS application to register to receive Re-Auth notifications if they become available.
 void unsubscribeCCReAuth(java.lang.String sessionId, java.lang.String destinationRealm, java.net.URI callbackUri, java.lang.String userid, java.lang.String password)
          This request is used by the CTF (Charging Trigger Function) IMS application to unregister its subscription to receive Re-Auth notifications for a specific Session ID and Destination Realm.
 

Method Detail

sendCCInitial

RoChargingResults sendCCInitial(RoChargingInfo roChargingInfo)
                                throws java.rmi.RemoteException
This request is used to initialize a session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function). This operation is used to request an initial reservation of quota. A Diameter CCR is sent to the OCF with CC-Request-Type set to a value of INITIAL_REQUEST. The OCF will reply either granting or denying the quota.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

sendCCUpdate

RoChargingResults sendCCUpdate(RoChargingInfo roChargingInfo)
                               throws java.rmi.RemoteException
This request is used to update the session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function). This operation is used to inform the OCF of the amount of quota that has been used. This request also specifies a request for additional quota to continue providing the service. A Diameter CCR is sent to the OCF with CC-Request-Type set to a value of UPDATE_REQUEST. The OCF will reply either granting or denying the quota.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

sendCCTermination

RoChargingResults sendCCTermination(RoChargingInfo roChargingInfo)
                                    throws java.rmi.RemoteException
This request is used to terminate the session between the OCT (Online Charging Trigger) and the OCF (Online Charging Function). This operation is used to inform the OCF of the amount of quota that has been used. A Diameter CCR is sent to the OCS with CC-Request-Type set to a value of TERMINATION_REQUEST. The OCF will reply to acknowledge closure of the session.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

sendCCDirectDebit

RoChargingResults sendCCDirectDebit(RoChargingInfo roChargingInfo)
                                    throws java.rmi.RemoteException
This request is used by the OCT (Online Charging Trigger) to place an immediate charge against the subscriber’s account. A Diameter CCR is sent to the OCS with CC-Request-Type set to a value of EVENT_REQUEST and Requested-Action set to a value of DIRECT_DEBIT. The OCF (Online Charging Function) deducts the amount of quota requested from the subscriber’s account and returns the acknowledgement in the GrantedServiceUnits.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

sendCCRefund

RoChargingResults sendCCRefund(RoChargingInfo roChargingInfo)
                               throws java.rmi.RemoteException
This request is used by the OCT (Online Charging Trigger) to place an immediate refund to the subscriber’s account. A Diameter CCR is sent to the OCF with CC-Request-Type set to a value of EVENT_REQUEST and Requested-Action set to a value of REFUND_ACCOUNT. The OCF (Online Charging Function) adds the amount of quota requested to the subscriber’s account and returns the acknowledgement in the GrantedServiceUnits.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

getCCServicePriceEnquiry

RoChargingResults getCCServicePriceEnquiry(RoChargingInfo roChargingInfo)
                                           throws java.rmi.RemoteException
This request is used by the OCT (Online Charging Trigger) to query the OCF (Online Charging Function) for the price of an event service. A Diameter CCR is sent to the OCS with CC-Request-Type set to a value of EVENT_REQUEST and Requested-Action set to a value of PRICE_ENQUIRY. An example of an event service would be to download a ring tone or MP3 file. The OCT specifies the service in the Service-Identifier and the OCS responds back with the estimated cost of the service.

Parameters:
roChargingInfo - Simple representation of the content that can be sent in a Diameter CCR.
Returns:
roChargingResults Simple representation of the content returned in a Diameter CCA.
Throws:
java.rmi.RemoteException

subscribeCCReAuth

void subscribeCCReAuth(java.lang.String sessionId,
                       java.lang.String destinationRealm,
                       java.net.URI callbackUri,
                       int subscriptionDuration,
                       java.lang.String userid,
                       java.lang.String password)
                       throws java.rmi.RemoteException
This request is used by the CTF (Charging Trigger Function) IMS application to register to receive Re-Auth notifications if they become available. The Session ID and Destination Realm are used to uniquely identify the subscription. When a Re-Auth request is received by the Diameter Enabler that matches the Session ID and Destination Realm, the Re-Auth information is passed to the IMS application using the notifyCCReAuth() Web service request to the URI specified. All subscriptions will age over time. If the subscription ages for a period longer than the subscriptionDuration period, it will be removed from the subscription table. A notification will be made to the provided URI that this subscription has expired. Note that the subscription should be made prior to the actual start of the Credit Control Session to avoid losing any Re-Auth messages.

Parameters:
sessionId - String holding the sessionId that the reAuth may apply to. Care must be used to make sure that there are no duplicate sessionIds. If there is a match, the subscription will fail with an exception. It must follow the format defined in RFC 3588.
destinationRealm - String holding the realm where the Credit Control server is being accessed.
callbackUri - URI that specifies the web service endpoint to receive Re-Auth notifications.
subscriptionDuration - An int that contains the number of seconds that the subscription will be valid for. Minimum subscriptionDuration: 30 seconds. Maximum subscriptionDuration: 32,000,000 (1 yr).
userid - Userid used to access the Ro application client's Notify Web service. If this is null, this and the password are ignored
password - Password used to access the Ro applications client's Web service. If this is null, this and the userid are ignored.
Throws:
java.rmi.RemoteException

unsubscribeCCReAuth

void unsubscribeCCReAuth(java.lang.String sessionId,
                         java.lang.String destinationRealm,
                         java.net.URI callbackUri,
                         java.lang.String userid,
                         java.lang.String password)
                         throws java.rmi.RemoteException
This request is used by the CTF (Charging Trigger Function) IMS application to unregister its subscription to receive Re-Auth notifications for a specific Session ID and Destination Realm. The Session ID and Destination Realm must match exactly the same values used in the original subscription.

Parameters:
sessionId - String holding the sessionId that the reAuth applies to. It must follow the format defined in RFC 3588.
destinationRealm - String holding the realm where the Credit Control server is being accessed.
callbackUri - URI that specifies the web service endpoint to receive Re-Auth notifications.
userid - String containing the userid for security on the callback request.
password - String containing the password for security on the callback request.
Throws:
java.rmi.RemoteException

sendCCRaw

Avp[] sendCCRaw(Avp[] avp)
                throws java.rmi.RemoteException
Sends a raw Diameter message via the Ro interface.

Parameters:
avp - represents the Avps defined in Credit-Control-Request (CCR) command. The Avps are created based on the Diameter base APIs.
Returns:
An array of Avps which represents the AVPs defined in Credit-Control-Answer (CCA) command.
Throws:
java.rmi.RemoteException


Copyright © 2006 IBM Corp. All Rights Reserved.