Maxscape::WebServer::Installation Package

Synopsis

use Maxscape::WebServer::Installation;

Description

The Maxscape WebServer::Installation package supplies the basic functionality to deal with installation issues.

List of Member Functions

1. _createServer_docs
2. _createServer_etc
3. _createServer_tables
4. _deletePage
5. _foreachTable
6. checkError
7. close
8. closeWriteCursor
9. createIndices
10. createTable
11. createTables
12. createUser
13. crypt3
14. DataAsText
15. decryptFile
16. deleteServer
17. dropTable
18. dropTables
19. dumpPages
20. dumpTable
21. dumpTables
22. encryptFile
23. exportPage
24. importPage
25. insertCheckedRecordFromString
26. insertHyperlink
27. insertRecordFromFile
28. MyMethod
29. MyMethod
30. new
31. processElements
32. processLinks
33. processTable
34. QueryColumnIndex
35. RecordFilter
36. StatementStringToArray
37. updatePages
38. updateProfileGroups
39. updatePW
40. updateTable
41. updateUSERS_UserType
42. updateUserType

Member Functions

new

Synopsis

my $Installation = Maxscape::WebServer::Installation->new ();

Description

Creates a Maxscape::WebServer::Installation object.

close

Synopsis

$Installation->close ();

Description

Closes the database connection.

closeWriteCursor

Synopsis

$Installation->closeWriteCursor ();

Description

Closes the database connection's write cursor.

checkError

Synopsis

my $Error = $Installation->checkError ();

Description

Returns an error.

DataAsText

Synopsis

my $DataAsText = $Installation->DataAsText ();

Description

Return data as text.

Examples

createTables

Synopsis

my $Text = $Installation->createTables ();

Description

Creates database tables.

createTable

Synopsis

my $Text = $Installation->createTables ($TableName);

Description

Creates a database table.

dropTables

Synopsis

my $Text = $Installation->dropTables ();

Description

Drops database tables.

dropTable

Synopsis

my $Text = $Installation->dropTable ($TableName);

Description

Drops a database table.

createIndices

Synopsis

my $Text = $Installation->createIndices ();

Description

Creates table indices.

insertRecordFromFile

Synopsis

my $Text = $Installation->insertRecordFromFile (%Parameter);

Description

Inserts records from a file.

StatementStringToArray

Synopsis

my @ColumnValues = $Installation->StatementStringToArray (
                     $TableName, $StatementString, $Encode
);

Description

Returns an array of statement.

insertCheckedRecordFromString

Synopsis

my $Text = $Installation->insertCheckedRecordFromString( %P);

Description

Inserts a record from a string.

_deletePage

Synopsis

my $Text = $Installation->_deletePage ();

Description

Deletes a page from the NODE table.

_foreachTable

Synopsis

my $Text = $Installation->_foreachTable();

Description

Goes through all tables.

Examples

dumpTables

Synopsis

my $Text = $Installation->dumpTables ();

Description

Dumps all tables.

dumpTable

Synopsis

my $Text = $Installation->dumpTable ();

Description

Dumps a table.

updateTable

Synopsis

my $ReturnValue = $Installation->updateTable ($TableName, $NextParameters);

Description

Updates a table.

processElements

Synopsis

my $Text = $Installation->processElements ($Param);

Description

Process elements.

processLinks

Synopsis

my $Text = $Installation->processLinks ();

Description

Process links.

processTable

Synopsis

my $Text = $Installation->processTable ();

Description

Process table.

QueryColumnIndex

Synopsis

my $ColumnIndex = $Installation->QueryColumnIndex ($ColumnName);

Description

Returns the index of a table column.

RecordFilter

Synopsis

my $ReturnValue = $Installation->RecordFilter ($Row, $i);

Description

Filters a record.

insertHyperlink

Synopsis

my $Text = $Installation->insertHyperlink ();

Description

Inserts an hyperlink.

MyMethod

Synopsis

my $Text = $Installation->importElements ($Parameter, $NextParameter,
                                          $NextParameters);

Description

Import elements.

exportPage

Synopsis

my $Text = $Installation->exportPage ();

Description

Exports a page.

importPage

Synopsis

my $ReturnValue = $Installation->importPage ($Parameter, $NextParameter,
                                             $NextParameters);

Description

Imports a page.

updatePages

Synopsis

my $ReturnValue = $Installation->updatePages ($Parameter, $NextParameters);

Description

Updates pages.

updateProfileGroups

Synopsis

my $ReturnValue = $Installation->updateProfileGroups ($Parameter,
                                                      $NextParameters);

Description

Updates profile groups.

Examples

updateUSERS_UserType

Synopsis

my $Text = $Installation->updateUSERS_UserType ($Parameter, $NextParameters);

Description

Updates a user's user type.

updateUserType

Synopsis

my $Text = $Installation->updateUSERS_UserType ($Parameter, $NextParameters);

Description

Updates a user's user type.

updatePW

Synopsis

my $Text = $Installation->updatePW ($Parameter, NextParameters);

Description

dumpPages

Synopsis

my $Text = $Installation->dumpPages ();

Description

Dumps pages marked as 'upload'.

createUser

Synopsis

my $Text = $Installation->createUser ($Parameter, NextParameters);

Description

MyMethod

Synopsis

my $Text = $Installation->createServer ($NextParameter, $NextParameters);

Description

Creates an application server.

_createServer_docs

Synopsis

my $Text = $Installation->_createServer_docs ($ProcessName);

Description

Creates an application server's DocumentRoot.

_createServer_etc

Synopsis

my $Text = $Installation->_createServer_etc ($ProcessName);

Description

Creates an application server's etc files.

_createServer_tables

Synopsis

my $Text = $Installation->_createServer_tables ();

Description

Creates an application server's table files.

deleteServer

Synopsis

my $ReturnValue = $Installation->deleteServer ();

Description

Deletes an application server.

encryptFile

Synopsis

my $Text = $Installation->encryptFile ($FileName);

Description

Encrypts a file.

decryptFile

Synopsis

my $Text = $Installation->decryptFile ($FileName);

Description

Decrypts a file.

crypt3

Synopsis

my $cyphertext, 0, $size) = $Installation->crypt3 ($Installation, $plaintext,
                                                   $Passphrase, $Flag);

Description

The crypt3 function.

1