This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new window

For information on migrating to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).

%Net.SASL.Base

abstract class %Net.SASL.Base extends %Library.RegisteredObject

The abstract super class of all security mechanisms to be used with %Net.Authenticator, our implement of the Simple Authentication and Security Layer (SASL) as defined by RFC 2222.

Each defined mechanism will add additional properties defining the parameters needed for the mechanism and override the emthods defined here.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property MechanismName as %String;
The name of the security mechanism. This name must be one of SASL mechanism names that is registered with IANA.
Property methods: MechanismNameDisplayToLogical(), MechanismNameGet(), MechanismNameIsValid(), MechanismNameLogicalToDisplay(), MechanismNameLogicalToOdbc(), MechanismNameNormalize(), MechanismNameSet()
property Password as %String;
The password for the user name being authenticated.
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property UserName as %String;
The user name being authenticated. No authentication will be attempted unless UserName and Password are supplied.
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()

Methods (Including Private)

Return next response based on challenge using this SASL mechanism. Return value is false to indicate abort.
method Start(ByRef response As %String) as %Boolean
Start authentication based on UserName and Password using this mechanism.

Inherited Members

Inherited Methods (Including Private)

Subclasses

FeedbackOpens in a new window