JBoss.orgCommunity Documentation

Chapter 2. Resource Adaptor Type

2.1. Activities
2.2. Events
2.3. Activity Context Interface Factory
2.4. Resource Adaptor Interface
2.5. Restrictions
2.6. Sbb Code Examples

Diameter Rx Resource Adaptor Type is defined by Mobicents team as part of effort to standardize RA Types.

Diameter Rx Type 1.0.0.BETA1 defines the following Activities:

net.java.slee.resource.diameter.rx.RxClientSessionActivity

This type of activity represents client side of Rx 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 createRxClientSessionActivity method of net.java.slee.resource.diameter.rx.RxProvider. It ends once underlying Rx 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.rx.RxServerSessionActivity

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



      public AAAnswer createAAAnswer();
      public void sendAAAnswer(AAAnswer aaa) throws IOException;
      public SessionTerminationAnswer createSessionTermAnswer();
      public void sendSessionTermAnswer(SessionTerminationAnswer sta) throws IOException;
      public void sendReAuthRequest(ReAuthRequest rar) throws IOException;
      public void sendAbortSessionRequest(AbortSessionRequest asr) throws IOException;  
    
public AAAnswer createAAAnswer();

This method creates a Rx-specific AA-Answer message pre-populated with the AVPs appropriate for this session taken from previously received session AA-Request.

public void sendAAAnswer(AAAnswer aaa) throws IOException;

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

public SessionTerminationAnswer createSessionTermAnswer();

This method creates a Rx-specific Session-Termination-Answer message pre-populated with the AVPs appropriate for this session taken from previously received session Session-Termination-Request.

public void sendSessionTermAnswer(SessionTerminationAnswer sta) throws IOException;

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

public void sendReAuthRequest(ReAuthRequest rar) throws IOException;

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

public void sendAbortSessionRequest(AbortSessionRequest asr) throws IOException;

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

Rx Client Activity is defined as follows:



      public AARequest createRxAARequest();
      public void sendRxAARequest(AARequest aar) throws IOException;
      public SessionTerminationRequest createSessionTermRequest();
      public void sendSessionTermRequest(SessionTerminationRequest str) throws IOException;
      public void sendReAuthAnswer(ReAuthAnswer raa) throws IOException;
      public void sendAbortSessionAnswer(AbortSessionAnswer asa) throws IOException;
    
public AARequest createRxAARequest();

Create a Rx-specific AA-Request message pre-populated with the AVPs appropriate for this session.

public void sendRxAARequest(AARequest aar) throws IOException;

Sends an AA-Request message to the peer.

public void sendReAuthAnswer(ReAuthAnswer raa) throws IOException;

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

public void sendSessionTermRequest(SessionTerminationRequest str) throws IOException;

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

public void sendAbortSessionAnswer(AbortSessionAnswer asa) throws IOException;

Sends a Abort-Session-Answer 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 Rx Resource Adaptor Type declares the Diameter Rx 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 JBoss Communications Diameter Rx Activity Context Interface Factory is defined as follows:



    package net.java.slee.resource.diameter.rx;
    import javax.slee.ActivityContextInterface;
    import javax.slee.UnrecognizedActivityException;
    public interface RxActivityContextInterfaceFactory {
        public ActivityContextInterface getActivityContextInterface(RxClientSessionActivity cSession)
            throws UnrecognizedActivityException;
        public ActivityContextInterface getActivityContextInterface(RxServerSessionActivity sSession)
            throws UnrecognizedActivityException;
    }
    

The JBoss Communications Diameter Rx 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.rx;
    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.rx.events.AAAnswer;
    import net.java.slee.resource.diameter.rx.events.AARequest;
    import net.java.slee.resource.diameter.rx.events.AbortSessionAnswer;
    import net.java.slee.resource.diameter.rx.events.AbortSessionRequest;
    import net.java.slee.resource.diameter.rx.events.ReAuthAnswer;
    import net.java.slee.resource.diameter.rx.events.ReAuthRequest;
    public interface RxProvider {
        public RxMessageFactory getRxMessageFactory();
        public RxAvpFactory getRxAvpFactory();
        public RxClientSessionActivity getActivityBySessionID(String sessionID);
        public RxClientSessionActivity createRxClientSessionActivity() throws CreateActivityException;
        public RxClientSessionActivity createRxClientSessionActivity(DiameterIdentity destinationHost, 
            DiameterIdentity destinationRealm) throws CreateActivityException;
        public AAAnswer sendAARequest(AARequest aar) throws IOException;
        public AbortSessionAnswer sendAbortSessionRequest(AbortSessionRequest asr)
            throws IOException;
        public ReAuthAnswer sendReAuthRequest(ReAuthRequest rar) throws IOException;
        DiameterIdentity[] getConnectedPeers();
        int getPeerCount();
        Validator getValidator();
    }
    

public RxMessageFactory getRxMessageFactory();

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

public RxAvpFactory getRxAvpFactory();

This method returns an avp factory to be used to create concrete implementations of Rx AVPs.

public RxClientSessionActivity getActivityBySessionID(String sessionID);

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

public RxClientSessionActivity createRxClientSessionActivity() throws CreateActivityException;

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

public RxClientSessionActivity createRxClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

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

public AAAnswer sendAARequest(AARequest 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 AbortSessionAnswer sendAbortSessionRequest(AbortSessionRequest 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 ReAuthAnswer sendReAuthRequest(ReAuthRequest 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.

Current Resource Adaptor Type has no defined restrictions.

TODO



    
    // TODO: Create Rx Authorization Client/Server Examples.