org.jdiameter.api.auth

Interface ClientAuthSessionListener

public interface ClientAuthSessionListener

This interface defines the possible actions that the different states in the Authentication state machine

Version:

1.5.1 Final

Author:

erick.svenson@yahoo.com, Alexandre Mendonca , Bartosz Baranowski

Method Summary

Methods

Modifier and Type	Method and Description
void	doAbortSessionRequestEvent(ClientAuthSession session, AbortSessionRequest request) Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived AbortSessionRequest message.
void	doAuthAnswerEvent(ClientAuthSession session, AppRequestEvent request, AppAnswerEvent answer) Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived AuthAnswer message.
void	doOtherEvent(AppSession session, AppRequestEvent request, AppAnswerEvent answer) Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived not authentication message.
void	doReAuthRequestEvent(ClientAuthSession session, ReAuthRequest request) Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived ReAuthRequest message.
void	doSessionTerminationAnswerEvent(ClientAuthSession session, SessionTermAnswer answer) Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived SessionTerminationAnswer message.

Method Detail

doAuthAnswerEvent

void doAuthAnswerEvent(ClientAuthSession session,
                     AppRequestEvent request,
                     AppAnswerEvent answer)
                       throws InternalException,
                              IllegalDiameterStateException,
                              RouteException,
                              OverloadException

Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived AuthAnswer message.

Parameters:

session - parent application session (FSM)

request - authentication request object

answer - authentication answer object

Throws:

InternalException - The InternalException signals that internal error is 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.

doReAuthRequestEvent

void doReAuthRequestEvent(ClientAuthSession session,
                        ReAuthRequest request)
                          throws InternalException,
                                 IllegalDiameterStateException,
                                 RouteException,
                                 OverloadException

Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived ReAuthRequest message.

Parameters:

session - parent application session (FSM)

request - re-authentication request object

Throws:

InternalException - The InternalException signals that internal error is 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.

doAbortSessionRequestEvent

void doAbortSessionRequestEvent(ClientAuthSession session,
                              AbortSessionRequest request)
                                throws InternalException,
                                       IllegalDiameterStateException,
                                       RouteException,
                                       OverloadException

Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived AbortSessionRequest message.

Parameters:

session - parent application session (FSM)

request - abort session request object

Throws:

InternalException - The InternalException signals that internal error is 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.

doSessionTerminationAnswerEvent

void doSessionTerminationAnswerEvent(ClientAuthSession session,
                                   SessionTermAnswer answer)
                                     throws InternalException,
                                            IllegalDiameterStateException,
                                            RouteException,
                                            OverloadException

Notifies this AuthSessionEventListener that the ClientAuthSesssion has recived SessionTerminationAnswer message.

Parameters:

session - parent application session (FSM)

answer - abort session request object

Throws:

InternalException - The InternalException signals that internal error is 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 AuthSessionEventListener that the ClientAuthSesssion has recived not authentication message.

Parameters:

session - parent application session (FSM)

request - request object

answer - answer object

Throws:

InternalException - The InternalException signals that internal error is 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.