UE3:IWebAdminAuth (UT3)

Interface >> IWebAdminAuth

Package: 

WebAdmin

Known implementing classes:

BasicWebAdminAuth

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

Instance functions

authenticate

function IWebAdminUser authenticate (string username, string password, out string errorMsg)

Try to log in a user with the provided credentials

Parameters:

• username -
• password -
• errorMsg - can be set to a friendly error message or reason why authentication failed

Returns:

none when authentication failed, otherwise the created user instance

cleanup

function cleanup ()

Cleanup (prepare for being destroyed)

init

function init (WorldInfo worldinfo)

Initialize the authentication handler

logout

function bool logout (IWebAdminUser user)

Logout the given user. A user does not explicitly log out.

Returns:

true when the user was succesfully logged out.

validate

function bool validate (string username, string password, out string errorMsg)

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.

Parameters:

• username -
• password -
• errorMsg - can be set to a friendly error message or reason why authentication failed

validateUser

function bool validateUser (IWebAdminUser user, out string errorMsg)

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.

Parameters:

• user - the user instance to validate
• errorMsg - can be set to a friendly error message or reason why authentication failed