PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandler Interface Reference

Authentication handlers implementing this interface can be be registered with the server. The server calls the authentication handlers when a client application creates a session, or changes the prinicipal associated with a session, allowing the handler to veto individual requests. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandler:

Public Member Functions
void	Authenticate (string principal, ICredentials credentials, ISessionDetails sessionDetails, IAuthenticationHandlerCallback callback)
	Request authentication. More...

Detailed Description

Authentication handlers implementing this interface can be be registered with the server. The server calls the authentication handlers when a client application creates a session, or changes the prinicipal associated with a session, allowing the handler to veto individual requests.

Authentication handlers are configured in precedence order. Authentication will succeed if a handler returns "allow" and all higher precdence handlers (earlier in the order) return "abstain". Authentication will fail if a handler returns "deny" and all high precedence handlers return "abstain". If all authentication handlers return "abstain", the request will be denied. Once the outcome is known, the server may choose not to call the remaining handlers.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandler.Authenticate	(	string	principal,
		ICredentials	credentials,
		ISessionDetails	sessionDetails,
		IAuthenticationHandlerCallback	callback
	)

Request authentication.

The server calls this to authenticate new sessions, and when a client requests the session principal is changed.

For each call to Authenticate, the authentication handler should respond by calling one of the methods of the provided callback. The handler may return immediately and process the authentication request asynchronously. The client session will be blocked until a callback method is called.

Parameters

principal
credentials
sessionDetails
callback

Implemented in PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.

---

The documentation for this interface was generated from the following file:

• LegacyModule/Client/Security/Authentication/IAuthenticationHandler.cs