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

Diameter Base Type 2.6.1.FINAL defines the following Activities:

net.java.slee.resource.diameter.base.AuthClientSessionActivity

This type of activity represents client side of Base Authentication session. Abort-Session-Request (ASR) and Re-Auth-Request (RAR) messages are received in this Activity and respective Answers are sent from it. Session-Termination-Request (STR) 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 appropriate createAuthenticationClientSessionActivity method of net.java.slee.resource.diameter.base.DiameterProvider. It ends once underlying Base Authentication session ends.

State machine for client Base Authorization sessions can be found at Section 8.1 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.base.AuthServerSessionActivity

This type of activity represents server side of Base Authentication session. 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) 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 appropriate createAuthenticationServerSessionActivity method of net.java.slee.resource.diameter.base.DiameterProvider. It ends once underlying Base Authentication session ends.

State machine for client Base Authorization sessions can be found at Section 8.1 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.base.AccountingClientSessionActivity

This type of activity represents client side of Base Accounting session. Accounting-Request (ACR) 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 appropriate createAccountingClientSessionActivity method of net.java.slee.resource.diameter.base.DiameterProvider. It ends once underlying Base Accounting session ends.

State machine for client Base Accounting sessions can be found at Section 8.2 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.base.AccountingServerSessionActivity

This type of activity represents server side of Base Accounting session. Accounting-Request (ACR) messages are received in this Activity and respective Answers are sent from it.

This activity type is created explicitly for incoming requests by Resource Adaptor. It ends once underlying Base Accounting session ends, either by timeout or proper answer delivery.

State machine for server Base Accounting can be found at Section 8.2 of Diameter Base Protocol RFC.

net.java.slee.resource.diameter.base.DiameterActvity

This type of activity represents a generic Diameter session and it's the super type for all other Diameter Activities. It can be used as an extension point for Diameter Applications.

This activity type is created explicitly for unknown (not defined in other Activities) incoming requests by Resource Adaptor or by calling the appropriate createActivity method of net.java.slee.resource.diameter.base.DiameterProvider. It ends once underlying session ends, either by timeout or proper answer delivery.

All activities define methods required to properly function and expose necessary information to JAIN SLEE services. Common part for all Diameter Activities is defined as follows:



    DiameterMessageFactory getDiameterMessageFactory();
    DiameterAvpFactory getDiameterAvpFactory();
    void sendMessage(DiameterMessage message) throws IOException;
    String getSessionId();
    void endActivity();
    
DiameterMessageFactory getDiameterMessageFactory();

Returns message factory capable of creating Diameter Base or other (extension) messages.

DiameterAvpFactory getDiameterAvpFactory();

Returns AVP factory capable of creating Diameter Base or other (extension) AVPs.

void sendMessage(DiameterMessage message) throws IOException;

Provides means to send generic Diameter messages.

String getSessionId();

Returns Session ID of underlying Diameter session.

void endActivity();

Terminates underlying session.

Common part for Authentication Activities is defined as follows:



    AuthSessionState getSessionState();
    
AuthSessionState getSessionState();

Return current Auth session state. It can have values as follows:

  • IDLE

  • PENDING

  • OPEN

  • DISCONNECTED

DISCONNECTED value implies that activity is ending.

Client part for Authentication Activities is defined as follows:



    AbortSessionAnswer createAbortSessionAnswer();
    AbortSessionAnswer createAbortSessionAnswer(AbortSessionRequest abortSessionRequest);
    void sendAbortSessionAnswer(AbortSessionAnswer abortSessionAnswer)
        throws IOException, IllegalArgumentException;
    ReAuthAnswer createReAuthAnswer();
    ReAuthAnswer createReAuthAnswer(ReAuthRequest reAuthRequest);
    void sendReAuthAnswer(ReAuthAnswer reAuthAnswer)
        throws IOException, IllegalArgumentException;
    SessionTerminationRequest createSessionTerminationRequest(
        TerminationCauseType terminationCause);
    void sendSessionTerminationRequest(
        SessionTerminationRequest sessionTerminationRequest)
            throws IOException, IllegalArgumentException;
    
AbortSessionAnswer createAbortSessionAnswer();

Create an empty Abort-Session-Answer with the Auth-Application-Id set to 0.

AbortSessionAnswer createAbortSessionAnswer(AbortSessionRequest abortSessionRequest);

Create an Abort-Session-Answer with some AVPs populated from the provided Abort-Session-Request.

void sendAbortSessionAnswer(AbortSessionAnswer abortSessionAnswer) throws IOException, IllegalArgumentException;

Send an Abort-Session-Answer.

ReAuthAnswer createReAuthAnswer();

Create an empty Re-Auth-Answer with the Auth-Application-Id set to 0.

ReAuthAnswer createReAuthAnswer(ReAuthRequest reAuthRequest);

Create an Re-Auth-Answer with some AVPs populated from the provided Re-Auth-Request.

void sendReAuthAnswer(ReAuthAnswer reAuthAnswer) throws IOException, IllegalArgumentException;

Send an Re-Auth-Answer.

SessionTerminationRequest createSessionTerminationRequest(TerminationCauseType terminationCause);

Create an Session-Termination-Request message populated with the following AVPs:

  • Termination-Cause: as per terminationCause parameter
  • Auth-Application-Id: the value 0 as specified by RFC3588

void sendSessionTerminationRequest(SessionTerminationRequest sessionTerminationRequest) throws IOException, IllegalArgumentException;

Send an Session Termination Request. An event containing the answer will be fired on this activity.

Server part for Authentication Activities is defined as follows:



    AbortSessionRequest createAbortSessionRequest();
    void sendAbortSessionRequest(AbortSessionRequest request) throws IOException;
    ReAuthRequest createReAuthRequest(ReAuthRequestType reAuthRequestType);
    void sendReAuthRequest(ReAuthRequest request) throws IOException;
    SessionTerminationAnswer createSessionTerminationAnswer();
    SessionTerminationAnswer createSessionTerminationAnswer(
        SessionTerminationRequest sessionTerminationRequest);
    void sendSessionTerminationAnswer(SessionTerminationAnswer request)
        throws IOException;
    
AbortSessionRequest createAbortSessionRequest();

Create an Abort-Session-Request message populated with the following AVPs:

  • Auth-Application-Id: the value 0 as specified by RFC3588

void sendAbortSessionRequest(AbortSessionRequest request) throws IOException;

Send session abort session request to client

ReAuthRequest createReAuthRequest(ReAuthRequestType reAuthRequestType);

Create an Re-Auth-Request message populated with the following AVPs:

  • Auth-Application-Id: the value 0 as specified by RFC3588
  • Re-Auth-Request-Type: as per reAuthRequestType parameter

void sendReAuthRequest(ReAuthRequest request) throws IOException;

Send Re-Auth-Request.

SessionTerminationAnswer createSessionTerminationAnswer();

Create an Session-Termination-Answer with the Auth-Application-Id set to 0.

SessionTerminationAnswer createSessionTerminationAnswer(SessionTerminationRequest sessionTerminationRequest);

Create an Session-Termination-Answer with some AVPs populated from the provided Session-Termination-Request.

void sendSessionTerminationAnswer(SessionTerminationAnswer request) throws IOException;

Send session termination answer to client.

Common part for Accounting Activities is defined as follows:



    AccountingSessionState getAccountingSessionState();
    
AccountingSessionState getAccountingSessionState();

Returns current Accounting session state of underlying session. Valid values are:

  • Idle

  • PendingS

  • PendingE

  • PendingB

  • Open

  • PendingI

  • PendingL

Client part for Accounting Activities is defined as follows:



    AccountingRequest createAccountingRequest(AccountingRecordType accountingRecordType);
    
    void sendAccountRequest(AccountingRequest accountingRequest)
        throws IOException, IllegalArgumentException;
    
AccountingRequest createAccountingRequest(AccountingRecordType accountingRecordType);

Create an Accounting-Request message populated with the following AVPs:

  • Accounting-Record-Type: as per accountingRecordType parameter
  • Acct-Application-Id: the value 3 as specified by RFC3588

void sendAccountRequest(AccountingRequest accountingRequest) throws IOException, IllegalArgumentException;

Send an Accounting Request. An event containing the answer or timeout will be fired on this activity.

Server part for Accounting Activities is defined as follows:



    AccountingAnswer createAccountingAnswer();
    AccountingAnswer createAccountingAnswer(AccountingRequest acr);
    void sendAccountingAnswer(AccountingAnswer aca)
        throws IOException, IllegalArgumentException;
    
AccountingAnswer createAccountingAnswer();

Create an Accounting-Answer with the Acct-Application-Id set to 3.

AccountingAnswer createAccountingAnswer(AccountingRequest acr);

Create an Accounting-Answer with some AVPs populated from the provided Accounting-Request. The ACA will contain the AVPs specified in createAccountingAnswer() and the following AVPs from the Accounting-Request:

  • Accounting-Record-Type
  • Accounting-Record-Number

void sendAccountingAnswer(AccountingAnswer aca) throws IOException, IllegalArgumentException;

Send an Accounting Answer.

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 this section.

Diameter Base Resource Adaptor Type declares all the Diameter Base messages but the Peer Management related messages are not usable by Services, ie, are not fired.

The following tables shows which events are fired on each activity and the ones which aren't fired on any.







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 Base Activity Context Interface Factory is defined as follows:



package net.java.slee.resource.diameter.base;
import javax.slee.ActivityContextInterface;
import javax.slee.FactoryException;
import javax.slee.UnrecognizedActivityException;
public interface DiameterActivityContextInterfaceFactory {
    public ActivityContextInterface 
        getActivityContextInterface(DiameterActivity activity) 
            throws UnrecognizedActivityException, FactoryException;
    public ActivityContextInterface 
        getActivityContextInterface(AccountingClientSessionActivity activity) 
            throws UnrecognizedActivityException;
    public ActivityContextInterface 
        getActivityContextInterface(AccountingServerSessionActivity activity) 
            throws UnrecognizedActivityException;
}
    

The JBoss Communications Diameter Base 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.base;
import net.java.slee.resource.diameter.base.events.DiameterMessage;
import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
import java.io.IOException;
public interface DiameterProvider {
    public DiameterMessageFactory 
        getDiameterMessageFactory();
    public DiameterAvpFactory getDiameterAvpFactory();
    public DiameterActivity createActivity() throws CreateActivityException;
    public DiameterActivity createActivity(DiameterIdentity destinationHost, 
        DiameterIdentity destinationRealm) throws CreateActivityException;
    public AccountingClientSessionActivity createAccountingClientSessionActivity()
        throws CreateActivityException;
    public AccountingClientSessionActivity createAccountingClientSessionActivity(
        DiameterIdentity destinationHost, DiameterIdentity destinationRealm)
            throws CreateActivityException ;
    public AuthClientSessionActivity createAuthenticationClientSessionActivity()
        throws CreateActivityException;
    public AuthClientSessionActivity createAuthenticationClientSessionActivity(
        DiameterIdentity destinationHost, DiameterIdentity destinationRealm) 
            throws CreateActivityException;
    public DiameterMessage sendSyncRequest(DiameterMessage message)
        throws IOException;
    public DiameterIdentity[] getConnectedPeers();
    public int getPeerCount();
}
    

public DiameterMessageFactory getDiameterMessageFactory();

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

public DiameterAvpFactory getDiameterAvpFactory();

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

public DiameterActivity createActivity() throws CreateActivityException;

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

public DiameterActivity createActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException;

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

public AccountingClientSessionActivity createAccountingClientSessionActivity() throws CreateActivityException;

This method create a new activity to send Diameter Accounting request messages.

public AccountingClientSessionActivity createAccountingClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm) throws CreateActivityException ;

This method create a new activity to send Diameter Accounting request messages.

public AuthClientSessionActivity createAuthenticationClientSessionActivity() throws CreateActivityException;

This method create a new activity to send Diameter Authorization request messages.

public AuthClientSessionActivity createAuthenticationClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm)throws CreateActivityException;

This method create a new activity to send Diameter Authorization request messages.

public DiameterMessage sendSyncRequest(DiameterMessage message) throws IOException;

Synchronously send a Diameter request and block until a response is received.

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.

Current Resource Adaptor Type has no defined restrictions.

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



    /* Method for creating and sending ACR with pre-defined values. */
    private void sendAccountingRequest() {
        try {
            AccountingClientSessionActivity activity = provider.createAccountingClientSessionActivity();
            List<DiameterAvp> avps = new ArrayList<DiameterAvp>();
            avps.add(avpFactory.createAvp(DiameterAvpCodes.SESSION_ID, 
                activity.getSessionId().getBytes()));
            DiameterAvp avpVendorId = avpFactory.createAvp(DiameterAvpCodes.VENDOR_ID, 193);
            DiameterAvp avpAcctApplicationId = avpFactory.createAvp(
                DiameterAvpCodes.ACCT_APPLICATION_ID, 19302);
            avps.add(avpFactory.createAvp(
                DiameterAvpCodes.VENDOR_SPECIFIC_APPLICATION_ID, 
                    new DiameterAvp[] { avpVendorId, avpAcctApplicationId }));
            avps.add(avpFactory.createAvp(DiameterAvpCodes.ORIGIN_HOST, 
                this.originIP.getBytes()));
            avps.add(avpFactory.createAvp(DiameterAvpCodes.ORIGIN_REALM, 
                this.originRealm.getBytes()));
            avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_HOST, 
                (this.destinationIP + ":" + this.destinationPort).getBytes()));
            avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_REALM, 
                this.destinationRealm.getBytes()));
            // Subscription ID
            DiameterAvp subscriptionIdType = avpFactory.createAvp(193, 555, 0);
            DiameterAvp subscriptionIdData = avpFactory.createAvp(193, 554, "00001000");
            avps.add(avpFactory.createAvp(193, 553, new DiameterAvp[] {subscriptionIdType, 
                subscriptionIdData}));
            // Requested Service Unit
            DiameterAvp unitType = avpFactory.createAvp(193, 611, 2);
            DiameterAvp valueDigits = avpFactory.createAvp(193, 617, 10L);
            DiameterAvp unitValue = avpFactory.createAvp(193, 612, new DiameterAvp[] {valueDigits});
            avps.add(avpFactory.createAvp(193, 606, new DiameterAvp[] {unitType, unitValue}));
            // Record Number and Type
            avps.add(avpFactory.createAvp(
                DiameterAvpCodes.ACCOUNTING_RECORD_NUMBER, 0));
            avps.add(avpFactory.createAvp(
                DiameterAvpCodes.ACCOUNTING_RECORD_TYPE, 1));
            // Requested action
            avps.add(avpFactory.createAvp(193, 615, 0));
            // Service Parameter Type
            DiameterAvp serviceParameterType = avpFactory.createAvp(193, 608, 0);
            DiameterAvp serviceParameterValue = avpFactory.createAvp(193, 609, "510");
            avps.add(avpFactory.createAvp(193, 607, new DiameterAvp[] {serviceParameterType,
                serviceParameterValue}));
            // Service Parameter Type
            DiameterAvp serviceParameterType2 = avpFactory.createAvp(193, 608, 14);
            DiameterAvp serviceParameterValue2 = avpFactory.createAvp(193, 609, "20");
            avps.add(avpFactory.createAvp(193, 607, new DiameterAvp[] {serviceParameterType2,
                serviceParameterValue2}));
            DiameterAvp[] avpArray = new DiameterAvp[avps.size()];
            avpArray = avps.toArray(avpArray);
            if (tracer.isInfoEnabled())
                tracer.info("Creating Custom Message...");
            AccountingRequest acr = messageFactory.createAccountingRequest(avpArray);
            if (tracer.isFineEnabled()) {
                tracer.fine("Created Custom Message[" + acr + "]");
                tracer.fine("Sending Custom Message...");
            }
            
            ActivityContextInterface aci = acif.getActivityContextInterface(activity);
            
            activity.sendAccountRequest(acr);
            
            aci.attach(sbbContext.getSbbLocalObject());
            
            if (tracer.isInfoEnabled()) {
                tracer.info("Sent Custom Message[" + acr + "]");
            }
        }
        catch (Exception e) {
            tracer.severe("", e);
        }
    }
    
    ...
    
    /* Method for handling ACA messages. Just print the Result-Code AVP. */
    public void onAccountingAnswer(AccountingAnswer aca, ActivityContextInterface aci) {
        if (tracer.isInfoEnabled()) {
            tracer.info("Accounting-Answer received. Result-Code[" + aca.getResultCode() + "].");
        }
    }
    

Simple Server-Side Example for receiving Accounting-Request and proxy it to it's destination, if acting as proxy, or answer with Accounting-Answer, if in Server mode.



    /* Method for handling ACR messages and either proxy or answer them. */
    public void onAccountingRequest(AccountingRequest acr, ActivityContextInterface aci) {
        long start = System.currentTimeMillis();
        if (tracer.isInfoEnabled())
            tracer.info("Accounting-Request received. [" + acr + "]");
        boolean actAsProxy = false;
        try {
            // Are we gonna act as a proxy?
            if (actAsProxy) {
                // In here we act as a "proxy". Just for testing we take the original message,
                // replace the Origin/Destination Host/Realm AVPs and send it to the emulator.
                boolean hasDestinationHost = false;
                boolean hasDestinationRealm = false;
                List<DiameterAvp> avps = new ArrayList<DiameterAvp>();
                for (DiameterAvp avp : acr.getAvps()) {
                    switch (avp.getCode()) {
                    case DiameterAvpCodes.ORIGIN_HOST:
                        avps.add(avpFactory.createAvp(DiameterAvpCodes.ORIGIN_HOST, ("aaa://" + 
                            originIP + ":" + originPort).getBytes()));
                        break;
                    case DiameterAvpCodes.ORIGIN_REALM:
                        avps.add(avpFactory.createAvp(DiameterAvpCodes.ORIGIN_REALM, 
                            originRealm.getBytes()));
                        break;
                    case DiameterAvpCodes.DESTINATION_HOST:
                        avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_HOST, 
                            ("aaa://" + destinationIP + ":" + destinationPort).getBytes()));
                        hasDestinationHost = true;
                        break;
                    case DiameterAvpCodes.DESTINATION_REALM:
                        avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_REALM, 
                            destinationRealm.getBytes()));
                        hasDestinationRealm = true;
                        break;
                    default:
                        avps.add(avp);
                    }
                }
                if (!hasDestinationHost)
                    avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_HOST, 
                        "127.0.0.1".getBytes()));
                if (!hasDestinationRealm)
                    avps.add(avpFactory.createAvp(DiameterAvpCodes.DESTINATION_REALM, 
                        "mobicents.org".getBytes()));
                if (tracer.isInfoEnabled())
                    tracer.info("AVPs ==> " + avps);
                DiameterAvp[] avpArray = new DiameterAvp[avps.size()];
                avpArray = avps.toArray(avpArray);
                if (tracer.isInfoEnabled())
                    tracer.info("Creating Custom Message...");
                DiameterMessage ms = messageFactory.createAccountingRequest(avpArray);
                if (tracer.isInfoEnabled()) {
                    tracer.info("Created Custom Message[" + ms + "]");
                    tracer.info("Sending Custom Message...");
                }
                provider.createActivity().sendMessage(ms);
                if (tracer.isInfoEnabled()) {
                    tracer.info("Sent Custom Message[" + ms + "]");
                }
            }
            else {
                // In here we act as a server and just say it's SUCCESS.
                if (aci.getActivity() instanceof AccountingServerSessionActivity) {
                    AccountingServerSessionActivity assa = 
                        (AccountingServerSessionActivity) aci.getActivity();
                    AccountingAnswer ans = assa.createAccountingAnswer(acr);
                    ans.setResultCode(2001); // 2001 = SUCCESS
                    if (tracer.isInfoEnabled()) {
                        tracer.info("Sending Accounting-Answer [" + ans + "]");
                    }
                    assa.sendAccountingAnswer(ans);
                    if (tracer.isInfoEnabled()) {
                        tracer.info("Accounting-Answer sent.");
                    }
                }
            }
        }
        catch (Exception e) {
            tracer.severe("", e);
        }
        long end = System.currentTimeMillis();
        if (tracer.isInfoEnabled()) {
            tracer.info("Accounting-Request proccessed. [" + (end - start) + "ms]");
        }
    }