Package org.jainslee.resources.diameter.rf.vcb0

Interface RfProvider

All Superinterfaces:

RfProviderFactory

public interface RfProvider
extends RfProviderFactory

The SBB interface for the Diameter Rf Resource Adaptor.

This API can be used in either an asynchronous or synchronous manner.

To send messages asynchronously, create a RfClientSessionActivity using one of the createRfClientSessionActivity() methods.

To send messages synchronously, use the accountingRequest(AccountingRequest) method.

The Accounting-Request messages must be created using the RfMessageFactory returned from getRfMessageFactory().

Author:

OpenCloud

Method Summary

Modifier and Type	Method	Description
AccountingAnswer	accountingRequest(AccountingRequest accountingRequest)	Send an Accounting Request.
RfClientSessionActivity	createRfClientSessionActivity()	Create a new activity to send and receive Diameter messages.
RfClientSessionActivity	createRfClientSessionActivity(DiameterIdentity destinationHost, DiameterIdentity destinationRealm)	Create a new activity to send and receive Diameter messages.
RfMessageFactory	getRfMessageFactory()	Return a message factory to be used to create concrete implementations of accounting messages and AVPs.

Methods inherited from interface org.jainslee.resources.diameter.rf.RfProviderFactory

getConfiguredTGPPVersion, getRfProviderV710, getRfProviderV790, getRfProviderV8d0, getRfProviderV960, getRfProviderVa00, getRfProviderVb80, getRfProviderVcb0

Method Detail

getRfMessageFactory

RfMessageFactory getRfMessageFactory()

Return a message factory to be used to create concrete implementations of accounting messages and AVPs.

createRfClientSessionActivity

RfClientSessionActivity createRfClientSessionActivity()
                                               throws CreateActivityException

Create a new activity to send and receive Diameter messages.

Returns:

a DiameterActivity

Throws:

CreateActivityException - if the RA could not create the activity for any reason

createRfClientSessionActivity

RfClientSessionActivity createRfClientSessionActivity(DiameterIdentity destinationHost,
                                                      DiameterIdentity destinationRealm)
                                               throws CreateActivityException

Create a new activity to send and receive Diameter messages.

Parameters:

destinationHost - a destination host to automatically put in all messages

destinationRealm - a destination realm to automatically put in all messages

Returns:

a DiameterActivity

Throws:

CreateActivityException - if the RA could not create the activity for any reason

accountingRequest

AccountingAnswer accountingRequest(AccountingRequest accountingRequest)
                            throws IllegalArgumentException,
                                   SendException

Send an Accounting Request. The answer will be returned from the method invocation.

See the note regarding synchronous requests in the org.jainslee.resources.diameter.rf package docs.

Parameters:

accountingRequest - the Accounting-Request message to send

Returns:

the answer from the server

Throws:

SendException - if the message could not be sent

IllegalArgumentException - if accountingRequest is missing any required AVPs