JBoss.orgCommunity Documentation

Mobicents JAIN SLEE Diameter Rf Resource Adaptor User Guide


This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.

Mono-spaced Bold

Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:

The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.

Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:

The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.

If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in Mono-spaced Bold. For example:

Proportional Bold

This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:

The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.

Note the > shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select Mouse from the Preferences sub-menu in the System menu of the main menu bar' approach.

Mono-spaced Bold Italic or Proportional Bold Italic

Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:

Note the words in bold italics above username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.

Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:

If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in the the Issue Tracker, against the product Mobicents JAIN SLEE Diameter Rf Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_DIAMETER_RF_RA_User_Guide

If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.

This resource adaptor provides a Diameter API for JAIN SLEE applications, according to Rf inteface based on Diameter protocol.

Rf is one of two IMS reference point for charging. It covers offline charging - scenarios where charging information does not affect, in real-time, the service rendered.

Offline Charging occurs between two peers: the CTF (the online client, which issues request for accounting) and CDF (the server which performs accounting).

Two cases are currently distinguished for offline charging purposes:

For offline charging the Diameter Base Accounting defined in IETF RFC 3588 is used with additional AVPs defined. Also it reuses the FSM from Diameter Base Accounting.

Events are reused from Diameter Base Resource Adaptor and represent messages received by the Diameter stack. Different events types are specified for each Diameter request or answer. Events are fired either on client or server activities.

The Activities are defined by RA Type (and are an extension to Base Accounting Activities) to ease use of RA. Activities represent Diameter session between two peers. SLEE applications use activities to create, send and receive messages.

Diameter Rf Resource Adaptor Type is defined by Mobicents team as part of effort to standardize RA Types.

Diameter Rf Type 2.7.0.FINAL defines the following Activities:

net.java.slee.resource.diameter.rf.RfClientSession

This type of activity represents client side of Rf session. Accounting-Request (ACR) messages can be created and sent in this Activity, receiving the respective Answer (or timeout) later on this Activity.

This activity type can be created with call to the proper createRfClientSessionActivity method of net.java.slee.resource.diameter.rf.RfProvider. It ends once underlying Base Accounting session ends.

State machines for client Rf are based on Base Accounting client sessions which can be found at Section 8.2 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.rf.RfServerSession

This type of activity represents server side of Rf session. Accounting-Request (ACR) are received in this Activity and respective Answers are sent from it.

This activity type is implicitly created by the Resource Adaptor upon reception of the Accounting-Request message. It ends once underlying Base Accounting session ends.

State machines for client Rf are based on Base Accounting client sessions which can be found at Section 8.2 of Diameter Base Protocol RFC.

All activities define methods required to properly function and expose necessary information to JAIN SLEE services. Rf Server Activity is defined as follows:



    public AccountingAnswer createRfAccountingAnswer();
    public AccountingAnswer createRfAccountingAnswer(AccountingRequest acr);
    public void sendAccountingAnswer(AccountingAnswer accountingAnswer)
        throws IOException, IllegalArgumentException;
    
public AccountingAnswer createRfAccountingAnswer();

This method creates an Accounting-Answer with the Acct-Application-Id set to 3.

public AccountingAnswer createRfAccountingAnswer(AccountingRequest acr);

This method creates an Accounting-Answer with some AVPs populated from the provided Accounting-Request.

The ACA will contain the AVPs specified in createRfAccountingAnswer() and the following AVPs from the Accounting-Request:

  • Accounting-Record-Type
  • Accounting-Record-Number

public void sendAccountingAnswer(AccountingAnswer accountingAnswer) throws IOException, IllegalArgumentException;

This method sends an Accounting Answer.

Rf Client Activity is defined as follows:



        public void sendAccountingRequest(AccountingRequest accountingRequest)
            throws IOException, IllegalArgumentException;
    
public void sendAccountingRequest(AccountingRequest accountingRequest) throws IOException, IllegalArgumentException;

This method sends an Accounting Request.

Note

It is safe to type cast all the mentioned Diameter Activities to it's super interface net.java.slee.resource.diameter.base.DiameterActivity defined in Diameter Base Activities section.

The Mobicents Diameter Rf Resource Adaptor SBB Interface provides SBBs with access to the Diameter objects required for creating and sending messages. It is defined as follows:



    package net.java.slee.resource.diameter.rf;
    import java.io.IOException;
    import net.java.slee.resource.diameter.base.CreateActivityException;
    import net.java.slee.resource.diameter.base.events.AccountingAnswer;
    import net.java.slee.resource.diameter.base.events.AccountingRequest;
    import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
    public interface RfProvider {
        public RfMessageFactory getRfMessageFactory();
        public RfClientSession createRfClientSessionActivity() throws CreateActivityException;
        public RfClientSession createRfClientSessionActivity(DiameterIdentity destinationHost,
            DiameterIdentity destinationRealm) throws CreateActivityException;
        public AccountingAnswer sendAccountingRequest(AccountingRequest accountingRequest)
            throws IllegalArgumentException, IOException;
        DiameterIdentity[] getConnectedPeers();
        int getPeerCount();
    }
    

This RA uses the Mobicents Diameter Stack, an improvement over jDiameter Stack. The stack is the result of the work done by Mobicents Diameter and jDiameter development teams, and source code is provided in all releases.

There is a single Resource Adaptor Entity created when deploying the Resource Adaptor, named DiameterRf. The DiameterRf entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”.

The DiameterRf entity is also bound to Resource Adaptor Link Name DiameterRf, to use it in an Sbb add the following XML to its descriptor:



    <resource-adaptor-type-binding>
      <resource-adaptor-type-ref>
        <resource-adaptor-type-name>Diameter Rf</resource-adaptor-type-name>
        <resource-adaptor-type-vendor>java.net</resource-adaptor-type-vendor>
        <resource-adaptor-type-version>0.8.1</resource-adaptor-type-version>
      </resource-adaptor-type-ref>

      <activity-context-interface-factory-name>
        slee/resources/JDiameterRfResourceAdaptor/java.net/0.8.1/acif
      </activity-context-interface-factory-name>

      <resource-adaptor-entity-binding>
        <resource-adaptor-object-name>
            slee/resources/diameter-rf-ra-interface
        </resource-adaptor-object-name>
        <resource-adaptor-entity-link>DiameterRf</resource-adaptor-entity-link>
      </resource-adaptor-entity-binding>
    </resource-adaptor-type-binding>
    
    

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/diameter-rf, then add the specific release version, lets consider 2.7.0.FINAL.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/diameter-rf/2.7.0.FINAL slee-ra-diameter-rf-2.7.0.FINAL
  2. Building the source code

    Important

    Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at http://maven.apache.org

    Use Maven to build the deployable unit binary.

    				    [usr]$ cd slee-ra-diameter-rf-2.7.0.FINAL
    				    [usr]$ mvn install
    				    

    Once the process finishes you should have the deployable-unit jar file in the target directory, if Mobicents JAIN SLEE is installed and environment variable JBOSS_HOME is pointing to its underlying JBoss Application Server directory, then the deployable unit jar will also be deployed in the container.

Similar process as for Section 4.2.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/resources/diameter-rf.

Revision History
Revision 1.0Wed Feb 10 2010Alexandre Mendonça
Creation of the Mobicents JAIN SLEE Diameter Rf RA User Guide.