org.apache.wiki.ui

Class Installer

java.lang.Object

org.apache.wiki.ui.Installer

public class Installer
extends Object

Manages JSPWiki installation on behalf of admin/Install.jsp. The contents of this class were previously part of Install.jsp.

Since:

2.4.20

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_GROUP
static String	ADMIN_ID
static String	ADMIN_NAME
static String	APP_NAME
static String	INSTALL_ERROR
static String	INSTALL_INFO
static String	INSTALL_WARNING
static String	PAGE_DIR
static String	PROPFILENAME
static String	STORAGE_DIR
static String	TMP_DIR
static String	WORK_DIR

Constructor Summary

Constructors

Constructor and Description
Installer(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	adminExists() Returns true if the administrative user had been created previously.
String	createAdministrator() Creates an administrative user and returns the new password.
String	getPropertiesList() Returns the properties as a "key=value" string separated by newlines
String	getPropertiesPath()
String	getProperty(String key) Returns a property from the WikiEngine's properties.
void	parseProperties()
void	saveProperties()
boolean	validateProperties()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADMIN_ID

public static final String ADMIN_ID

See Also:

Constant Field Values

ADMIN_NAME

public static final String ADMIN_NAME

See Also:

Constant Field Values

INSTALL_INFO

public static final String INSTALL_INFO

See Also:

Constant Field Values

INSTALL_ERROR

public static final String INSTALL_ERROR

See Also:

Constant Field Values

INSTALL_WARNING

public static final String INSTALL_WARNING

See Also:

Constant Field Values

APP_NAME

public static final String APP_NAME

See Also:

Constant Field Values

STORAGE_DIR

public static final String STORAGE_DIR

See Also:

Constant Field Values

PAGE_DIR

public static final String PAGE_DIR

See Also:

Constant Field Values

WORK_DIR

public static final String WORK_DIR

See Also:

Constant Field Values

ADMIN_GROUP

public static final String ADMIN_GROUP

See Also:

Constant Field Values

PROPFILENAME

public static final String PROPFILENAME

See Also:

Constant Field Values

TMP_DIR

public static final String TMP_DIR

Constructor Detail

Installer

public Installer(javax.servlet.http.HttpServletRequest request,
         javax.servlet.ServletConfig config)
          throws IOException

Throws:

IOException

Method Detail

adminExists

public boolean adminExists()

Returns true if the administrative user had been created previously.

Returns:

the result

createAdministrator

public String createAdministrator()
                           throws WikiSecurityException

Creates an administrative user and returns the new password. If the admin user exists, the password will be null.

Returns:

the password

Throws:

WikiSecurityException

getPropertiesList

public String getPropertiesList()

Returns the properties as a "key=value" string separated by newlines

Returns:

the string

getPropertiesPath

public String getPropertiesPath()

getProperty

public String getProperty(String key)

Returns a property from the WikiEngine's properties.

Parameters:

key - the property key

Returns:

the property value

parseProperties

public void parseProperties()
                     throws Exception

Throws:

Exception

saveProperties

public void saveProperties()

validateProperties

public boolean validateProperties()
                           throws Exception

Throws:

Exception