I love the smell of UnrealEd crashing in the morning. – tarquin
UE3:WebAdmin (UT3)
Object >> WebApplication >> WebAdmin |
Contents
- 1 Properties
- 2 Instance functions
- 2.1 addMessage
- 2.2 addQueryHandler
- 2.3 CleanupApp
- 2.4 CleanupMsgSpecs
- 2.5 CreateChatLog
- 2.6 getAuthURL
- 2.7 getMessagesObject
- 2.8 getSession
- 2.9 getWebAdminUser
- 2.10 include
- 2.11 init
- 2.12 initQueryHandlers
- 2.13 pageAbout
- 2.14 pageAuthentication
- 2.15 pageGenericError
- 2.16 pageGenericInfo
- 2.17 parseCookies
- 2.18 Query
- 2.19 renderMessages
- 2.20 sendPage
- 2.21 setAuthCredCookie
- Package:
- WebAdmin
- Direct subclass:
- UTServerAdmin
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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.
[edit]
Type: WebAdminMenu
The menu handler
pccleanup[edit]
Type: PCCleanUp
QueryHandlers[edit]
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]
addQueryHandler[edit]
Add a query handler to the list. This will also call init() and registerMenuItems() on the query handler.
CleanupApp[edit]
Overrides: WebApplication.CleanupApp
CleanupMsgSpecs[edit]
CreateChatLog[edit]
getAuthURL[edit]
return the authentication URL string used in the user privileged system.
getMessagesObject[edit]
getSession[edit]
Adds the ISession instance to query
getWebAdminUser[edit]
Retreives the webadmin user. Creates a new one when needed.
include[edit]
Include the specified file.
init[edit]
Overrides: WebApplication.Init
initQueryHandlers[edit]
Load the registered query handlers
pageAbout[edit]
pageAuthentication[edit]
Produces the authentication page.
pageGenericError[edit]
Create a generic error message.
pageGenericInfo[edit]
Create a generic information message.
parseCookies[edit]
Query[edit]
Overrides: WebApplication.Query
renderMessages[edit]
sendPage[edit]
Load the given file and send it to the client.