JBoss.orgCommunity Documentation

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

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

Diameter Cx/Dx Type 2.7.0.FINAL defines the following Activities:

net.java.slee.resource.diameter.cxdx.CxDxClientSessionActivity

This type of activity represents client side of Cx/Dx session. User-Authorization-Request (UAR), Server-Assignment-Request (SAR), Location-Info-Request (LIR) and Multimedia-Authentication-Request (MAR) messages can be created and sent in this Activity, receiving the respective Answer (or timeout) later on this Activity. Registration-Termination-Request (RTR) and Push-Profile-Request (PPR) messages are received in this Activity and respective Answers are sent from it.

This activity type is implicitly created when receiving Requests or can be created with call to the proper createCxDxClientSessionActivity method of net.java.slee.resource.diameter.cxdx.CxDxProvider for sending Requests. It ends once underlying Cx/Dx session ends.

net.java.slee.resource.diameter.cxdx.CxDxServerSessionActivity

This type of activity represents server side of Cx/Dx session. Registration-Termination-Request (RTR) and Push-Profile-Request (PPR) messages can be created and sent in this Activity, receiving the respective Answer (or timeout) later on this Activity. User-Authorization-Request (UAR), Server-Assignment-Request (SAR), Location-Info-Request (LIR) and Multimedia-Authentication-Request (MAR) messages are received in this Activity and respective Answers are sent from it.

This activity type is implicitly created when receiving Requests or can be created with call to the proper createCxDxServerSessionActivity method of net.java.slee.resource.diameter.cxdx.CxDxProvider for sending Requests. It ends once underlying Cx/Dx session ends.

All activities define methods required to properly function and expose necessary information to JAIN SLEE services. Common part for both Client and Server Activity is defined as follows:



    public String getSessionId();
    public CxDxAVPFactory getCxDxAvpFactory();
    public CxDxMessageFactory getCxDxMessageFactory();
    

Cx/Dx Client Activity is defined as follows:



    public UserAuthorizationRequest createUserAuthorizationRequest();
    public void sendUserAuthorizationRequest(
        UserAuthorizationRequest userAuthorizationRequest)
            throws IOException;
    public ServerAssignmentRequest createServerAssignmentRequest();
    public void sendServerAssignmentRequest(
        ServerAssignmentRequest serverAssignmentRequest)
            throws IOException;
    public LocationInfoRequest createLocationInfoRequest();
    public void sendLocationInfoRequest(LocationInfoRequest locationInfoRequest)
        throws IOException;
    public MultimediaAuthenticationRequest createMultimediaAuthenticationRequest();
    public void sendMultimediaAuthenticationRequest(
        MultimediaAuthenticationRequest multimediaAuthenticationRequest) throws IOException;
    public RegistrationTerminationAnswer createRegistrationTerminationAnswer();
    public void sendRegistrationTerminationAnswer(
        RegistrationTerminationAnswer registrationTerminationAnswer) throws IOException;
    public PushProfileAnswer createPushProfileAnswer();
    public void sendPushProfileAnswer(PushProfileAnswer pushProfileAnswer)
        throws IOException;
    
public UserAuthorizationRequest createUserAuthorizationRequest();

This method creates a User-Authorization-Request message pre-populated with the AVPs appropriate for this session.

public void sendUserAuthorizationRequest(UserAuthorizationRequest userAuthorizationRequest) throws IOException;

This method sends an event User-Authorization-Request. An event containing the answer will be fired on this activity.

public ServerAssignmentRequest createServerAssignmentRequest();

This method creates a ServerAssignmentRequest message pre-populated with the AVPs appropriate for this session.

public void sendServerAssignmentRequest(ServerAssignmentRequest serverAssignmentRequest) throws IOException;

This method sends an event Server-Assignment-Request. An event containing the answer will be fired on this activity.

public LocationInfoRequest createLocationInfoRequest();

This method creates a LocationInfoRequest message pre-populated with the AVPs appropriate for this session.

public void sendLocationInfoRequest(LocationInfoRequest locationInfoRequest) throws IOException;

This method sends an event Location-Info-Request. An event containing the answer will be fired on this activity.

public MultimediaAuthenticationRequest createMultimediaAuthenticationRequest();

This method creates a MultimediaAuthenticationRequest message pre-populated with the AVPs appropriate for this session.

public void sendMultimediaAuthenticationRequest(MultimediaAuthenticationRequest multimediaAuthenticationRequest) throws IOException;

This method sends an event Multimedia-Authentication-Request. An event containing the answer will be fired on this activity.

public RegistrationTerminationAnswer createRegistrationTerminationAnswer();

This method creates a RegistrationTerminationAnswer message pre-populated with the AVPs appropriate for this session.

public void sendRegistrationTerminationAnswer(RegistrationTerminationAnswer registrationTerminationAnswer) throws IOException;

This method sends an event Registration-Termination-Answer. An event containing the answer will be fired on this activity.

public void sendRegistrationTerminationAnswer(RegistrationTerminationAnswer registrationTerminationAnswer) throws IOException;

This method creates a Registration-Termination-Answer populated with the AVPs appropriate for this session.

public void sendPushProfileAnswer(PushProfileAnswer pushProfileAnswer) throws IOException;

This method sends an event Push-Profile-Answer in response to a Push-Profile-Request received on this activity.

Cx/Dx Server Activity is defined as follows:



    public UserAuthorizationAnswer createUserAuthorizationAnswer();
    public void sendUserAuthorizationAnswer(
        UserAuthorizationAnswer userAuthorizationAnswer)
            throws IOException;
    public ServerAssignmentAnswer createServerAssignmentAnswer();
    public void sendServerAssignmentAnswer(
        ServerAssignmentAnswer serverAssignmentAnswer)
            throws IOException;
    public LocationInfoAnswer createLocationInfoAnswer();
    public void sendLocationInfoAnswer(LocationInfoAnswer locationInfoAnswer)
        throws IOException;
    public MultimediaAuthenticationAnswer createMultimediaAuthenticationAnswer();
    public void sendMultimediaAuthenticationAnswer(
        MultimediaAuthenticationAnswer multimediaAuthenticationAnswer) throws IOException;
    public RegistrationTerminationRequest createRegistrationTerminationRequest();
    public void sendRegistrationTerminationRequest(
        RegistrationTerminationRequest registrationTerminationRequest) throws IOException;
    public PushProfileRequest createPushProfileRequest();
    public void sendPushProfileRequest(PushProfileRequest pushProfileRequest)
        throws IOException;
    
public UserAuthorizationAnswer createUserAuthorizationAnswer();

This method creates a User-Authorization-Answer message pre-populated with the AVPs appropriate for this session.

public void sendUserAuthorizationAnswer(UserAuthorizationAnswer userAuthorizationAnswer) throws IOException;

This method sends an event User-Authorization-Answer in response to a User-Authorization-Request received on this activity.

public ServerAssignmentAnswer createServerAssignmentAnswer();

This method creates a ServerAssignmentAnswer message pre-populated with the AVPs appropriate for this session.

public void sendServerAssignmentAnswer(ServerAssignmentAnswer serverAssignmentAnswer) throws IOException;

This method sends an event Server-Assignment-Answer in response to a Server-Assignment-Request received on this activity.

public LocationInfoAnswer createLocationInfoAnswer();

This method creates a LocationInfoAnswer message pre-populated with the AVPs appropriate for this session.

public void sendLocationInfoAnswer(LocationInfoAnswer locationInfoAnswer) throws IOException;

This method sends an event Location-Info-Answer in response to a Location-Info-Request received on this activity.

public MultimediaAuthenticationAnswer createMultimediaAuthenticationAnswer();

This method creates a MultimediaAuthenticationAnswer message pre-populated with the AVPs appropriate for this session.

public void sendMultimediaAuthenticationAnswer(MultimediaAuthenticationAnswer multimediaAuthenticationAnswer) throws IOException;

This method sends an event Multimedia-Authentication-Answer in response to a Multimedia-Authentication-Request received on this activity.

public RegistrationTerminationRequest createRegistrationTerminationRequest();

This method creates a RegistrationTerminationRequest message pre-populated with the AVPs appropriate for this session.

public void sendRegistrationTerminationRequest(RegistrationTerminationRequest registrationTerminationRequest) throws IOException;

This method sends an event Registration-Termination-Request. An event containing the answer will be fired on this activity.

public PushProfileRequest createPushProfileRequest();

This method creates a Push-Profile-Request pre-populated with the AVPs appropriate for this session.

public void sendPushProfileRequest(PushProfileRequest pushProfileRequest) throws IOException;

This method sends an event Push-Profile-Request. An event containing the answer will be fired on this activity.

Diameter Cx/Dx Resource Adaptor Type declares all the Diameter Cx/Dx Application 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 Cx/Dx 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.cxdx;
    import net.java.slee.resource.diameter.base.CreateActivityException;
    import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
    public interface CxDxProvider {
        public CxDxMessageFactory getCxDxMessageFactory();
        public CxDxAVPFactory getCxDxAVPFactory();
        public CxDxClientSessionActivity createCxDxClientSessionActivity()
            throws CreateActivityException;
        public CxDxClientSessionActivity createCxDxClientSessionActivity(
            DiameterIdentity destinationHost, DiameterIdentity destinationRealm)
                throws CreateActivityException;
        public CxDxServerSessionActivity createCxDxServerSessionActivity()
            throws CreateActivityException;
        public CxDxServerSessionActivity createCxDxServerSessionActivity(
            DiameterIdentity destinationHost, DiameterIdentity destinationRealm)
                throws CreateActivityException;
        public DiameterIdentity[] getConnectedPeers();
        public int getPeerCount();
    }
    

public CxDxMessageFactory getCxDxMessageFactory();

This method returns a message factory to be used to create concrete implementations of Cx/Dx messages.

public CxDxAVPFactory getCxDxAVPFactory();

This method returns a AVP factory to be used to create concrete implementations of Cx/Dx AVPs.

public CxDxClientSessionActivity createCxDxClientSessionActivity()throws CreateActivityException;

This method creates a new client session to send and receive Diameter messages. All messages sent on an activity created by this method must contain valid routing AVPs (one or both of Destination-Realm and Destination-Host as defined by RFC3588).

public CxDxClientSessionActivity createCxDxClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

This method creates a new client session to send and receive Diameter messages. Messages sent on an activity created by this method will automatically have the Destination-Host and Destination-Realm AVPs set to the provided values.

public CxDxServerSessionActivity createCxDxServerSessionActivity()throws CreateActivityException;

This method creates a new server session to send and receive Diameter messages. All messages sent on an activity created by this method must contain valid routing AVPs (one or both of Destination-Realm and Destination-Host as defined by RFC3588).

public CxDxServerSessionActivity createCxDxServerSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

This method creates a new server session to send and receive Diameter messages. Messages sent on an activity created by this method will automatically have the Destination-Host and Destination-Realm AVPs set to the provided values.

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.

Example SBB code to handle communication with HSS look as follows:



    public void onTimerEvent(TimerEvent event, ActivityContextInterface aci) {
        
        tracer.info("Diameter Cx/Dx example: Acting as client(ICSCF after REGISTER)");
        this.timerFacility.cancelTimer(event.getTimerID());
        // We are client - ICSCF, we get REGISTER from UE, instead of this timer methods
        // we should be in onRegister handler.
        DiameterIdentity destinationHost = new DiameterIdentity("aaa://" + 
            getProperty("destination.ip") + ":" + getProperty("destination.port"));
        DiameterIdentity destinationRealm = 
            new DiameterIdentity((String)getProperty("destination.realm"));
        CxDxClientSession clientSession;
        
        try {
            clientSession = this.provider.createCxDxClientSessionActivity(destinationHost,
                destinationRealm);
        
            ActivityContextInterface clientACI=this.acif.getActivityContextInterface(clientSession);
            clientACI.attach(this.sbbContext.getSbbLocalObject());
        
            UserAuthorizationRequest UAR = clientSession.createUserAuthorizationRequest();
            // < User-Authorization-Request> ::= < Diameter Header: 300, REQ, PXY, 16777216 >
            //          < Session-Id >
            //          { Vendor-Specific-Application-Id }
            //          { Auth-Session-State }
            UAR.setAuthSessionState(AuthSessionStateType.STATE_MAINTAINED);
            //          { Origin-Host }
            //          { Origin-Realm }
            //          [ Destination-Host ]
            //          { Destination-Realm }
            //          { User-Name }
            UAR.setUserName("adam.b");
            //          *[ Supported-Features ]
            //          { Public-Identity }
            UAR.setPublicIdentity("sip:adam.b@travel.contanct.com");
            //          { Visited-Network-Identifier }
            UAR.setVisitedNetworkIdentifier("visit.airport.moscow.ru");
            //          [ User-Authorization-Type ]
            UAR.setUserAuthorizationType(UserAuthorizationType.DE_REGISTRATION);
            //          [ UAR-Flags ]
        
            //          *[ AVP ]
            //          *[ Proxy-Info ]
            //          *[ Route-Record ]   
        
            // Send the message
            tracer.info("Diameter Cx/Dx example: Sending UAR:\n"+UAR);
            clientSession.sendUserAuthorizationRequest(UAR);
            tracer.info("Diameter Cx/Dx example: Sent UAR:\n"+UAR);
        }
        catch (CreateActivityException e) {
            tracer.severe("Unable to create Cx/Dx Client Session Activity.", e);
        }
        catch (IOException e) {
            tracer.severe("Failed to send Cx/Dx User-Authorization-Request.", e);
        }
    }
    
    ...
    
    public void onUserAuthorizationAnswer(UserAuthorizationAnswer event, 
        ActivityContextInterface aci) {
        tracer.info("Diameter Cx/Dx example: receveid UAA:\n"+event);
        
        if(event.getResultCode() / 1000 != 2) {
            tracer.info("Diameter Cx/Dx example: receveid UAA with wrong result code:\n" + 
                event.getResultCode());
            return;
        }
        
        tracer.info("Diameter Cx/Dx example: Acting as SCSCF after receiving REGISTER from ICSCF");
        // HSS responded to our call, here we would forward REGISTER to S-CSCF, 
        // however lets not do that, its easier to set up it like that
        // lets act as S-CSCF, which received REGISTER and sends SAR
        try{
            //Detach, this will die
            aci.detach(this.sbbContext.getSbbLocalObject());
            DiameterIdentity destinationHost = new DiameterIdentity("aaa://" + 
                getProperty("destination.ip") + ":" + getProperty("destination.port"));
            DiameterIdentity destinationRealm = 
                new DiameterIdentity((String)getProperty("destination.realm"));
            
            //create SAR/SAA activity
            CxDxClientSession clientSession = this.provider.
                createCxDxClientSessionActivity(destinationHost, destinationRealm);
            ActivityContextInterface clientACI = this.acif.
                getActivityContextInterface(clientSession);
            clientACI.attach(this.sbbContext.getSbbLocalObject());
            ServerAssignmentRequest SAR = clientSession.createServerAssignmentRequest();
            // <Server-Assignment-Request> ::= < Diameter Header: 301, REQ, PXY, 16777216 >
            //      < Session-Id >
            //      { Vendor-Specific-Application-Id }
            //      { Auth-Session-State }
            SAR.setAuthSessionState(AuthSessionStateType.STATE_MAINTAINED);
            //      { Origin-Host }
            //      { Origin-Realm }
            //      [ Destination-Host ]
            //      { Destination-Realm }
            //      [ User-Name ]
            SAR.setUserName("adam.b");
            //      *[ Supported-Features ]
            //      *[ Public-Identity ]
            SAR.setPublicIdentity("sip:adam.b@travel.contanct.com");
            //      [ Wildcarded-PSI ]
            //      [ Wildcarded-IMPU ]
            //      { Server-Name }
            SAR.setServerName("x123.s.cscf.local.domain.org");
            //      { Server-Assignment-Type }
            SAR.setServerAssignmentType(ServerAssignmentType.USER_DEREGISTRATION);
            //      { User-Data-Already-Available }
            SAR.setUserDataAlreadyAvailable(
                UserDataAlreadyAvailable.USER_DATA_NOT_AVAILABLE);
            //      [ SCSCF-Restoration-Info ]
            //      [ Multiple-Registration-Indication ]
            //      *[ AVP ]
            //      *[ Proxy-Info ]
            //      *[ Route-Record ]
        
            // Send the SAR.
            tracer.info("Diameter Cx/Dx example: Sending SAR:\n"+SAR);
            clientSession.sendServerAssignmentRequest(SAR);
            tracer.info("Diameter Cx/Dx example: Sent SAR:\n"+SAR);
        }
        catch (CreateActivityException e) {
            tracer.severe("Unable to create Cx/Dx Client Session Activity.", e);
        }
        catch (IOException e) {
            tracer.severe("Failed to send Cx/Dx User-Authorization-Request.", e);
        }
    }
    

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

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

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

Revision History
Revision 1.0Wed Feb 10 2010Alexandre Mendonça
Creation of the Mobicents JAIN SLEE Diameter Cx/Dx RA User Guide.