ApplicationWizard

java.lang.Object
- com.manydesigns.portofino.stripes.AbstractActionBean
- - com.manydesigns.portofino.pageactions.AbstractPageAction
  - - com.manydesigns.portofino.actions.admin.appwizard.ApplicationWizard

All Implemented Interfaces:

DispatchElement, PageAction, ActionBean
```
@UrlBinding(value="/actions/admin/wizard")
public class ApplicationWizard
extends AbstractPageAction
```
Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ApplicationWizard.Step
- Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
  AbstractPageAction.TerminalResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApplicationWizard.Step`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`adminGroupName`
`protected List<Table>`	`allTables`
`File`	`appDir`
`protected com.google.common.collect.ListMultimap<Table,Reference>`	`children`
`protected ConnectionProvider`	`connectionProvider`
`protected SelectField`	`connectionProviderField`
`protected Form`	`connectionProviderForm`
`protected String`	`connectionProviderName`
`protected String`	`connectionProviderType`
`static String`	`copyright`
`protected Database`	`database`
`protected int`	`depth`
`protected Set<Column>`	`detectedBooleanColumns`
`protected String`	`encryptionAlgorithm`
`protected boolean`	`generateCalendar`
`protected BooleanField`	`generateCalendarField`
`protected String`	`generationStrategy`
`protected String`	`groupIdProperty`
`protected String`	`groupLinkProperty`
`protected String`	`groupNameProperty`
`protected Table`	`groupTable`
`protected String`	`groupTableName`
`static String`	`JDBC`
`static String[]`	`JDBC_CP_FIELDS`
`protected Form`	`jdbcCPForm`
`static String`	`JNDI`
`static String[]`	`JNDI_CP_FIELDS`
`protected Form`	`jndiCPForm`
`static int`	`LARGE_RESULT_SET_THRESHOLD`
`protected Map<Table,Boolean>`	`largeResultSet`
`static org.slf4j.Logger`	`logger`
`protected int`	`maxColumnsInSummary`
`protected int`	`maxDepth`
`static int`	`MULTILINE_THRESHOLD`
`static String`	`NO_LINK_TO_PARENT`
`File`	`pagesDir`
`Persistence`	`persistence`
`protected List<Table>`	`roots`
`TableForm`	`rootsForm`
`TableForm`	`schemasForm`
`protected List<SelectableRoot>`	`selectableRoots`
`protected List<SelectableSchema>`	`selectableSchemas`
`protected int`	`step`
`static String`	`URL_BINDING`
`protected Form`	`userAndGroupTablesForm`
`protected String`	`userEmailProperty`
`protected Table`	`userGroupTable`
`protected String`	`userGroupTableName`
`protected String`	`userIdProperty`
`protected String`	`userLinkProperty`
`protected Form`	`userManagementSetupForm`
`protected String`	`userNameProperty`
`protected String`	`userPasswordProperty`
`protected Table`	`userTable`
`protected String`	`userTableName`
`protected String`	`userTokenProperty`

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
CONF_FORM_PREFIX, DEFAULT_LAYOUT_CONTAINER, PAGE_CONFIGURATION_FIELDS, PAGE_CONFIGURATION_FIELDS_NO_DETAIL, pageConfigurationForm, pageInstance, pageTemplate, PORTOFINO_PAGEACTION_EXCEPTION, portofinoConfiguration, returnUrl, script, serverInfo, templates

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean
context

Constructor Summary

Constructors
Constructor and Description

ApplicationWizard()

Constructors
Constructor and Description
`ApplicationWizard()`

Method Summary

Methods
Modifier and Type	Method and Description
`Resolution`	`afterCreateConnectionProvider()`
`Resolution`	`afterSelectSchemas()`
`Resolution`	`backToSelectSchemas()`
`protected Resolution`	`buildAppForm()`
`Resolution`	`buildApplication()`
`protected void`	`buildCPForms()`
`Resolution`	`configureConnectionProvider()`
`protected void`	`configureEditSchemas()`
`protected Database`	`configureModelSchemas(boolean alwaysUseExistingModel)`
`protected void`	`createChildCrudPage(File dir, Template template, String parentName, Collection<Reference> references, Reference ref, ArrayList<ChildPage> pages)`
`protected Resolution`	`createConnectionProviderForm()`
`protected Page`	`createCrudPage(File dir, Table table, List<ChildPage> childPages, Template template)`
`protected Page`	`createCrudPage(File dir, Table table, String query, List<ChildPage> childPages, Template template, Map<String,String> bindings, String title)`
`protected void`	`createUserManagementSetupForm()`
`protected void`	`detectBooleanColumn(Table table, Column column)`
`protected void`	`detectLargeResultSet(Table table, CrudConfiguration configuration)`
`protected List<Table>`	`determineRoots(com.google.common.collect.Multimap<Table,Reference> children, List<Table> allTables)`
`List<Database>`	`getActiveDatabases()`
`String`	`getAdminGroupName()`
`ConnectionProvider`	`getConnectionProvider()`
`SelectField`	`getConnectionProviderField()`
`Form`	`getConnectionProviderForm()`
`String`	`getConnectionProviderName()`
`String`	`getConnectionProviderType()`
`int`	`getCurrentStepIndex()`
`String`	`getEncryptionAlgorithm()`
`BooleanField`	`getGenerateCalendarField()`
`String`	`getGenerationStrategy()`
`String`	`getGroupIdProperty()`
`String`	`getGroupLinkProperty()`
`String`	`getGroupNameProperty()`
`String`	`getGroupTableName()`
`Form`	`getJdbcCPForm()`
`Form`	`getJndiCPForm()`
`Persistence`	`getPersistence()`
`TableForm`	`getSchemasForm()`
`List<SelectableSchema>`	`getSelectableSchemas()`
`List<ApplicationWizard.Step>`	`getSteps()`
`Form`	`getUserAndGroupTablesForm()`
`String`	`getUserEmailProperty()`
`String`	`getUserGroupTableName()`
`String`	`getUserIdProperty()`
`String`	`getUserLinkProperty()`
`Form`	`getUserManagementSetupForm()`
`String`	`getUserNameProperty()`
`String`	`getUserPasswordProperty()`
`String`	`getUserTableName()`
`String`	`getUserTokenProperty()`
`Resolution`	`goBackFromSelectTables()`
`protected boolean`	`isAtLeastOneSchemaSelected()`
`boolean`	`isGenerateCalendar()`
`boolean`	`isJdbc()`
`boolean`	`isJndi()`
`boolean`	`isNewConnectionProvider()`
`protected boolean`	`isUnsupportedProperty(Column column)`
`void`	`prepare()`
`Resolution`	`preparePage()` A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation.
`Resolution`	`returnToPages()`
`Resolution`	`returnToSelectTables()`
`static Long`	`safeGetLong(ResultSet rs, int index)`
`Resolution`	`selectSchemas()`
`protected Resolution`	`selectSchemasForm()`
`Resolution`	`selectTables()`
`protected Resolution`	`selectTablesForm()`
`Resolution`	`selectUserFields()`
`protected Resolution`	`selectUserFieldsForm()`
`void`	`setAdminGroupName(String adminGroupName)`
`void`	`setConnectionProviderName(String connectionProviderName)`
`void`	`setConnectionProviderType(String connectionProviderType)`
`void`	`setEncryptionAlgorithm(String encryptionAlgorithm)`
`void`	`setGenerateCalendar(boolean generateCalendar)`
`void`	`setGenerationStrategy(String generationStrategy)`
`void`	`setGroupIdProperty(String groupIdProperty)`
`void`	`setGroupLinkProperty(String groupLinkProperty)`
`void`	`setGroupNameProperty(String groupNameProperty)`
`void`	`setGroupTableName(String groupTableName)`
`protected void`	`setQueryTimeout(PreparedStatement statement, int seconds)`
`protected void`	`setupCalendar(List<ChildPage> childPages)`
`protected void`	`setupCalendarField()`
`protected int`	`setupColumn(Column column, CrudConfiguration configuration, int columnsInSummary, String linkToParentProperty)`
`Resolution`	`setupUserManagement()`
`protected void`	`setupUserPages(List<ChildPage> childPages, Template template)`
`protected void`	`setupUsers()`
`void`	`setUserEmailProperty(String userEmailProperty)`
`void`	`setUserGroupTableName(String userGroupTableName)`
`void`	`setUserIdProperty(String userIdProperty)`
`void`	`setUserLinkProperty(String userLinkProperty)`
`void`	`setUserNameProperty(String userNameProperty)`
`void`	`setUserPasswordProperty(String userPasswordProperty)`
`void`	`setUserTableName(String userTableName)`
`void`	`setUserTokenProperty(String userTokenProperty)`
`Resolution`	`start()`
`protected void`	`updateModelFailed(Exception e)`
`protected Resolution`	`userManagementForm()`

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction
acceptsPathParameter, cancel, consumePathFragment, createTemplateSelectionProvider, forwardTo, forwardToPageActionError, forwardToPageActionNotConfigured, getActionAPIPath, getActionPath, getButtons, getConfiguration, getDefaultReturnUrl, getEmbeddedPageActions, getOgnlContext, getPage, getPageConfigurationForm, getPageDescription, getPageInstance, getPages, getPageTemplate, getParent, getPortofinoConfiguration, getResourcePath, getReturnUrl, getScript, getSubResource, initEmbeddedPageActions, isMultipartRequest, prepareConfigurationForms, prepareScript, readPageConfigurationFromRequest, saveConfiguration, setPageConfigurationForm, setPageInstance, setPageTemplate, setReturnUrl, setScript, updatePageConfiguration, updateScript, updateTemplate, validatePageConfiguration

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean
getContext, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction
getContext

Methods inherited from interface net.sourceforge.stripes.action.ActionBean
setContext

Field Detail

URL_BINDING
```
public static final String URL_BINDING
```
See Also:
Constant Field Values

JDBC
```
public static final String JDBC
```
See Also:
Constant Field Values

JNDI
```
public static final String JNDI
```
See Also:
Constant Field Values

NO_LINK_TO_PARENT

public static final String NO_LINK_TO_PARENT

LARGE_RESULT_SET_THRESHOLD
```
public static final int LARGE_RESULT_SET_THRESHOLD
```
See Also:
Constant Field Values

step
```
protected int step
```

connectionProviderField

protected SelectField connectionProviderField

jndiCPForm
```
protected Form jndiCPForm
```

jdbcCPForm
```
protected Form jdbcCPForm
```

connectionProviderForm
```
protected Form connectionProviderForm
```

userAndGroupTablesForm
```
protected Form userAndGroupTablesForm
```

userManagementSetupForm
```
protected Form userManagementSetupForm
```

connectionProviderType

protected String connectionProviderType

connectionProviderName

protected String connectionProviderName

connectionProvider

protected ConnectionProvider connectionProvider

database
```
protected Database database
```

schemasForm
```
public TableForm schemasForm
```

selectableSchemas

protected List<SelectableSchema> selectableSchemas

rootsForm
```
public TableForm rootsForm
```

selectableRoots

protected List<SelectableRoot> selectableRoots

generationStrategy
```
protected String generationStrategy
```

generateCalendarField

protected BooleanField generateCalendarField

generateCalendar
```
protected boolean generateCalendar
```

userTableName
```
protected String userTableName
```

groupTableName
```
protected String groupTableName
```

userGroupTableName
```
protected String userGroupTableName
```

userNameProperty
```
protected String userNameProperty
```

userEmailProperty
```
protected String userEmailProperty
```

userTokenProperty
```
protected String userTokenProperty
```

userIdProperty
```
protected String userIdProperty
```

userPasswordProperty
```
protected String userPasswordProperty
```

encryptionAlgorithm
```
protected String encryptionAlgorithm
```

groupIdProperty
```
protected String groupIdProperty
```

groupNameProperty
```
protected String groupNameProperty
```

groupLinkProperty
```
protected String groupLinkProperty
```

userLinkProperty
```
protected String userLinkProperty
```

adminGroupName
```
protected String adminGroupName
```

roots
```
protected List<Table> roots
```

children

protected com.google.common.collect.ListMultimap<Table,Reference> children

allTables
```
protected List<Table> allTables
```

userTable
```
protected Table userTable
```

groupTable
```
protected Table groupTable
```

userGroupTable
```
protected Table userGroupTable
```

maxColumnsInSummary
```
protected int maxColumnsInSummary
```

maxDepth
```
protected int maxDepth
```

depth
```
protected int depth
```

JDBC_CP_FIELDS

public static final String[] JDBC_CP_FIELDS

JNDI_CP_FIELDS

public static final String[] JNDI_CP_FIELDS

persistence
```
public Persistence persistence
```

pagesDir
```
public File pagesDir
```

appDir
```
public File appDir
```

logger

public static final org.slf4j.Logger logger

MULTILINE_THRESHOLD
```
public static final int MULTILINE_THRESHOLD
```
See Also:
Constant Field Values

detectedBooleanColumns

protected final Set<Column> detectedBooleanColumns

largeResultSet

protected final Map<Table,Boolean> largeResultSet

Constructor Detail
- ApplicationWizard
```
public ApplicationWizard()
```

Method Detail

start

@DefaultHandler
public Resolution start()

createConnectionProviderForm

protected Resolution createConnectionProviderForm()

prepare
```
@Before
public void prepare()
```

getActiveDatabases

public List<Database> getActiveDatabases()

buildCPForms
```
protected void buildCPForms()
```

backToSelectSchemas

public Resolution backToSelectSchemas()

returnToPages
```
public Resolution returnToPages()
```

configureConnectionProvider

public Resolution configureConnectionProvider()

afterCreateConnectionProvider

public Resolution afterCreateConnectionProvider()

selectSchemasForm

protected Resolution selectSchemasForm()

configureEditSchemas

protected void configureEditSchemas()
                             throws Exception

Throws:: Exception

selectSchemas
```
public Resolution selectSchemas()
```

isAtLeastOneSchemaSelected

protected boolean isAtLeastOneSchemaSelected()

updateModelFailed

protected void updateModelFailed(Exception e)

configureModelSchemas

protected Database configureModelSchemas(boolean alwaysUseExistingModel)

isNewConnectionProvider

public boolean isNewConnectionProvider()

afterSelectSchemas

public Resolution afterSelectSchemas()

userManagementForm

protected Resolution userManagementForm()

setupUserManagement

public Resolution setupUserManagement()

createUserManagementSetupForm

protected void createUserManagementSetupForm()

selectUserFields
```
public Resolution selectUserFields()
```

selectUserFieldsForm

protected Resolution selectUserFieldsForm()

selectTablesForm

protected Resolution selectTablesForm()

setupCalendarField
```
protected void setupCalendarField()
```

determineRoots

protected List<Table> determineRoots(com.google.common.collect.Multimap<Table,Reference> children,
                         List<Table> allTables)

selectTables
```
public Resolution selectTables()
```

goBackFromSelectTables

public Resolution goBackFromSelectTables()

buildAppForm
```
protected Resolution buildAppForm()
```

returnToSelectTables

public Resolution returnToSelectTables()

buildApplication
```
public Resolution buildApplication()
```

setupCalendar

protected void setupCalendar(List<ChildPage> childPages)
                      throws Exception

Throws:: Exception

setupUserPages

protected void setupUserPages(List<ChildPage> childPages,
                  Template template)
                       throws Exception

Throws:: Exception

setupUsers
```
protected void setupUsers()
```

createCrudPage

protected Page createCrudPage(File dir,
                  Table table,
                  List<ChildPage> childPages,
                  Template template)
                       throws Exception

Throws:: Exception

createCrudPage

protected Page createCrudPage(File dir,
                  Table table,
                  String query,
                  List<ChildPage> childPages,
                  Template template,
                  Map<String,String> bindings,
                  String title)
                       throws Exception

Throws:: Exception

setupColumn

protected int setupColumn(Column column,
              CrudConfiguration configuration,
              int columnsInSummary,
              String linkToParentProperty)

isUnsupportedProperty

protected boolean isUnsupportedProperty(Column column)

detectBooleanColumn

protected void detectBooleanColumn(Table table,
                       Column column)

detectLargeResultSet

protected void detectLargeResultSet(Table table,
                        CrudConfiguration configuration)

setQueryTimeout

protected void setQueryTimeout(PreparedStatement statement,
                   int seconds)

safeGetLong

public static Long safeGetLong(ResultSet rs,
               int index)
                        throws SQLException

Throws:: SQLException

createChildCrudPage

protected void createChildCrudPage(File dir,
                       Template template,
                       String parentName,
                       Collection<Reference> references,
                       Reference ref,
                       ArrayList<ChildPage> pages)
                            throws Exception

Throws:: Exception

getConnectionProviderField

public SelectField getConnectionProviderField()

getJndiCPForm
```
public Form getJndiCPForm()
```

getJdbcCPForm
```
public Form getJdbcCPForm()
```

getConnectionProvider

public ConnectionProvider getConnectionProvider()

getConnectionProviderName

public String getConnectionProviderName()

setConnectionProviderName

public void setConnectionProviderName(String connectionProviderName)

isJdbc
```
public boolean isJdbc()
```

isJndi
```
public boolean isJndi()
```

getConnectionProviderType

public String getConnectionProviderType()

setConnectionProviderType

public void setConnectionProviderType(String connectionProviderType)

getConnectionProviderForm

public Form getConnectionProviderForm()

getSchemasForm
```
public TableForm getSchemasForm()
```

getSelectableSchemas

public List<SelectableSchema> getSelectableSchemas()

getUserTableName
```
public String getUserTableName()
```

setUserTableName

public void setUserTableName(String userTableName)

getGroupTableName
```
public String getGroupTableName()
```

setGroupTableName

public void setGroupTableName(String groupTableName)

getUserAndGroupTablesForm

public Form getUserAndGroupTablesForm()

getUserManagementSetupForm

public Form getUserManagementSetupForm()

getUserNameProperty
```
public String getUserNameProperty()
```

setUserNameProperty

public void setUserNameProperty(String userNameProperty)

getUserEmailProperty
```
public String getUserEmailProperty()
```

setUserEmailProperty

public void setUserEmailProperty(String userEmailProperty)

getUserTokenProperty
```
public String getUserTokenProperty()
```

setUserTokenProperty

public void setUserTokenProperty(String userTokenProperty)

getUserIdProperty
```
public String getUserIdProperty()
```

setUserIdProperty

public void setUserIdProperty(String userIdProperty)

getUserPasswordProperty

public String getUserPasswordProperty()

setUserPasswordProperty

public void setUserPasswordProperty(String userPasswordProperty)

getGroupIdProperty
```
public String getGroupIdProperty()
```

setGroupIdProperty

public void setGroupIdProperty(String groupIdProperty)

getUserGroupTableName
```
public String getUserGroupTableName()
```

setUserGroupTableName

public void setUserGroupTableName(String userGroupTableName)

getGroupNameProperty
```
public String getGroupNameProperty()
```

setGroupNameProperty

public void setGroupNameProperty(String groupNameProperty)

getGroupLinkProperty
```
public String getGroupLinkProperty()
```

setGroupLinkProperty

public void setGroupLinkProperty(String groupLinkProperty)

getUserLinkProperty
```
public String getUserLinkProperty()
```

setUserLinkProperty

public void setUserLinkProperty(String userLinkProperty)

getAdminGroupName
```
public String getAdminGroupName()
```

setAdminGroupName

public void setAdminGroupName(String adminGroupName)

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

setEncryptionAlgorithm

public void setEncryptionAlgorithm(String encryptionAlgorithm)

getGenerationStrategy
```
public String getGenerationStrategy()
```

setGenerationStrategy

public void setGenerationStrategy(String generationStrategy)

isGenerateCalendar
```
public boolean isGenerateCalendar()
```

setGenerateCalendar

public void setGenerateCalendar(boolean generateCalendar)

getGenerateCalendarField

public BooleanField getGenerateCalendarField()

getPersistence
```
public Persistence getPersistence()
```

preparePage
```
public Resolution preparePage()
```
Description copied from interface: PageAction

A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation. This method is invoked after the PageInstance has been injected by the framework.
Also, this method is invoked on this object after it has been invoked on the PageAction corresponding to the parent page, if any.

Returns:
either null, meaning that the dispatch process is to go forward regularly, or a Resolution to be executed, interrupting normal action invocation.

getSteps

public List<ApplicationWizard.Step> getSteps()

getCurrentStepIndex
```
public int getCurrentStepIndex()
```

Class ApplicationWizard

Nested Class Summary

Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Field Summary

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

Constructor Summary

Method Summary

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

Methods inherited from class java.lang.Object

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction

Methods inherited from interface net.sourceforge.stripes.action.ActionBean

Field Detail

copyright

URL_BINDING

JDBC

JNDI

NO_LINK_TO_PARENT

LARGE_RESULT_SET_THRESHOLD

step

connectionProviderField

jndiCPForm

jdbcCPForm

connectionProviderForm

userAndGroupTablesForm

userManagementSetupForm

connectionProviderType

connectionProviderName

connectionProvider

database

schemasForm

selectableSchemas

rootsForm

selectableRoots

generationStrategy

generateCalendarField

generateCalendar

userTableName

groupTableName

userGroupTableName

userNameProperty

userEmailProperty

userTokenProperty

userIdProperty

userPasswordProperty

encryptionAlgorithm

groupIdProperty

groupNameProperty

groupLinkProperty

userLinkProperty

adminGroupName

roots

children

allTables

userTable

groupTable

userGroupTable

maxColumnsInSummary

maxDepth

depth

JDBC_CP_FIELDS

JNDI_CP_FIELDS

persistence

pagesDir

appDir

logger

MULTILINE_THRESHOLD

detectedBooleanColumns

largeResultSet

Constructor Detail

ApplicationWizard

Method Detail

start

createConnectionProviderForm

prepare

getActiveDatabases

buildCPForms

backToSelectSchemas

returnToPages