org.jdiameter.api.auth

Interface ServerAuthSession

All Superinterfaces:

AppSession, BaseSession, StateMachine

All Known Subinterfaces:

GqServerSession

public interface ServerAuthSession
extends AppSession, StateMachine

Basic class for server 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

Methods

Modifier and Type	Method and Description
void	sendAbortSessionRequest(AbortSessionRequest request) Send session abort session request to client
void	sendAuthAnswer(AppAnswerEvent answer) Send authenticate answer to client
void	sendReAuthRequest(ReAuthRequest request) Send re-authenticate request to client
void	sendSessionTerminationAnswer(SessionTermAnswer request) Send session termination answer to client

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

sendAuthAnswer

void sendAuthAnswer(AppAnswerEvent answer)
                    throws InternalException,
                           IllegalDiameterStateException,
                           RouteException,
                           OverloadException

Send authenticate answer to client

Parameters:

answer - Authentication 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.

sendReAuthRequest

void sendReAuthRequest(ReAuthRequest request)
                       throws InternalException,
                              IllegalDiameterStateException,
                              RouteException,
                              OverloadException

Send re-authenticate request to client

Parameters:

request - 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.

sendAbortSessionRequest

void sendAbortSessionRequest(AbortSessionRequest request)
                             throws InternalException,
                                    IllegalDiameterStateException,
                                    RouteException,
                                    OverloadException

Send session abort session request to client

Parameters:

request - Abort-Session-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.

sendSessionTerminationAnswer

void sendSessionTerminationAnswer(SessionTermAnswer request)
                                  throws InternalException,
                                         IllegalDiameterStateException,
                                         RouteException,
                                         OverloadException

Send session termination answer to client

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.