Objeck Documentation

All Bundles

WebServerConfig

Web server configuration manager

Implements: RequestPageHandler

Operations

New
AddFiles
AddHandler
GetCertKeyPath
GetCertPassword
GetCertPath
GetClass
GetFilename
GetPort
HasStaticHandler
IsDebug
IsHandlingFiles
Load
Process
ProcessGet
ProcessPost
ToString

AddFiles

Adds files to a group

method : private : AddFiles(group:String, mimi:String, item_json:JsonElement) ~ Bool

Parameters

Name	Type	Description
group	String	file group
mimi	String	MIME type
item_json	JsonElement	JSON configuration

Return

Type	Description
Bool	true if successful, false otherwise

AddHandler

Adds a file handler to a group

method : private : AddHandler(group:String, mimi:String, item_json:JsonElement) ~ Bool

Parameters

Name	Type	Description
group	String	file group
mimi	String	MIME type
item_json	JsonElement	JSON configuration

Return

Type	Description
Bool	true if successful, false otherwise

GetCertKeyPath

Gets the SSL certificate key path

method : public : GetCertKeyPath() ~ String

Return

Type	Description
String	SSL certificate key path

GetCertPassword

Gets the SSL certificate password

method : public : GetCertPassword() ~ String

Return

Type	Description
String	SSL certificate password

GetCertPath

Gets the SSL certificate path

method : public : GetCertPath() ~ String

Return

Type	Description
String	SSL certificate path

GetClass

Gets the request handler class

method : public : GetClass() ~ Class

Return

Type	Description
Class	request handler class

GetFilename

Gets the configuration filename

method : public : GetFilename() ~ String

Return

Type	Description
String	configuration filename

GetPort

Gets the server port

method : public : GetPort() ~ Int

Return

Type	Description
Int	server port

HasStaticHandler

Checks if a static handler exists for the given name

method : public : HasStaticHandler(name:String) ~ Bool

Parameters

Name	Type	Description
name	String	handler name

Return

Type	Description
Bool	true if static handler exists, false otherwise

IsDebug

Checks if debug mode is enabled

method : public : IsDebug() ~ Bool

Return

Type	Description
Bool	true if debug mode is enabled, false otherwise

IsHandlingFiles

Checks if file handling is enabled

method : public : IsHandlingFiles() ~ Bool

Return

Type	Description
Bool	true if file handling is enabled, false otherwise

Load

Loads the configuration from file

method : public : Load() ~ Bool

Return

Type	Description
Bool	true if successful, false otherwise

New

Constructor

New(filename:String)

Parameters

Name	Type	Description
filename	String	configuration file path

Process

Processes HTTP request and response

method : private : Process(request:Request, response:Response) ~ Bool

Parameters

Name	Type	Description
request	Request	HTTP request
response	Response	HTTP response

Return

Type	Description
Bool	true if successful, false otherwise

Process

Processes a file handler request

method : private : Process(file_handler:FileHandler, response:Response) ~ Bool

Parameters

Name	Type	Description
file_handler	FileHandler	file handler
response	Response	HTTP response

Return

Type	Description
Bool	true if successful, false otherwise

ProcessGet

Callback for GET requests

method : public : ProcessGet(request:Web.HTTP.Server.Request, response:Web.HTTP.Server.Response) ~ Bool

Parameters

Name	Type	Description
request	Request	HTTP request
response	Response	HTTP response

ProcessPost

Callback for POST requests

method : public : ProcessPost(request:Web.HTTP.Server.Request, response:Web.HTTP.Server.Response) ~ Bool

Parameters

Name	Type	Description
request	Request	HTTP request
response	Response	HTTP response

ToString

Gets the string representation of the configuration

method : public : ToString() ~ String

Return

Type	Description
String	string representation