Class: AuthenticationData (in Authentication)

• Inheritance
• Description
• Class protocol
  • instance creation
  • queries
• Instance protocol
  • accessing
  • comparing
  • storing

Inheritance:

   Object
   |
   +--Authentication::AuthenticationData
      |
      +--Authentication::BasicAuthenticator::BasicAuthenticationData
      |
      +--Authentication::DigestAuthenticator::DigestAuthenticationData

Package:

stx:goodies/authentication

Category:

Net-Authentication

Version:

rev: 1.8 date: 2022/08/01 08:03:11

user: erghilazghi

file: Authentication__AuthenticationData.st directory: goodies/authentication

module: stx stc-classLibrary: authentication

Description:

This is an abstract superclass.
Subclasses hold authentication data for a user (secret/password). 
Authenticators are repsonsible to authenticate this data.


[instance variables:]

[class variables:]

copyright
COPYRIGHT (c) 2006 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 newForUser: user secret: aSecretString

create an instance of myself with secret

 newMechanism: mechanismName

create an empty instance for a given mechanism

 isAbstract

Return if this class is an abstract class.
True is returned here for myself only; false for subclasses.
Abstract subclasses must redefine this again.

 mechanismName

answer the name of the mechanism as known in the protocols

** This method must be redefined in concrete classes (subclassResponsibility) **

Instance protocol:

 encodedSecret

 encodedSecret: something

 user: user secret: something

encode the secret for user and store it

** This method must be redefined in concrete classes (subclassResponsibility) **

 = authenticationData

(comment from inherited method)
return true if the receiver and the arg have the same structure.
Notice:
This method is partially open coded (inlined) by the compiler(s)
identical objects are always considered equal.
redefining it may not work as expected.

 hash

(comment from inherited method)
return an Integer useful as a hash key for the receiver.
This hash should return same values for objects with same
contents (i.e. use this to hash on structure)

 storeOn: aStream

(comment from inherited method)
store the receiver on aStream; i.e. print an expression which will
reconstruct the receiver.
Notice, that no self referencing or cyclic objects can be represented
in this format.
Use storeBinaryOn:, which handles these cases correctly.