JBoss.orgCommunity Documentation

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

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

Diameter Sh-Server Type 2.7.0.FINAL defines the following Activities:

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



    public UserDataAnswer createUserDataAnswer(byte[] userData);
    public UserDataAnswer createUserDataAnswer(long resultCode, 
        boolean isExperimentalResult);
    public UserDataAnswer createUserDataAnswer();
    public ProfileUpdateAnswer createProfileUpdateAnswer(long resultCode, 
        boolean isExperimentalResult);
    public ProfileUpdateAnswer createProfileUpdateAnswer();
    public SubscribeNotificationsAnswer createSubscribeNotificationsAnswer();
    public SubscribeNotificationsAnswer createSubscribeNotificationsAnswer(long resultCode, 
        boolean isExperimentalResult);
    public void sendUserDataAnswer(UserDataAnswer message) throws IOException;
    public void sendProfileUpdateAnswer(ProfileUpdateAnswer message) throws IOException;
    public void sendSubscribeNotificationsAnswer(SubscribeNotificationsAnswer message)
        throws IOException;
    
public UserDataAnswer createUserDataAnswer(byte[] userData);

This method creates a UserDataAnswer using the given parameter to populate the User-Data AVP. The Result-Code AVP is automatically set to SUCCESS. If there is no request of this type received, this method returns null.

public UserDataAnswer createUserDataAnswer(long resultCode, boolean isExperimentalResult);

This method creates a UserDataAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set as ExperimentalResultAvp AVP, if it is false the result code will be set in a Result-Code AVP. If there is no request of this type received, this method returns null.

public UserDataAnswer createUserDataAnswer();

This method creates an empty UserDataAnswer that will need to have AVPs set on it before being sent.If there is no request of this type received, this method returns null.

public ProfileUpdateAnswer createProfileUpdateAnswer(long resultCode, boolean isExperimentalResult);

This method creates a ProfileUpdateAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If isExperimentalResultCode is true, the resultCode parameter will be set in a ExperimentalResultAvp AVP, if it is false the result code will be set in a Result-Code AVP.If there is no request of this type received, this method returns null.

public ProfileUpdateAnswer createProfileUpdateAnswer();

This method creates an empty ProfileUpdateAnswer that will need to have AVPs set on it before being sent.If there is no request of this type received, this method returns null.

public SubscribeNotificationsAnswer createSubscribeNotificationsAnswer();

This method creates an empty SubscribeNotificationsAnswer that will need to have AVPs set on it before being sent.If there is no request of this type received, this method returns null.

public SubscribeNotificationsAnswer createSubscribeNotificationsAnswer(long resultCode, boolean isExperimentalResult);

This method creates a SubscribeNotificationsAnswer containing a Result-Code or Experimental-Result AVP populated with the given value. If there is no request of this type received, this method returns null.

public void sendUserDataAnswer(UserDataAnswer message) throws IOException;

This method sends a UserDataAnswer to the peer that sent the UserDataRequest.

public void sendProfileUpdateAnswer(ProfileUpdateAnswer message) throws IOException;

This method sends a ProfileUpdateAnswer to the peer that sent the ProfileUpdateRequest.

public void sendSubscribeNotificationsAnswer(SubscribeNotificationsAnswer message) throws IOException;

This method sends a SubscribeNotificationsAnswer to the peer that sent the SubscribeNotificationsRequest.

Sh Server Notification Activity is defined as follows:



    public ShServerMessageFactory getServerMessageFactory();
    public void sendPushNotificationRequest(PushNotificationRequest message)
        throws IOException;
    

The Mobicents Diameter Sh-Server 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.sh.server;
    import java.io.IOException;
    import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
    import net.java.slee.resource.diameter.sh.DiameterShAvpFactory;
    import net.java.slee.resource.diameter.sh.events.PushNotificationAnswer;
    import net.java.slee.resource.diameter.sh.events.PushNotificationRequest;
    public interface ShServerProvider {
        public ShServerMessageFactory getServerMessageFactory();
        public DiameterShAvpFactory getServerAvpFactory();
        public ShServerNotificationActivity createShServerNotificationActivity()
            throws CreateActivityException;
        public PushNotificationAnswer pushNotificationRequest(PushNotificationRequest message)
            throws IOException;
        public DiameterIdentity[] getConnectedPeers();
        public int getPeerCount();
    }
    

Simple Server-Side Example that receives an User-Data-Request and sends an User-Data-Answer.



    /* Method for receiving UDR and sending UDA with SUCCESS (code 2001) Result-Code. */
    public void onUserDataRequest(UserDataRequest event, ActivityContextInterface aci) {
        if (tracer.isInfoEnabled()) {
            tracer.info("Received UDR:\r\n" + event);
        }
        
        UserDataAnswer answer = ((ShServerActivity) aci.getActivity()).
            createUserDataAnswer(2001, false);
        try {
            if (tracer.isInfoEnabled()) {
                tracer.info("Created UDA:\r\n" + answer);
            }
            ((ShServerActivity) aci.getActivity()).sendUserDataAnswer(answer);
        }
        catch (IOException e) {
            tracer.severe("Failed to send UDA.", e);
        }
    }
    

Simple Server-Side Example that sends an Push-Notification-Request and receives an Push-Notification-Answer.



    /* Method for handling timer event where a PNR created and sent */
    public void onTimerEvent(TimerEvent event, ActivityContextInterface aci) {
        ShServerNotificationActivity activity = null;
        for (ActivityContextInterface _aci : this.getSbbContext().getActivities()) {
            if (_aci.getActivity() instanceof ShServerNotificationActivity) {
                activity = (ShServerNotificationActivity) _aci.getActivity();
                break;
            }
        }
        if (activity == null) {
            tracer.severe("Activity is null, with list: " + Arrays.toString(this.getSbbContext().
                getActivities()));
            return;
        }
        PushNotificationRequest request = activity.createPushNotificationRequest();
        tracer.info("Created PNR:\r\n" + request);
        try {
            UserIdentityAvp ui = avpFactory.createUserIdentity();
            ui.setPublicIdentity("sip:user@diameter.mobicents.org");
            request.setUserIdentity(ui);
            request.setUserData("<xml>Some secrete user xml</xml>");
            if(tracer.isInfoEnabled()) {
                tracer.info("Sending PNR:\r\n" + request);
            }
            activity.sendPushNotificationRequest(request);
        }
        catch (Exception e) {
            tracer.severe("Failed to send PNR.", e);
        }
    }
    
    ...
    
    /* Method for handling PNA messages. Just print the Result-Code AVP. */
    public void onPushNotificationAnswer(PushNotificationAnswer pna, 
        ActivityContextInterface aci) {
        if (tracer.isInfoEnabled()) {
            tracer.info("Push-Notification-Answer received. Result-Code[" + pna.getResultCode() + "].");
        }
    }
    

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

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

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

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