WebAdmin.IWebAdminAuth

WebAdmin authentication interface. An implementation of this interface is used to create IWebAdminUser instances. Copyright 2008 Epic Games, Inc. All Rights Reserved @author Michiel 'elmuerte' Hendriks

WebAdmin.IWebAdminAuth

Functions Summary
	IWebAdminUser	authenticate (string username, string password, out string errorMsg)
		cleanup ()
		init (WorldInfo worldinfo)
	bool	logout (IWebAdminUser user)
	bool	validate (string username, string password, out string errorMsg)
	bool	validateUser (IWebAdminUser user, out string errorMsg)

authenticate Source code

Try to log in a user with the provided credentials
@param username
@param password
@param errorMsg can be set to a friendly error message or reason why authentication failed
@return none when authentication failed, otherwise the created user instance

cleanup Source code

Cleanup (prepare for being destroyed)

init Source code

Initialize the authentication handler

logout Source code

Logout the given user. A user does not explicitly log out.
@return true when the user was succesfully logged out.

validate Source code

Like authenticate(...) except that the user is not explicitly logged in (or created). This will be used to re-validate an already existing user. For example in the case a time out was triggered and the user needs to re-enter his/her password.
@param username
@param password
@param errorMsg can be set to a friendly error message or reason why authentication failed

validateUser Source code

Validate the given user. This will be used to check if the IWebAdminUser is still valid, for example to check if the user wasn't deleted in the mean while.
@param user the user instance to validate
@param errorMsg can be set to a friendly error message or reason why authentication failed