net.java.slee.resource.diameter.ro
Interface RoProvider


public interface RoProvider

The SBB interface for the Diameter Ro Resource Adaptor. This API can be used in either an asynchronous or synchronous manner. To send messages asynchronously, create a RoClientSessionActivity using one of the createRoClientSessionActivity() methods. To send messages synchronously, use the following methods:

The Credit-Control-Request messages must be created using the RoMessageFactory returned from getRoMessageFactory().

Author:
Alexandre Mendonca , Bartosz Baranowski

Method Summary
 RoClientSessionActivity createRoClientSessionActivity()
          Create a new activity to send and receive Diameter messages.
 RoClientSessionActivity createRoClientSessionActivity(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity destinationHost, net.java.slee.resource.diameter.base.events.avp.DiameterIdentity destinationRealm)
          Create a new activity to send and receive Diameter messages.
 net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getConnectedPeers()
          Returns array containing identities of connected peers.
 int getPeerCount()
          Return the number of peers this Diameter resource adaptor is connected to.
 RoAvpFactory getRoAvpFactory()
          Return a avp factory to be used to create concrete implementations of credit control AVPs.
 RoMessageFactory getRoMessageFactory()
          Return a message factory to be used to create concrete implementations of credit control messages.
 net.java.slee.resource.diameter.Validator getValidator()
           
 RoCreditControlAnswer sendRoCreditControlRequest(RoCreditControlRequest ccr)
          Send a Credit-Control-Request message to the appropriate peers, and block until the response is received then return it.
 

Method Detail

getRoMessageFactory

RoMessageFactory getRoMessageFactory()
Return a message factory to be used to create concrete implementations of credit control messages.

Returns:

getRoAvpFactory

RoAvpFactory getRoAvpFactory()
Return a avp factory to be used to create concrete implementations of credit control AVPs.

Returns:

createRoClientSessionActivity

RoClientSessionActivity createRoClientSessionActivity()
                                                      throws net.java.slee.resource.diameter.base.CreateActivityException
Create a new activity to send and receive Diameter messages.

Returns:
a DiameterActivity
Throws:
net.java.slee.resource.diameter.base.CreateActivityException - if the RA could not create the activity for any reason

createRoClientSessionActivity

RoClientSessionActivity createRoClientSessionActivity(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity destinationHost,
                                                      net.java.slee.resource.diameter.base.events.avp.DiameterIdentity destinationRealm)
                                                      throws net.java.slee.resource.diameter.base.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:
net.java.slee.resource.diameter.base.CreateActivityException - if the RA could not create the activity for any reason

sendRoCreditControlRequest

RoCreditControlAnswer sendRoCreditControlRequest(RoCreditControlRequest ccr)
                                                 throws java.io.IOException
Send a Credit-Control-Request message to the appropriate peers, and block until the response is received then return it.

Parameters:
ccr - the CreditControlRequest to send
Returns:
the answer received
Throws:
java.io.IOException - if an error occurred sending the request to the peer

getPeerCount

int getPeerCount()
Return the number of peers this Diameter resource adaptor is connected to.

Returns:
connected peer count

getConnectedPeers

net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getConnectedPeers()
Returns array containing identities of connected peers.

Returns:

getValidator

net.java.slee.resource.diameter.Validator getValidator()


Copyright © 2011. All Rights Reserved.