Always snap to grid

UE3:WebAdmin (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> WebApplication >> WebAdmin
Package: 
WebAdmin
Direct subclass:
UTServerAdmin

The main entry point for the UT3 WebAdmin. This manages the initial web page request and authentication and session handling. The eventual processing of the request will be doen by query handlers.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

Properties[edit]

auth[edit]

Type: IWebAdminAuth

The authorization handler instance

AuthenticationClass[edit]

Type: string

Modifiers: globalconfig

Defines the authentication handler class to use instead of the default one.

bChatLog[edit]

Type: bool

Modifiers: globalconfig


bHttpAuth[edit]

Type: bool

Modifiers: globalconfig

If set to true, use HTTP Basic authentication rather than a HTML form. Using HTTP authentication gives the functionality of automatic re-authentication.

dataStoreCache[edit]

Type: DataStoreCache


defaultAuthClass[edit]

Type: Class

The default authentication class

Default value: Class'WebAdmin.BasicWebAdminAuth'

defaultSessClass[edit]

Type: Class

The default session handler class

Default value: Class'WebAdmin.SessionHandler'

handlers[edit]

Type: array<IQueryHandler>

The loaded handlers.

menu[edit]

Type: WebAdminMenu

The menu handler

pccleanup[edit]

Type: PCCleanUp


QueryHandlers[edit]

Type: array<string>

Modifiers: globalconfig

The list of query handlers to automativally load

Default value, index 0: "WebAdmin.QHCurrent"

Default value, index 1: "WebAdmin.QHDefaults"

serverIp[edit]

Type: string

Modifiers: protected

local storage. Used to construct the auth URLs.

SessionHandlerClass[edit]

Type: string

Modifiers: globalconfig

The session handler to use instead of the default session handler

sessions[edit]

Type: ISessionHandler

The session handler

startpage[edit]

Type: string

Modifiers: globalconfig

The starting page. Defaults to /current

Default value: "/current"

timestamp[edit]

Type: string

Modifiers: const

Will contain the timestamp when this package was compiled

Default value: "2008-06-03 19:29:29 +0000"

version[edit]

Type: string

Modifiers: const


Default value: "1.4"

Instance functions[edit]

addMessage[edit]

function addMessage (IQueryHandler.WebAdminQuery q, string msg, optional IQueryHandler.EMessageType type)


addQueryHandler[edit]

function addQueryHandler (IQueryHandler qh)

Add a query handler to the list. This will also call init() and registerMenuItems() on the query handler.

CleanupApp[edit]

function CleanupApp ()

Overrides: WebApplication.CleanupApp


CleanupMsgSpecs[edit]

function CleanupMsgSpecs ()


CreateChatLog[edit]

function CreateChatLog ()


getAuthURL[edit]

function string getAuthURL (string forpath)

return the authentication URL string used in the user privileged system.

getMessagesObject[edit]

function WebAdminMessages getMessagesObject (IQueryHandler.WebAdminQuery q)


getSession[edit]

protected function bool getSession (out IQueryHandler.WebAdminQuery q)

Adds the ISession instance to query

getWebAdminUser[edit]

protected function bool getWebAdminUser (out IQueryHandler.WebAdminQuery q)

Retreives the webadmin user. Creates a new one when needed.

include[edit]

function string include (IQueryHandler.WebAdminQuery q, string file)

Include the specified file.

init[edit]

function init ()

Overrides: WebApplication.Init


initQueryHandlers[edit]

protected function initQueryHandlers ()

Load the registered query handlers

pageAbout[edit]

function pageAbout (IQueryHandler.WebAdminQuery q)


pageAuthentication[edit]

function pageAuthentication (IQueryHandler.WebAdminQuery q)

Produces the authentication page.

pageGenericError[edit]

function pageGenericError (IQueryHandler.WebAdminQuery q, coerce string errorMsg, optional string title)

Create a generic error message.

pageGenericInfo[edit]

function pageGenericInfo (IQueryHandler.WebAdminQuery q, coerce string msg, optional string title)

Create a generic information message.

parseCookies[edit]

protected function parseCookies (string cookiehdr, out array<Info.KeyValuePaircookies)


Query[edit]

function Query (WebRequest Request, WebResponse Response)

Overrides: WebApplication.Query


renderMessages[edit]

function string renderMessages (IQueryHandler.WebAdminQuery q)


sendPage[edit]

function sendPage (IQueryHandler.WebAdminQuery q, string file)

Load the given file and send it to the client.

setAuthCredCookie[edit]

function setAuthCredCookie (out IQueryHandler.WebAdminQuery q, string creddata, int timeout)