JBoss.orgCommunity Documentation

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

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

Diameter Sh-Client 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 Client Activity is defined as follows:



    void sendUserDataRequest(UserDataRequest message) throws IOException;
    void sendSubscribeNotificationsRequest(SubscribeNotificationsRequest message) 
        throws IOException; 
    void sendProfileUpdateRequest(ProfileUpdateRequest message) throws IOException;
    

Sh Client Subscription Activity is defined as follows:



    ShClientMessageFactory getClientMessageFactory();
    void sendSubscribeNotificationsRequest(SubscribeNotificationsRequest request)
        throws IOException;
    void sendUnsubscribeRequest() throws IOException;
    PushNotificationAnswer createPushNotificationAnswer();
    void sendPushNotificationAnswer(PushNotificationAnswer answer) throws IOException;
    void sendPushNotificationAnswer(long resultCode,boolean isExperimentalResultCode)
        throws IOException;
    PushNotificationAnswer createPushNotificationAnswer(long resultCode,
        boolean isExperimaental);
    UserIdentityAvp getSubscribedUserIdentity();
    
ShClientMessageFactory getClientMessageFactory();

This method returns a 'customized' message factory to manually create Sh Client Messages for this Activity.

void sendSubscribeNotificationsRequest(SubscribeNotificationsRequest request) throws IOException;

This method sends a Subscribe-Notifications-Request message.

void sendUnsubscribeRequest() throws IOException;

This method send a Subscribe-Notifications-Request message containing the AVPs required to UNSUBSCRIBE from the user that this activity represents a subscription to.

PushNotificationAnswer createPushNotificationAnswer();

This method creates Push-Notification-Answer for received Push-Notification-Request. It returns null if a Push-Notification-Request has not been received.

void sendPushNotificationAnswer(PushNotificationAnswer answer) throws IOException;

This method sends a manually-constructed Push-Notification-Answer to the peer that sent the Push-Notification-Request.

void sendPushNotificationAnswer(long resultCode,boolean isExperimentalResultCode) throws IOException;

This is a convenience method to create and send a Push-Notification-Answer containing a Result-Code or Experimental-Result AVP populated with the given value.

PushNotificationAnswer createPushNotificationAnswer(long resultCode, boolean isExperimaental);

This method creates Push-Notification-Answer for received Push-Notification-Request, with the specified Result-Code. It returns null if a Push-Notification-Request has not been received.

UserIdentityAvp getSubscribedUserIdentity();

This method returns the User-Identity for the subscription in the HSS represented by this activity.

The Mobicents Diameter Sh-Client 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.client;
    import java.io.IOException;
    import net.java.slee.resource.diameter.base.CreateActivityException;
    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.ProfileUpdateAnswer;
    import net.java.slee.resource.diameter.sh.events.ProfileUpdateRequest;
    import net.java.slee.resource.diameter.sh.events.SubscribeNotificationsAnswer;
    import net.java.slee.resource.diameter.sh.events.SubscribeNotificationsRequest;
    import net.java.slee.resource.diameter.sh.events.UserDataAnswer;
    import net.java.slee.resource.diameter.sh.events.UserDataRequest;
    public interface ShClientProvider {
        public ShClientMessageFactory getClientMessageFactory();
        public DiameterShAvpFactory getClientAvpFactory();
        public ShClientActivity createShClientActivity() throws CreateActivityException;
        public ShClientSubscriptionActivity createShClientSubscriptionActivity()
            throws CreateActivityException;
        public UserDataAnswer userDataRequest(UserDataRequest message) throws IOException;
        public ProfileUpdateAnswer profileUpdateRequest(ProfileUpdateRequest message)
            throws IOException;
        public SubscribeNotificationsAnswer subscribeNotificationsRequest(
            SubscribeNotificationsRequest message) throws IOException;
        public DiameterIdentity[] getConnectedPeers();
        public int getPeerCount();
    }
    

public ShClientMessageFactory getClientMessageFactory();

This method returns a ShClientMessageFactory implementation to be used to create DiameterMessage objects.

public DiameterShAvpFactory getClientAvpFactory();

This method returns a DiameterShAvpFactory implementation to be used to create DiameterAvp objects.

public ShClientActivity createShClientActivity() throws CreateActivityException;

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

public ShClientSubscriptionActivity createShClientSubscriptionActivity() throws CreateActivityException;

This method creates a new Sh Client Subscription activity to send and receive Diameter Sh subscription related messages.

public UserDataAnswer userDataRequest(UserDataRequest message) throws IOException;

This method sends a synchronous UserDataRequest which will block until an answer is received from the peer.

public ProfileUpdateAnswer profileUpdateRequest(ProfileUpdateRequest message) throws IOException;

This method sends a synchronous ProfileUpdateRequest which will block until an answer is received from the peer.

public SubscribeNotificationsAnswer subscribeNotificationsRequest(SubscribeNotificationsRequest message) throws IOException;

This method sends a synchronous SubscribeNotificationsRequest which will block until an answer is received from the peer.

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.

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



    /* Method for creating and sending UDR with pre-defined values. */
    private void doSimpleTestsSendUDR() {
        try {
            ShClientActivity basicClientActivity = this.provider.createShClientActivity();
            
            ActivityContextInterface localACI = acif.getActivityContextInterface(basicClientActivity);
            logger.info(" On TimerEvent: ACI created for basicClientActivity");
            
            localACI.attach(getSbbContext().getSbbLocalObject());
            DiameterIdentity[] peers = provider.getConnectedPeers();
            
            UserDataRequest udr = ((ShClientMessageFactory)basicClientActivity.
                getDiameterMessageFactory()).createUserDataRequest();
            
            List<DiameterAvp> avps = new ArrayList<DiameterAvp>();
            avps.add(avpFactory.getBaseFactory().createAvp(Avp.DESTINATION_HOST, ("aaa://" + 
                destinationIP + ":" + destinationPort).getBytes() ));
            avps.add(avpFactory.getBaseFactory().createAvp(Avp.DESTINATION_REALM,
                destinationRealm.getBytes()));
            UserIdentityAvp ui=avpFactory.createUserIdentity();
            ui.setPublicIdentity("sip:subscriber@mobicents.org");
              
            avps.add(ui);
            
            udr.setExtensionAvps(avps.toArray(new DiameterAvp[avps.size()]));
            udr.setAuthSessionState(AuthSessionStateType.STATE_MAINTAINED);
            udr.setDataReference(DataReferenceType.IMS_PUBLIC_IDENTITY);
            basicClientActivity.sendUserDataRequest(udr);
        }
        catch (Exception e) {
          tracer.error("Failure trying to create/send UDR.", e);
        }
    }
    
    ...
    
    /* Method for handling ACA messages. Just print the Result-Code AVP. */
    public void onUserDataRequestAnswer(UserDataAnswer uda, ActivityContextInterface aci)
        if (tracer.isInfoEnabled()) {
            tracer.info("User-Data-Answer received. Result-Code[" + uda.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 DiameterShClient. The DiameterShClient entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”.

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

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

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