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 Gq Resource Adaptor Type is defined by Mobicents team as part of effort to standardize RA Types.

Diameter Gq Type 1.1.0-SNAPSHOT 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 JBoss Communications Diameter Gq Activity Context Interface Factory is defined as follows:



    package net.java.slee.resource.diameter.gq;
    import javax.slee.ActivityContextInterface;
    import javax.slee.UnrecognizedActivityException;
    public interface GqActivityContextInterfaceFactory {
        public ActivityContextInterface getActivityContextInterface(GqClientSessionActivity cSession)
            throws UnrecognizedActivityException;
        public ActivityContextInterface getActivityContextInterface(GqServerSessionActivity sSession)
            throws UnrecognizedActivityException;
    }
    

The JBoss Communications 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.

Current Resource Adaptor Type has no defined restrictions.

TODO



    // TODO: Create GqAuthorization Client/Server Examples.