org.openmrs.web.filter.initialization

Class InitializationWizardModel

java.lang.Object

org.openmrs.web.filter.initialization.InitializationWizardModel

public class InitializationWizardModel
extends java.lang.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
java.lang.Boolean	addDemoData Does the user want to add the demo data to the database?
static java.lang.String	ADMIN_DEFAULT_PASSWORD
java.lang.String	adminUserPassword Password for the admin user if the database was created now
java.lang.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.
java.lang.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)
java.lang.String	createDatabasePassword Filled in on databasesetup.vm
java.lang.Boolean	createDatabaseUser if the user asked us to create the user for openmrs
java.lang.String	createDatabaseUsername Filled in on databasesetup.vm
java.lang.Boolean	createTables Asked for on the databasetablesanduser.vm page to know if their existing database has the tables or not
java.lang.String	createUserPassword DB user that can create an openmrs db user Filled in on databasetablesanduser.vm
java.lang.String	createUserUsername DB user that can create an openmrs db user Filled in on databasetablesanduser.vm
java.lang.String	currentDatabasePassword The password of a user that exists that can read/write to openmrs.
java.lang.String	currentDatabaseUsername The username of a user that exists that can read/write to openmrs.
java.lang.Integer	currentStepNumber The current step.
java.lang.String	databaseConnection Filled out by user on the databasesetup.vm page Looks like:
java.lang.String	databaseDriver Optional Database Driver string filled in on databasesetup.vm
java.lang.String	databaseName Filled out by the user on the databasesetup.vm page
java.lang.String	databaseRootPassword MySQL root account password used for simple installation.
static java.lang.String	DEFAULT_DATABASE_NAME Default database name to use unless user specifies another in the wizard or they are creating a test installation
static java.lang.String	footerTemplate
java.lang.Boolean	hasCurrentDatabaseUser True/false marker for the question"Do you currently have a database user other than root that has read/write access"
java.lang.Boolean	hasCurrentOpenmrsDatabase True/false marker for the question "Do you currently have an OpenMRS database installed"
static java.lang.String	headerTemplate
java.lang.String	implementationId Implementation ID.
java.lang.String	implementationIdDescription Text describing the implementation.
java.lang.String	implementationIdName Implementation name.
java.lang.String	implementationIdPassPhrase Pass phrase used to validate who uses your implementation ID.
java.lang.Boolean	importTestData Enables importing test data from the remote server
static java.lang.String	INSTALL_METHOD_ADVANCED
static java.lang.String	INSTALL_METHOD_AUTO
static java.lang.String	INSTALL_METHOD_SIMPLE
static java.lang.String	INSTALL_METHOD_TESTING
java.lang.String	installMethod
java.lang.String	localeToSave
java.lang.Boolean	moduleWebAdmin Asked for on the otherproperties.vm page to know if the allow_web_admin runtime property is true/false
java.lang.Integer	numberOfSteps The total number of steps.
java.lang.String	remotePassword The password to use to authenticate to the remote system
java.lang.String	remoteUrl The url to the remote system
java.lang.String	remoteUsername The username to use to authenticate to the remote system
java.lang.String	runtimePropertiesPath The location of the runtime properties file (only read by the velocity scripts)
java.lang.String	setupPageUrl
java.util.List<WizardTask>	tasksToExecute The tasks to be executed that the user selected from the wizard's prompts
java.util.List<java.lang.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

headerTemplate

public static final java.lang.String headerTemplate

See Also:

Constant Field Values

footerTemplate

public static final java.lang.String footerTemplate

See Also:

Constant Field Values

INSTALL_METHOD_SIMPLE

public static final java.lang.String INSTALL_METHOD_SIMPLE

See Also:

Constant Field Values

INSTALL_METHOD_ADVANCED

public static final java.lang.String INSTALL_METHOD_ADVANCED

See Also:

Constant Field Values

INSTALL_METHOD_TESTING

public static final java.lang.String INSTALL_METHOD_TESTING

See Also:

Constant Field Values

INSTALL_METHOD_AUTO

public static final java.lang.String INSTALL_METHOD_AUTO

See Also:

Constant Field Values

ADMIN_DEFAULT_PASSWORD

public static final java.lang.String ADMIN_DEFAULT_PASSWORD

See Also:

Constant Field Values

DEFAULT_DATABASE_NAME

public static final java.lang.String DEFAULT_DATABASE_NAME

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

See Also:

Constant Field Values

workLog

public java.util.List<java.lang.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 java.lang.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 java.lang.String runtimePropertiesPath

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

installMethod

public java.lang.String installMethod

hasCurrentOpenmrsDatabase

public java.lang.Boolean hasCurrentOpenmrsDatabase

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

hasCurrentDatabaseUser

public java.lang.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 java.lang.String databaseName

Filled out by the user on the databasesetup.vm page

databaseConnection

public java.lang.String databaseConnection

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

databaseDriver

public java.lang.String databaseDriver

Optional Database Driver string filled in on databasesetup.vm

databaseRootPassword

public java.lang.String databaseRootPassword

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

createDatabaseUsername

public java.lang.String createDatabaseUsername

Filled in on databasesetup.vm

createDatabasePassword

public java.lang.String createDatabasePassword

Filled in on databasesetup.vm

createUserUsername

public java.lang.String createUserUsername

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

createUserPassword

public java.lang.String createUserPassword

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

currentDatabaseUsername

public java.lang.String currentDatabaseUsername

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

currentDatabasePassword

public java.lang.String currentDatabasePassword

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

createTables

public java.lang.Boolean createTables

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

createDatabaseUser

public java.lang.Boolean createDatabaseUser

if the user asked us to create the user for openmrs

importTestData

public java.lang.Boolean importTestData

Enables importing test data from the remote server

addDemoData

public java.lang.Boolean addDemoData

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

moduleWebAdmin

public java.lang.Boolean moduleWebAdmin

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

autoUpdateDatabase

public java.lang.Boolean autoUpdateDatabase

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

adminUserPassword

public java.lang.String adminUserPassword

Password for the admin user if the database was created now

implementationIdName

public java.lang.String implementationIdName

Implementation name.

implementationId

public java.lang.String implementationId

Implementation ID.

implementationIdPassPhrase

public java.lang.String implementationIdPassPhrase

Pass phrase used to validate who uses your implementation ID.

implementationIdDescription

public java.lang.String implementationIdDescription

Text describing the implementation.

setupPageUrl

public java.lang.String setupPageUrl

tasksToExecute

public java.util.List<WizardTask> tasksToExecute

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

localeToSave

public java.lang.String localeToSave

remoteUrl

public java.lang.String remoteUrl

The url to the remote system

remoteUsername

public java.lang.String remoteUsername

The username to use to authenticate to the remote system

remotePassword

public java.lang.String remotePassword

The password to use to authenticate to the remote system

currentStepNumber

public java.lang.Integer currentStepNumber

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

numberOfSteps

public java.lang.Integer numberOfSteps

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

Constructor Detail

InitializationWizardModel

public InitializationWizardModel()