com.ibm.diameter.rf
Interface DiameterRfService_SEI

All Superinterfaces:
java.rmi.Remote

public interface DiameterRfService_SEI
extends java.rmi.Remote

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


Method Summary
 ACAResults eventOfflineAccounting(java.lang.String sessionId, int recordNumber, java.lang.String userName, int acctInterimInterval, java.lang.String destinationRealm, long eventTimestamp, int originStateID, Accounting act)
          Deprecated. As of release 6.2, replaced by eventfAccounting
 RfAccountingResults eventRfAccounting(RfAccountingInfo rfAcctInfo)
          Sends an event accounting offline charging message.
 ACAResults interimOfflineAccounting(java.lang.String sessionId, int recordNumber, java.lang.String userName, int acctInterimInterval, java.lang.String destinationRealm, long eventTimestamp, int originStateID, Accounting act)
          Deprecated. As of release 6.2, replaced by interimRfAccounting
 RfAccountingResults interimRfAccounting(RfAccountingInfo rfAcctInfo)
          Sends an interim accounting offline charging message.
 Avp[] rawAccounting(Avp[] avp)
          Sends a raw Diameter message via the Rf interface.
 ACAResults startOfflineAccounting(java.lang.String sessionId, int recordNumber, java.lang.String userName, int acctInterimInterval, java.lang.String destinationRealm, long eventTimestamp, int originStateID, Accounting act)
          Deprecated. As of release 6.2, replaced by startRfAccounting
 RfAccountingResults startRfAccounting(RfAccountingInfo rfAcctInfo)
          Starts an accounting offline charging session.
 ACAResults stopOfflineAccounting(java.lang.String sessionId, int recordNumber, java.lang.String userName, int acctInterimInterval, java.lang.String destinationRealm, long eventTimestamp, int originStateID, Accounting act)
          Deprecated. As of release 6.2, replaced by stopRfAccounting
 RfAccountingResults stopRfAccounting(RfAccountingInfo rfAcctInfo)
          Stops an accounting offline charging session.
 

Method Detail

startOfflineAccounting

ACAResults startOfflineAccounting(java.lang.String sessionId,
                                  int recordNumber,
                                  java.lang.String userName,
                                  int acctInterimInterval,
                                  java.lang.String destinationRealm,
                                  long eventTimestamp,
                                  int originStateID,
                                  Accounting act)
                                  throws java.rmi.RemoteException
Deprecated. As of release 6.2, replaced by startRfAccounting

Starts an accounting offline charging session.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
recordNumber - Uniquely identifies the record within an accounting session.
userName - Holds the private user identity, if available in the node.
acctInterimInterval - Indicates the type of charging record, and tracks iterative increasing message numbers.
destinationRealm - FQDN, realm of the destination Diameter node which handles the request.
eventTimestamp - Holds the event value for the time the recorded event occured.
originStateID - This value is used by some Diameter accounting clients.
act - Contains typical information for a 3GPP charging Diameter ACR message.
Returns:
ACAResults Contains information from the ACA Diameter Return message.
Throws:
java.rmi.RemoteException

stopOfflineAccounting

ACAResults stopOfflineAccounting(java.lang.String sessionId,
                                 int recordNumber,
                                 java.lang.String userName,
                                 int acctInterimInterval,
                                 java.lang.String destinationRealm,
                                 long eventTimestamp,
                                 int originStateID,
                                 Accounting act)
                                 throws java.rmi.RemoteException
Deprecated. As of release 6.2, replaced by stopRfAccounting

Stops an accounting offline charging session.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
recordNumber - Uniquely identifies the record within an accounting session.
userName - Holds the private user identity, if available in the node.
acctInterimInterval - Indicates the type of charging record, and tracks iterative increasing message numbers.
destinationRealm - FQDN, realm of the destination Diameter node which handles the request.
eventTimestamp - Holds the event value for the time the recorded event occured.
originStateID - This value is used by some Diameter accounting clients.
act - Contains typical information for a 3GPP charging Diameter ACR message.
Returns:
ACAResults Contains information from the ACA Diameter Return message.
Throws:
java.rmi.RemoteException

interimOfflineAccounting

ACAResults interimOfflineAccounting(java.lang.String sessionId,
                                    int recordNumber,
                                    java.lang.String userName,
                                    int acctInterimInterval,
                                    java.lang.String destinationRealm,
                                    long eventTimestamp,
                                    int originStateID,
                                    Accounting act)
                                    throws java.rmi.RemoteException
Deprecated. As of release 6.2, replaced by interimRfAccounting

Sends an interim accounting offline charging session.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
recordNumber - Uniquely identifies the record within an accounting session.
userName - Holds the private user identity, if available in the node.
acctInterimInterval - Indicates the type of charging record, and tracks iterative increasing message numbers.
destinationRealm - FQDN, realm of the destination Diameter node which handles the request.
eventTimestamp - Holds the event value for the time the recorded event occured.
originStateID - This value is used by some Diameter accounting clients.
act - Contains typical information for a 3GPP charging Diameter ACR message.
Returns:
ACAResults Contains information from the ACA Diameter Return message.
Throws:
java.rmi.RemoteException

eventOfflineAccounting

ACAResults eventOfflineAccounting(java.lang.String sessionId,
                                  int recordNumber,
                                  java.lang.String userName,
                                  int acctInterimInterval,
                                  java.lang.String destinationRealm,
                                  long eventTimestamp,
                                  int originStateID,
                                  Accounting act)
                                  throws java.rmi.RemoteException
Deprecated. As of release 6.2, replaced by eventfAccounting

Sends an event accounting offline charging session.

Parameters:
sessionId - Used to specify a specific user session. It must follow the format defined in RFC 3588.
recordNumber - Uniquely identifies the record within an accounting session.
userName - Holds the private user identity, if available in the node.
acctInterimInterval - Indicates the type of charging record, and tracks iterative increasing message numbers.
destinationRealm - FQDN, realm of the destination Diameter node which handles the request.
eventTimestamp - Holds the event value for the time the recorded event occured.
originStateID - This value is used by some Diameter accounting clients.
act - Contains typical information for a 3GPP charging Diameter ACR message.
Returns:
ACAResults Contains information from the ACA Diameter Return message.
Throws:
java.rmi.RemoteException

startRfAccounting

RfAccountingResults startRfAccounting(RfAccountingInfo rfAcctInfo)
                                      throws java.rmi.RemoteException
Starts an accounting offline charging session.

Parameters:
RfAccounting - Contains information to generate the ACR request message.
Returns:
RfAccountingResults Contains information from the ACA Diameter return message.
Throws:
java.rmi.RemoteException

stopRfAccounting

RfAccountingResults stopRfAccounting(RfAccountingInfo rfAcctInfo)
                                     throws java.rmi.RemoteException
Stops an accounting offline charging session.

Parameters:
RfAccounting - Contains information to generate the ACR request message.
Returns:
RfAccountingResults Contains information from the ACA Diameter return message.
Throws:
java.rmi.RemoteException

interimRfAccounting

RfAccountingResults interimRfAccounting(RfAccountingInfo rfAcctInfo)
                                        throws java.rmi.RemoteException
Sends an interim accounting offline charging message.

Parameters:
RfAccounting - Contains information to generate the ACR request message.
Returns:
RfAccountingResults Contains information from the ACA Diameter return message.
Throws:
java.rmi.RemoteException

eventRfAccounting

RfAccountingResults eventRfAccounting(RfAccountingInfo rfAcctInfo)
                                      throws java.rmi.RemoteException
Sends an event accounting offline charging message.

Parameters:
RfAccounting - Contains information to generate the ACR request message.
Returns:
RfAccountingResults Contains information from the ACA Diameter return message.
Throws:
java.rmi.RemoteException

rawAccounting

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.