org.jdiameter.api.gx
Interface ClientGxSessionListener

public interface ClientGxSessionListener

This interface defines the possible actions for the different states in the client Credit-Control Application state machine.

Author:

Carl-Magnus Björkell

Method Summary

void	doCreditControlAnswer(ClientGxSession session, GxCreditControlRequest request, GxCreditControlAnswer answer) Notifies this ClientGxSessionListener that the ClientGxSession has received a Ro message.
void	doGxReAuthRequest(ClientGxSession session, GxReAuthRequest request) Notifies this ClientGxSessionListener that the ClientGxSession has received a RAR message.
void	doOtherEvent(AppSession session, AppRequestEvent request, AppAnswerEvent answer) Notifies this ClientGxSessionListener that the ClientGxSession has received a non Gx message, usually some extension.
int	getDefaultCCFHValue() Provides with default value of CCFH AVP - this is used when AVP is not present or send operation fails for some reason. CCFH is of type Enumerated - int32
int	getDefaultDDFHValue() Provides with default value of DDFH AVP - this is used when AVP is not present or send operation fails for some reason. DDFH is of type Enumerated - int32

Method Detail

doCreditControlAnswer

void doCreditControlAnswer(ClientGxSession session,
                           GxCreditControlRequest request,
                           GxCreditControlAnswer answer)
                           throws InternalException,
                                  IllegalDiameterStateException,
                                  RouteException,
                                  OverloadException

Notifies this ClientGxSessionListener that the ClientGxSession has received a Ro message.

Parameters:

session - parent application session (FSM)

request - request object

answer - answer object

Throws:

InternalException - The InternalException signals that internal error has occurred.

IllegalDiameterStateException - The IllegalStateException signals that session has incorrect state (invalid).

RouteException - The NoRouteException signals that no route exist for a given realm.

OverloadException - The OverloadException signals that destination host is overloaded.

doGxReAuthRequest

void doGxReAuthRequest(ClientGxSession session,
                       GxReAuthRequest request)
                       throws InternalException,
                              IllegalDiameterStateException,
                              RouteException,
                              OverloadException

Notifies this ClientGxSessionListener that the ClientGxSession has received a RAR message.

Parameters:

session - parent application session (FSM)

request - request object

Throws:

InternalException - The InternalException signals that internal error has occurred.

IllegalDiameterStateException - The IllegalStateException signals that session has incorrect state (invalid).

RouteException - The NoRouteException signals that no route exist for a given realm.

OverloadException - The OverloadException signals that destination host is overloaded.

doOtherEvent

void doOtherEvent(AppSession session,
                  AppRequestEvent request,
                  AppAnswerEvent answer)
                  throws InternalException,
                         IllegalDiameterStateException,
                         RouteException,
                         OverloadException

Notifies this ClientGxSessionListener that the ClientGxSession has received a non Gx message, usually some extension.

Parameters:

session - parent application session (FSM)

request - request object

answer - answer object

Throws:

InternalException - The InternalException signals that internal error has occurred.

IllegalDiameterStateException - The IllegalStateException signals that session has incorrect state (invalid).

RouteException - The NoRouteException signals that no route exist for a given realm.

OverloadException - The OverloadException signals that destination host is overloaded.

getDefaultDDFHValue

int getDefaultDDFHValue()

Provides with default value of DDFH AVP - this is used when AVP is not present or send operation fails for some reason.
DDFH is of type Enumerated - int32

Returns:

getDefaultCCFHValue

int getDefaultCCFHValue()

Provides with default value of CCFH AVP - this is used when AVP is not present or send operation fails for some reason.
CCFH is of type Enumerated - int32

Returns: