PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler Class Reference

This class is useful when there are several steps to authentication implemented as discrete authentication handlers. It provides an alternative to adding each of the authentication handlers to the server configuation. Usually this class will be extended to create a single application-specific handler that hardcodes the creation of the discrete handlers. More...

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

Public Member Functions
	CompositeAuthenticationHandler (List< IAuthenticationHandler > handlers)
	Constructor. More...
	CompositeAuthenticationHandler (params IAuthenticationHandler[] handlers)
	Constructor. More...
void	Authenticate (string principal, ICredentials credentials, ISessionDetails sessionDetails, IAuthenticationHandlerCallback callback)
	Request authentication. More...
override string	ToString ()
	Returns a string that represents the current object. More...

Properties
List< IAuthenticationHandler >	Handlers [get, set]
	Returns the delegate handler list. More...

Detailed Description

This class is useful when there are several steps to authentication implemented as discrete authentication handlers. It provides an alternative to adding each of the authentication handlers to the server configuation. Usually this class will be extended to create a single application-specific handler that hardcodes the creation of the discrete handlers.

Constructor & Destructor Documentation

PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.CompositeAuthenticationHandler

(

List< IAuthenticationHandler >

handlers

)

Constructor.

Parameters

handlers

The list of authentication handlers.

PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.CompositeAuthenticationHandler

(

params IAuthenticationHandler[]

handlers

)

Constructor.

Parameters

handlers

A variable list of authentication handlers.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.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

Implements PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandler.

override string PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.ToString

(

)

Returns a string that represents the current object.

Returns

A string that represents the current object.

<filterpriority>2</filterpriority>

Property Documentation

List<IAuthenticationHandler> PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.Handlers

getset

Returns the delegate handler list.

---

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

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