AMPS.Client.DefaultAuthenticator Class Reference

A default implementation of the Authenticator interface that is used for basic username/password authentication. More...

Inheritance diagram for AMPS.Client.DefaultAuthenticator:

Public Member Functions
virtual String	authenticate (String username_, String currentPassword_)
	Called by AMPS.Client, just before the logon command is sent. More...
virtual String	retry (String username_, String password_)
	Called when a logon "ack" is received with a status of "retry". More...
virtual void	completed (String username_, String password_, Message.Reasons reason_)
	Called when a logon completes successfully. More...

Detailed Description

A default implementation of the Authenticator interface that is used for basic username/password authentication.

Member Function Documentation

authenticate()

virtual String AMPS.Client.DefaultAuthenticator.authenticate ( String  username_, String  currentPassword_  )

inlinevirtual

Called by AMPS.Client, just before the logon command is sent.

Parameters

username_	The current value of the username as specified in the URI.
currentPassword_	The current value of the password, as specified in the URI.

Returns

The value that should be placed into the Password header field of the logon command

Implements AMPS.Client.Authenticator.

completed()

virtual void AMPS.Client.DefaultAuthenticator.completed ( String  username_, String  password_, Message.Reasons  reason_  )

inlinevirtual

Called when a logon completes successfully.

Once a logon has completed, this method is called with the username and password that caused a successful logon.

Parameters

username_	The username that successfully logged on to the server.
password_	The password that successfully logged on to the server.
reason_	The reason reported for success by the server.

Implements AMPS.Client.Authenticator.

retry()

virtual String AMPS.Client.DefaultAuthenticator.retry ( String  username_, String  password_  )

inlinevirtual

Called when a logon "ack" is received with a status of "retry".

AMPS will continue trying to logon as long as the server returns "retry", and this method continues to succeed.

Parameters

username_	The username returned by the server's ACK message.
password_	The password or token returned in the server's ACK message.

Returns

The value that should be placed into the Password header for the next logon attempt.

Implements AMPS.Client.Authenticator.

---

The documentation for this class was generated from the following file:

• AMPS.Client/DefaultAuthenticator.cs