JBoss.orgCommunity Documentation

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

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

Diameter Gq Type 1.0.0.BETA2 defines the following Activities:

net.java.slee.resource.diameter.gq.GqClientSessionActivity

This type of activity represents client side of Gq' session. Abort-Session-Request (ASR) and Re-Auth-Request (RAR) messages are received in this Activity and respective Answers are sent from it. AA-Request (AAR) and Session-Termination-Request (STR) 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 createGqClientSessionActivity method of net.java.slee.resource.diameter.gq.GqProvider. It ends once underlying Gq' session ends.

State machine for client Authorization sessions can be found at Section 8.1 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.gq.GqServerSessionActivity

This type of activity represents server side of Gq' session. AA-Request (AAR) and Session-Termination-Request (STR) messages are received in this Activity and respective Answers are sent from it. Abort-Session-Request (ASR) and Re-Auth-Request (RAR) messages can be created and sent in this Activity, receiving the respective Answer (or timeout) later on this Activity.

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

State machine for server Authorization sessions can be found at Section 8.1 of Diameter Base Protocol RFC.

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



    public GqAAAnswer createGqAAAnswer(GqAARequest aar);
    public void sendGqAAAnswer(GqAAAnswer aaa) throws IOException;
    public GqSessionTerminationAnswer createGqSessionTerminationAnswer(
        GqSessionTerminationRequest str);
    public void sendGqSessionTerminationAnswer(GqSessionTerminationAnswer sta)
        throws IOException;
    public void sendReAuthRequest(GqReAuthRequest rar) throws IOException;
    public void sendAbortSessionRequest(GqAbortSessionRequest asr) throws IOException;
    
public GqAAAnswer createGqAAAnswer(GqAARequest aar);

This method creates a Gq'-specific AA-Answer message pre-populated with the AVPs appropriate for this session and/or taken from the provided request.

public void sendGqAAAnswer(GqAAAnswer aaa) throws IOException;

This method sends a AA-Answer message to the peer.

public GqSessionTerminationAnswer createGqSessionTerminationAnswer(GqSessionTerminationRequest str);

This method creates a Gq'-specific Session-Termination-Answer message pre-populated with the AVPs appropriate for this session and/or taken from the provided request.

public void sendGqSessionTerminationAnswer(GqSessionTerminationAnswer sta) throws IOException;

This method sends a Session-Termination-Answer message to the peer.

public void sendReAuthRequest(GqReAuthRequest rar) throws java.io.IOException;

This method sends a Gq'-specific Re-Auth-Request message to the peer.

public void sendAbortSessionRequest(GqAbortSessionRequest asr) throws java.io.IOException;

This method sends a Gq'-specific Abort-Session-Request message to the peer.

Gq' Client Activity is defined as follows:



    public void sendGqAARequest(GqAARequest aar) throws IOException;
    public GqReAuthAnswer createGqReAuthAnswer(GqReAuthRequest rar);
    public void sendGqReAuthAnswer(GqReAuthAnswer raa) throws IOException;
    public GqAbortSessionAnswer createGqAbortSessionAnswer(GqAbortSessionRequest asr);
    public void sendGqAbortSessionAnswer(GqAbortSessionAnswer asa) throws IOException;
    public void sendGqSessionTerminationRequest(GqSessionTerminationRequest str) 
        throws IOException;
    
public void sendGqAARequest(GqAARequest aar) throws IOException;

Sends an AA-Request message to the peer.

public GqReAuthAnswer createGqReAuthAnswer(GqReAuthRequest rar);

Create a Gq'-specific Re-Auth-Answer message pre-populated with the AVPs appropriate for this session and/or taken from the provided request.

public void sendGqReAuthAnswer(GqReAuthAnswer raa) throws IOException;

Sends a Re-Auth-Answer message to the peer.

public GqAbortSessionAnswer createGqAbortSessionAnswer(GqAbortSessionRequest asr);

Create a Gq'-specific Abort-Session-Answer message pre-populated with the AVPs appropriate for this session.

public void sendGqAbortSessionAnswer(GqAbortSessionAnswer asa) throws IOException;

Sends a Abort-Session-Answer message to the peer.

public void sendGqSessionTerminationRequest(GqSessionTerminationRequest str) throws IOException;

Sends a Gq'-specific Session-Termination-Request message to the peer.

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.

Diameter Gq Resource Adaptor Type declares the Diameter Gq' Interface specific events.

The following tables shows which events are fired on each activity.



Important

Spaces where introduced in Name and Event Class column values, to correctly render the table. Please remove them when using copy/paste.

The Mobicents Diameter Gq 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.gq;
    import java.io.IOException;
    import net.java.slee.resource.diameter.Validator;
    import net.java.slee.resource.diameter.base.CreateActivityException;
    import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
    import net.java.slee.resource.diameter.gq.events.GqAAAnswer;
    import net.java.slee.resource.diameter.gq.events.GqAARequest;
    import net.java.slee.resource.diameter.gq.events.GqAbortSessionAnswer;
    import net.java.slee.resource.diameter.gq.events.GqAbortSessionRequest;
    import net.java.slee.resource.diameter.gq.events.GqReAuthAnswer;
    import net.java.slee.resource.diameter.gq.events.GqReAuthRequest;
    public interface GqProvider {
        public GqMessageFactory getGqMessageFactory();
        public GqAvpFactory getGqAvpFactory();
        public GqClientSessionActivity getActivityBySessionID(String sessionID);
        public GqClientSessionActivity createGqClientSessionActivity() throws CreateActivityException;
        public GqClientSessionActivity createGqClientSessionActivity(DiameterIdentity destinationHost, 
            DiameterIdentity destinationRealm) throws CreateActivityException;
        public GqAAAnswer sendGqAARequest(GqAARequest aar) throws IOException;
        public GqAbortSessionAnswer sendGqAbortSessionRequest(GqAbortSessionRequest asr)
            throws IOException;
        public GqReAuthAnswer sendGqReAuthRequest(GqReAuthRequest rar) throws IOException;
        DiameterIdentity[] getConnectedPeers();
        int getPeerCount();
        Validator getValidator();
    }
    

public GqMessageFactory getGqMessageFactory();

This method returns a message factory to be used to create concrete implementations of Gq' messages.

public GqAvpFactory getGqAvpFactory();

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

public GqClientSessionActivity getActivityBySessionID(String sessionID);

This method returns an exisitng Gq' activity by it's Session-Id attribute and null if it doesn't exist.

public GqClientSessionActivity createGqClientSessionActivity() throws CreateActivityException;

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

public GqClientSessionActivity createGqClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

This method creates a new activity to send and receive Diameter Gq' messages for the given host and/or realm.

public GqAAAnswer sendGqAARequest(GqAARequest aar) throws IOException;

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

public GqAbortSessionAnswer sendGqAbortSessionRequest(GqAbortSessionRequest asr) throws IOException;

This method sends an Abort-Session-Request message to the appropriate peers, and block until the response is received then return it.

public GqReAuthAnswer sendGqReAuthRequest(GqReAuthRequest rar) throws IOException;

This method sends an Re-Auth-Request message to the appropriate peers, and block until the response is received then return it.

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.

public Validator getValidator();

This method returns the Diameter Message and AVP validator instance.

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

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

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

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/diameter-gq/1.0.0.BETA2 slee-ra-diameter-gq-1.0.0.BETA2
  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-gq-1.0.0.BETA2
    				    [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-gq.

Revision History
Revision 1.0Mon Aug 15 2011Alexandre Mendonça
Creation of the Mobicents JAIN SLEE Diameter Gq RA User Guide.