org.openmrs.web.filter.initialization

Class InitializationWizardModel

java.lang.Object

org.openmrs.web.filter.initialization.InitializationWizardModel

public class InitializationWizardModel
extends Object

The InitializationFilter uses this model object to hold all properties that are edited by the user in the wizard. All attributes on this model object are added to all templates rendered by the InitializationFilter.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	addDemoData Does the user want to add the demo data to the database?
static String	ADMIN_DEFAULT_PASSWORD
String	adminUserPassword Password for the admin user if the database was created now
Boolean	autoUpdateDatabase Asked for on otherproperties.vm page to know if the runtime property for auto updating their db is true/false
boolean	canCreate Whether the runtime properties file could possible be created.
String	cannotCreateErrorMessage Error message from not being able to create the runtime properties file (only read by the velocity scripts)
boolean	canWrite Whether the runtime file can be edited (only read by the velocity scripts)
String	createDatabasePassword Filled in on databasesetup.vm
Boolean	createDatabaseUser if the user asked us to create the user for openmrs
String	createDatabaseUsername Filled in on databasesetup.vm
Boolean	createTables Asked for on the databasetablesanduser.vm page to know if their existing database has the tables or not
String	createUserPassword DB user that can create an openmrs db user Filled in on databasetablesanduser.vm
String	createUserUsername DB user that can create an openmrs db user Filled in on databasetablesanduser.vm
String	currentDatabasePassword The password of a user that exists that can read/write to openmrs.
String	currentDatabaseUsername The username of a user that exists that can read/write to openmrs.
Integer	currentStepNumber The current step. e.g Step 1 of ...
String	databaseConnection Filled out by user on the databasesetup.vm page Looks like:
String	databaseDriver Optional Database Driver string filled in on databasesetup.vm
String	databaseName Filled out by the user on the databasesetup.vm page
String	databaseRootPassword MySQL root account password used for simple installation.
static String	DEFAULT_DATABASE_NAME Default database name to use unless user specifies another in the wizard or they are creating a test installation
static String	FOOTER_TEMPLATE
Boolean	hasCurrentDatabaseUser True/false marker for the question"Do you currently have a database user other than root that has read/write access"
Boolean	hasCurrentOpenmrsDatabase True/false marker for the question "Do you currently have an OpenMRS database installed"
static String	HEADER_TEMPLATE
String	implementationId Implementation ID.
String	implementationIdDescription Text describing the implementation.
String	implementationIdName Implementation name.
String	implementationIdPassPhrase Pass phrase used to validate who uses your implementation ID.
Boolean	importTestData Enables importing test data from the remote server
static String	INSTALL_METHOD_ADVANCED
static String	INSTALL_METHOD_AUTO
static String	INSTALL_METHOD_SIMPLE
static String	INSTALL_METHOD_TESTING
String	installMethod
String	localeToSave
Boolean	moduleWebAdmin Asked for on the otherproperties.vm page to know if the allow_web_admin runtime property is true/false
Integer	numberOfSteps The total number of steps. e.g Step ... of 5
static String	OPENMRS_VERSION
String	remotePassword The password to use to authenticate to the remote system
String	remoteUrl The url to the remote system
String	remoteUsername The username to use to authenticate to the remote system
String	runtimePropertiesPath The location of the runtime properties file (only read by the velocity scripts)
String	setupPageUrl
List<WizardTask>	tasksToExecute The tasks to be executed that the user selected from the wizard's prompts
List<String>	workLog Records completed tasks and are displayed at the top of the page upon error

Constructor Summary

Constructors

Constructor and Description
InitializationWizardModel()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_TEMPLATE

public static final String HEADER_TEMPLATE

See Also:

Constant Field Values

FOOTER_TEMPLATE

public static final String FOOTER_TEMPLATE

See Also:

Constant Field Values

INSTALL_METHOD_SIMPLE

public static final String INSTALL_METHOD_SIMPLE

See Also:

Constant Field Values

INSTALL_METHOD_ADVANCED

public static final String INSTALL_METHOD_ADVANCED

See Also:

Constant Field Values

INSTALL_METHOD_TESTING

public static final String INSTALL_METHOD_TESTING

See Also:

Constant Field Values

INSTALL_METHOD_AUTO

public static final String INSTALL_METHOD_AUTO

See Also:

Constant Field Values

ADMIN_DEFAULT_PASSWORD

public static final String ADMIN_DEFAULT_PASSWORD

See Also:

Constant Field Values

OPENMRS_VERSION

public static final String OPENMRS_VERSION

DEFAULT_DATABASE_NAME

public static final String DEFAULT_DATABASE_NAME

Default database name to use unless user specifies another in the wizard or they are creating a test installation

workLog

public List<String> workLog

Records completed tasks and are displayed at the top of the page upon error

canCreate

public boolean canCreate

Whether the runtime properties file could possible be created. (only read by the velocity scripts)

cannotCreateErrorMessage

public String cannotCreateErrorMessage

Error message from not being able to create the runtime properties file (only read by the velocity scripts)

canWrite

public boolean canWrite

Whether the runtime file can be edited (only read by the velocity scripts)

runtimePropertiesPath

public String runtimePropertiesPath

The location of the runtime properties file (only read by the velocity scripts)

installMethod

public String installMethod

hasCurrentOpenmrsDatabase

public Boolean hasCurrentOpenmrsDatabase

True/false marker for the question "Do you currently have an OpenMRS database installed"

hasCurrentDatabaseUser

public Boolean hasCurrentDatabaseUser

True/false marker for the question"Do you currently have a database user other than root that has read/write access"

databaseName

public String databaseName

Filled out by the user on the databasesetup.vm page

databaseConnection

public String databaseConnection

Filled out by user on the databasesetup.vm page Looks like:

databaseDriver

public String databaseDriver

Optional Database Driver string filled in on databasesetup.vm

databaseRootPassword

public String databaseRootPassword

MySQL root account password used for simple installation. Filled in simplesetup.vm.

createDatabaseUsername

public String createDatabaseUsername

Filled in on databasesetup.vm

createDatabasePassword

public String createDatabasePassword

Filled in on databasesetup.vm

createUserUsername

public String createUserUsername

DB user that can create an openmrs db user Filled in on databasetablesanduser.vm

createUserPassword

public String createUserPassword

DB user that can create an openmrs db user Filled in on databasetablesanduser.vm

currentDatabaseUsername

public String currentDatabaseUsername

The username of a user that exists that can read/write to openmrs. Entered on databasetablesanduser page

currentDatabasePassword

public String currentDatabasePassword

The password of a user that exists that can read/write to openmrs. Entered on databasetablesanduser page

createTables

public Boolean createTables

Asked for on the databasetablesanduser.vm page to know if their existing database has the tables or not

createDatabaseUser

public Boolean createDatabaseUser

if the user asked us to create the user for openmrs

importTestData

public Boolean importTestData

Enables importing test data from the remote server

addDemoData

public Boolean addDemoData

Does the user want to add the demo data to the database?

moduleWebAdmin

public Boolean moduleWebAdmin

Asked for on the otherproperties.vm page to know if the allow_web_admin runtime property is true/false

autoUpdateDatabase

public Boolean autoUpdateDatabase

Asked for on otherproperties.vm page to know if the runtime property for auto updating their db is true/false

adminUserPassword

public String adminUserPassword

Password for the admin user if the database was created now

implementationIdName

public String implementationIdName

Implementation name.

implementationId

public String implementationId

Implementation ID.

implementationIdPassPhrase

public String implementationIdPassPhrase

Pass phrase used to validate who uses your implementation ID.

implementationIdDescription

public String implementationIdDescription

Text describing the implementation.

setupPageUrl

public String setupPageUrl

tasksToExecute

public List<WizardTask> tasksToExecute

The tasks to be executed that the user selected from the wizard's prompts

localeToSave

public String localeToSave

remoteUrl

public String remoteUrl

The url to the remote system

remoteUsername

public String remoteUsername

The username to use to authenticate to the remote system

remotePassword

public String remotePassword

The password to use to authenticate to the remote system

currentStepNumber

public Integer currentStepNumber

The current step. e.g Step 1 of ...

numberOfSteps

public Integer numberOfSteps

The total number of steps. e.g Step ... of 5

Constructor Detail

InitializationWizardModel

public InitializationWizardModel()