JBoss.orgCommunity Documentation

Mobicents JAIN SLEE Diameter Ro 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 Ro Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_DIAMETER_RO_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.

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

Diameter Ro Type 2.7.0.FINAL defines the following Activities:

net.java.slee.resource.diameter.ro.RoClientSession

This type of activity represents client side of Ro session. Credit-Control-Request (CCR) 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 createRoClientSessionActivity method of net.java.slee.resource.diameter.ro.RoProvider. It ends once underlying Credit Control session ends.

State machine for client Credit Control sessions can be found at Section 7 of Diameter Credit Control Application RFC.

net.java.slee.resource.diameter.ro.RoServerSession

This type of activity represents server side of Ro session. Credit-Control-Request (CCR) 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 Credit-Control-Request message. It ends once underlying Credit Control session ends.

State machine for client Credit Control sessions can be found at Section 7 of Diameter Credit Control Application RFC.

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



    public public CreditControlAnswer createRoCreditControlAnswer();
    public void sendCreditControlAnswer(CreditControlAnswer cca) throws IOException;
    
public CreditControlAnswer createRoCreditControlAnswer();

This method creates a Ro-specific Credit-Control-Answer message pre-populated with the AVPs appropriate for this session.

public void sendCreditControlAnswer(CreditControlAnswer cca) throws IOException;

This method sends a Credit-Control-Answer message to the peer.

Ro Client Activity is defined as follows:



    public void sendEventCreditControlRequest(CreditControlRequest ccr)
        throws IOException;
    public void sendInitialCreditControlRequest(CreditControlRequest ccr)
        throws IOException;
    public void sendUpdateCreditControlRequest(CreditControlRequest ccr)
        throws IOException;
    public void sendTerminationCreditControlRequest(CreditControlRequest ccr)
        throws IOException;
    
public void sendEventCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends an event Credit-Control-Request.

public void sendInitialCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends an initial Credit-Control-Request.

public void sendUpdateCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends an update (intermediate) Credit-Control-Request.

public void sendTerminationCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends a termination Credit-Control-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 Ro 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.ro;
    import java.io.IOException;
    import net.java.slee.resource.diameter.base.CreateActivityException;
    import net.java.slee.resource.diameter.base.events.avp.AvpNotAllowedException;
    import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
    import net.java.slee.resource.diameter.cca.events.CreditControlAnswer;
    import net.java.slee.resource.diameter.cca.events.CreditControlRequest;
    public interface RoProvider {
        public RoMessageFactory getRoMessageFactory();
        public RoAvpFactory getRoAvpFactory();
        public RoClientSessionActivity createRoClientSessionActivity()
            throws CreateActivityException;
        public RoClientSessionActivity createRoClientSessionActivity(
            DiameterIdentity destinationHost, DiameterIdentity destinationRealm)
                throws CreateActivityException;
        public CreditControlAnswer eventCreditControlRequest(CreditControlRequest ccr)
            throws IOException;
        public CreditControlAnswer initialCreditControlRequest(CreditControlRequest ccr)
            throws IOException;
        public CreditControlAnswer updateCreditControlRequest(CreditControlRequest ccr)
            throws IOException, IllegalArgumentException;
        public CreditControlAnswer terminationCreditControlRequest(CreditControlRequest ccr)
            throws IOException, IllegalArgumentException;
        public byte[] marshalRoCreditControlRequest(CreditControlRequest ccr);
        public byte[] marshalRoCreditControlAnswer(CreditControlAnswer cca);
        public CreditControlRequest unmarshalRoCreditControlRequest(byte[] b)
            throws IOException, AvpNotAllowedException;
        public CreditControlAnswer unmarshalRoCreditControlAnswer(byte[] b)
            throws IOException, AvpNotAllowedException;
        public DiameterIdentity[] getConnectedPeers();
        public int getPeerCount();
    }
    

public RoMessageFactory getRoMessageFactory();

This method returns a message factory to be used to create concrete implementations of credit control messages.

public RoAvpFactory getRoAvpFactory();

This method returns an avp factory to be used to create concrete implementations of credit control AVPs.

public RoClientSessionActivity createRoClientSessionActivity() throws CreateActivityException;

This method creates a new activity to send and receive Diameter messages.

public RoClientSessionActivity createRoClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

This method creates a new activity to send and receive Diameter messages.

public CreditControlAnswer eventCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends a Credit-Control-Request message to the appropriate peers, and block until the response is received then return it.

public CreditControlAnswer initialCreditControlRequest(CreditControlRequest ccr) throws IOException;

This method sends an initial Credit-Control-Request that will start a credit control session, and block until the answer is received.

public CreditControlAnswer updateCreditControlRequest(CreditControlRequest ccr) throws IOException, IllegalArgumentException;

This method sends an update (intermediate) Credit-Control-Request and block until the answer is received.

public CreditControlAnswer terminationCreditControlRequest(CreditControlRequest ccr) throws IOException, IllegalArgumentException;

This method sends a termination Credit-Control-Request and block until the answer is received.

public byte[] marshalRoCreditControlRequest(CreditControlRequest ccr);

This method marshals a Credit-Control-Request into a byte array that can be serialized (e.g., stored in a CMP field).

public byte[] marshalRoCreditControlAnswer(CreditControlAnswer cca);

This method marshals a Credit-Control-Answer into a byte array that can be serialized (e.g., stored in a CMP field).

public CreditControlRequest unmarshalRoCreditControlRequest(byte[] b) throws IOException, AvpNotAllowedException;

This method unmarshals a Credit-Control-Request from a byte array.

public CreditControlAnswer unmarshalRoCreditControlAnswer(byte[] b) throws IOException, AvpNotAllowedException;

This method unmarshals a Credit-Control-Answer from a byte array.

public DiameterIdentity[] getConnectedPeers();

This method returns the identities of peers this Diameter resource adaptor is connected to.

public int getPeerCount();

This method returns the number of peers this Diameter resource adaptor is connected to.

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 DiameterRo. The DiameterRo entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”.

The DiameterRo entity is also bound to Resource Adaptor Link Name DiameterRo, 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 Ro</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/JDiameterRoResourceAdaptor/java.net/0.8.1/acif
      </activity-context-interface-factory-name>

      <resource-adaptor-entity-binding>
        <resource-adaptor-object-name>
            slee/resources/diameter-ro-ra-interface
        </resource-adaptor-object-name>
        <resource-adaptor-entity-link>DiameterRo</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-ro, 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-ro/2.7.0.FINAL slee-ra-diameter-ro-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-ro-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-ro.

Revision History
Revision 1.0Tue Feb 09 2010Alexandre Mendonça
Creation of the Mobicents JAIN SLEE Diameter Ro RA User Guide.