JBoss.orgCommunity Documentation

JBoss Communications JAIN SLEE Diameter Gx 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 JBoss Communications JAIN SLEE Diameter Gx Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_DIAMETER_GX_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 Gx Resource Adaptor Type is defined by Mobicents team as part of effort to standardize RA Types.

Diameter Gx Type 1.0.0.CR1 defines the following Activities:

net.java.slee.resource.diameter.gx.GxClientSessionActivity

This type of activity represents client side of Gx 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 createGxClientSessionActivity method of net.java.slee.resource.diameter.gx.GxProvider. 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.gx.GxServerSessionActivity

This type of activity represents server side of Gx 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. Gx Server Activity is defined as follows:



    public public GxCreditControlAnswer createGxCreditControlAnswer();
    public void sendCreditControlAnswer(GxCreditControlAnswer cca) throws IOException;
    
public GxCreditControlAnswer createGxCreditControlAnswer();

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

public void sendCreditControlAnswer(GxCreditControlAnswer cca) throws IOException;

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

Gx Client Activity is defined as follows:



    public void sendEventGxCreditControlRequest(GxCreditControlRequest ccr)
        throws IOException;
    public void sendInitialGxCreditControlRequest(GxCreditControlRequest ccr)
        throws IOException;
    public void sendUpdateGxCreditControlRequest(GxCreditControlRequest ccr)
        throws IOException;
    public void sendTerminationGxCreditControlRequest(GxCreditControlRequest ccr)
        throws IOException;
    
public void sendEventGxCreditControlRequest(GxCreditControlRequest ccr) throws IOException;

This method sends an event Credit-Control-Request.

public void sendInitialGxCreditControlRequest(GxCreditControlRequest ccr) throws IOException;

This method sends an initial Credit-Control-Request.

public void sendUpdateGxCreditControlRequest(GxCreditControlRequest ccr) throws IOException;

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

public void sendTerminationGxCreditControlRequest(GxCreditControlRequest 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 JBoss Communications Diameter Gx 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.gx;
    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.gx.events.GxCreditControlAnswer;
    import net.java.slee.resource.diameter.gx.events.GxCreditControlRequest;
    public interface GxProvider {
        public GxMessageFactory getGxMessageFactory();
        public GxAvpFactory getGxAvpFactory();
        public GxClientSessionActivity createGxClientSessionActivity()
            throws CreateActivityException;
        public GxClientSessionActivity createGxClientSessionActivity(
            DiameterIdentity destinationHost, DiameterIdentity destinationRealm)
                throws CreateActivityException;
        public GxCreditControlAnswer sendGxCreditControlRequest(GxCreditControlRequest ccr)
            throws IOException;
        public DiameterIdentity[] getConnectedPeers();
        public int getPeerCount();
        public Validator getValidator();
    }
    

This RA uses the JBoss Communications Diameter Stack, an improvement over jDiameter Stack. The stack is the result of the work done by JBoss Communications 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 DiameterGx. The DiameterGx entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”.

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

      <resource-adaptor-entity-binding>
        <resource-adaptor-object-name>
            slee/resources/diameter-gx-ra-interface
        </resource-adaptor-object-name>
        <resource-adaptor-entity-link>DiameterGx</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 ?, then add the specific release version, lets consider 1.0.0.CR1.

    [usr]$ svn co ?/1.0.0.CR1 slee-ra-diameter-gx-1.0.0.CR1
  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-gx-1.0.0.CR1
    				    [usr]$ mvn install
    				    

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

Revision History
Revision 1.0Tue Dec 21 2010Alexandre Mendonça
Creation of the JBoss Communications JAIN SLEE Diameter Gx RA User Guide.