PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler Class Reference

This class is useful when there are several steps to authentication implemented as discrete authentication handlers. Using a CompositeAuthenticationHandler is better than configuring separate control authentication handlers and registering the discrete handlers individually because it reduces communication between the server and the control client. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler:

Public Member Functions
	CompositeControlAuthenticationHandler (List< IAuthenticationHandler > handlers)
	Constructor. More...
	CompositeControlAuthenticationHandler (params IAuthenticationHandler[] handlers)
	Constructor. More...
virtual void	OnActive (IRegisteredHandler registeredHandler)
	Called when the handler has been registered at the server and is now active. More...
virtual void	OnClose ()
	Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered. More...
Public Member Functions inherited from PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler
	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...

Additional Inherited Members
Properties inherited from PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler
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. Using a CompositeAuthenticationHandler is better than configuring separate control authentication handlers and registering the discrete handlers individually because it reduces communication between the server and the control client.

Constructor & Destructor Documentation

PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler.CompositeControlAuthenticationHandler

(

List< IAuthenticationHandler >

handlers

)

Constructor.

Parameters

handlers

The authentication handlers.

PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler.CompositeControlAuthenticationHandler

(

params IAuthenticationHandler[]

handlers

)

Constructor.

Parameters

handlers

The variable-length list of handlers.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler.OnActive ( IRegisteredHandler  registeredHandler )

virtual

Called when the handler has been registered at the server and is now active.

A session can register at most one a single handler of each type. If there is already a handler registered for the topic path the operation will fail, the registered handler will be closed, and the session error handler will be notified. To change the handler, first close the previous handler.

Implements PushTechnology.ClientInterface.Client.Features.IServerHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.CompositeControlAuthenticationHandler.OnClose ( )

virtual

Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered.

Implements PushTechnology.ClientInterface.Client.Features.IServerHandler.

---

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

• LegacyModule/Client/Features/Control/Clients/CompositeControlAuthenticationHandler.cs