PushTechnology.ClientInterface.Client.Features.Control.Clients.IAuthenticationControl Interface Reference

This feature provides a client session with the ability to authenticate the credentials of other clients. More...

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

Public Member Functions
void	SetAuthenticationHandler (string handlerName, List< DetailType > requestedDetail, IControlAuthenticationHandler handler)
	Register a handler for client authentication events. More...

Additional Inherited Members
Properties inherited from PushTechnology.ClientInterface.Client.Features.IFeature
ISession	Session [get]
	Returns the session that the feature is associated with. More...

Detailed Description

This feature provides a client session with the ability to authenticate the credentials of other clients.

Access Control

In order to register an authentication handler a session needs both GlobalPermission.REGISTER_HANDLER and GlobalPermission.AUTHENTICATE permissions.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Clients.IAuthenticationControl.SetAuthenticationHandler	(	string	handlerName,
		List< DetailType >	requestedDetail,
		IControlAuthenticationHandler	handler
	)

Register a handler for client authentication events.

Each handler is registered under a particular handlerName . For registration to succeed, the server's security configuration must include a matching control-authentication-handler entry for the name. Otherwise registration will fail, the handler will be closed immediately, and an error will be reported to the session error handler.

Each control session may register a single handler for a handlerName . See IServerHandler.OnActive.

It is normal for several or all of the control sessions in a control group to set a handler for a given name. Registration will fail if a session in a different control group has registered a handler using the name.

For each authentication event, the server will use its configuration to determine the priority order. The server may call authentication handlers in serial or parallel. The server may stop the authentication process as soon as it has an allow or deny response from a handler and all higher priority handlers have abstained.

For a configured control authentication handler, the server will select a single handler from those registered for the handlerName . If no handlers are currently registered, the server will consult the next handler.

Parameters

handlerName	Must match an entry in the server's security configuration for registration to succeed.
requestedDetail	The session details that the server should supply, if available.
handler	The authentication handler to set.

---

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

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