org.jdiameter.api.auth
Interface ClientAuthSession

All Superinterfaces:

AppSession, BaseSession, StateMachine

All Known Subinterfaces:

GqClientSession

public interface ClientAuthSession
extends AppSession, StateMachine

Basic class for authentication application specific session Listener must injection from constructor of implementation class

Version:

1.5.1 Final

Author:

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

Method Summary

void	sendAbortSessionAnswer(AbortSessionAnswer answer) Send abort session answer to server
void	sendAuthRequest(AppRequestEvent request) Send authentication session request to server
void	sendReAuthAnswer(ReAuthAnswer answer) Send re-authentication session answer to server
void	sendSessionTerminationRequest(SessionTermRequest request) Send session termination request to server

Methods inherited from interface org.jdiameter.api.app.AppSession

getSessionAppId, getSessions, isStateless

Methods inherited from interface org.jdiameter.api.BaseSession

getCreationTime, getLastAccessedTime, getSessionId, isAppSession, isReplicable, isValid, release

Methods inherited from interface org.jdiameter.api.app.StateMachine

addStateChangeNotification, getState, handleEvent, removeStateChangeNotification

Method Detail

sendAuthRequest

void sendAuthRequest(AppRequestEvent request)
                     throws InternalException,
                            IllegalDiameterStateException,
                            RouteException,
                            OverloadException

Send authentication session request to server

Parameters:

request - Authentication-Request event instance

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.

sendReAuthAnswer

void sendReAuthAnswer(ReAuthAnswer answer)
                      throws InternalException,
                             IllegalDiameterStateException,
                             RouteException,
                             OverloadException

Send re-authentication session answer to server

Parameters:

answer - Re-Authentication-Request event instance

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.

sendAbortSessionAnswer

void sendAbortSessionAnswer(AbortSessionAnswer answer)
                            throws InternalException,
                                   IllegalDiameterStateException,
                                   RouteException,
                                   OverloadException

Send abort session answer to server

Parameters:

answer - Abort-Session-Answer event instance

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

sendSessionTerminationRequest

void sendSessionTerminationRequest(SessionTermRequest request)
                                   throws InternalException,
                                          IllegalDiameterStateException,
                                          RouteException,
                                          OverloadException

Send session termination request to server

Parameters:

request - Session-Term-Request event instance

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.