Package WebStack :: Module Generic :: Class Authenticator
[show private | hide private]
[frames | no frames]

Class Authenticator


A generic authentication component.

Method Summary
  authenticate(self, trans)
An application-specific method which authenticates the sender of the request described by the transaction object 'trans'.
  get_auth_type(self)
An application-specific method which returns the authentication type to be used.
  get_realm(self)
An application-specific method which returns the name of the realm for which authentication is taking place.

Method Details

authenticate(self, trans)

An application-specific method which authenticates the sender of the
request described by the transaction object 'trans'. This method should
consider 'trans' to be read-only and not attempt to change the state of
the transaction.

If the sender of the request is authenticated successfully, the result
of this method evaluates to true; otherwise the result of this method
evaluates to false.

get_auth_type(self)

An application-specific method which returns the authentication type to
be used. An example value is 'Basic' which specifies HTTP basic
authentication.

get_realm(self)

An application-specific method which returns the name of the realm for
which authentication is taking place.

Generated by Epydoc 2.1 on Thu Mar 1 00:37:14 2007 http://epydoc.sf.net