authenticate_sync


Description:

[ Version ( since = "3.4" ) ]
public virtual bool authenticate_sync (Service service, string? mechanism, Cancellable? cancellable = null) throws Error

Authenticates service, which may involve repeated calls to authenticate or authenticate_sync.

A Session subclass is largely responsible for implementing this, and should handle things like user prompts and secure password storage. These issues are out-of-scope for Camel.

If an error occurs, or if authentication is aborted, the function sets throws and returns false.

Parameters:

this

a Session

service

a Service

mechanism

a SASL mechanism name, or null

cancellable

optional Cancellable object, or null

Returns:

true on success, false on failure