Interface IAuthenticationHandlerCallback
The single-use authentication callback provided to the Authenticate(String, ICredentials, ISessionDetails, IAuthenticationHandlerCallback) call.
Namespace: PushTechnology.ClientInterface.Client.Security.Authentication
Assembly: Diffusion.Client.dll
Syntax
public interface IAuthenticationHandlerCallback
Remarks
Deprecated: This interface has been replaced by the IAuthenticatorCallback interface. New authentication handlers should implement IAuthenticator. This interface will be removed in a future release.
The server calls the handlers for each authentication request. Each handler must respond with Allow(), Abstain(), or Deny(). The special Allow(IAuthenticationResult) variant is provided if the handler wants to return additional information.
Authentication handlers are configured in precedence order. Authentication will succeed if a handler returns Allow() and all higher precedence handlers (earlier in the order) return Abstain(). Authentication will fail if a handler returns Deny() and all higher precedence handlers return Abstain(). If all authentication handlers return Abstain(), the request will be denied. Once the outcome is known, the server may chose not to call the remaining handlers.
Methods
Abstain()
Abstains from the authentication request.
Declaration
void Abstain()
Allow()
Allows the authentication request.
Declaration
void Allow()
Allow(IAuthenticationResult)
Allows the authentication request with additional information provided relating to the session (for example, additional security roles).
Declaration
void Allow(IAuthenticationResult result)
Parameters
Type | Name | Description |
---|---|---|
IAuthenticationResult | result | The additional information for the session. |
Deny()
Denies the authentication request.
Declaration
void Deny()