AbstractPageAction

java.lang.Object
- com.manydesigns.portofino.stripes.AbstractActionBean
- - com.manydesigns.portofino.pageactions.AbstractPageAction

All Implemented Interfaces:

DispatchElement, PageAction, ActionBean

Direct Known Subclasses:

AbstractCrudAction, ActivityStreamAction, ApplicationWizard, CalendarAction, ChartJsAction, CustomAction, FormAction, GalleryAction, JFreeChartAction, ManyToManyAction, MapAction, PageAdminAction, TableFormAction, TextAction
```
public abstract class AbstractPageAction
extends AbstractActionBean
implements PageAction
```
Convenient abstract base class for PageActions. It has fields to hold values of properties specified by the PageAction interface as well as other useful objects injected by the framework. It provides standard implementations of many of the PageAction methods, as well as important utility methods to handle hierarchical relations among pages, such as embedding.

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 AbstractPageAction.TerminalResource

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractPageAction.TerminalResource`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONF_FORM_PREFIX`
`static String`	`copyright`
`static String`	`DEFAULT_LAYOUT_CONTAINER`
`static org.slf4j.Logger`	`logger`
`static String[][]`	`PAGE_CONFIGURATION_FIELDS`
`static String[][]`	`PAGE_CONFIGURATION_FIELDS_NO_DETAIL`
`Form`	`pageConfigurationForm` The Form to configure standard page settings.
`PageInstance`	`pageInstance` The PageInstance property.
`protected String`	`pageTemplate` The page template to use.
`static String`	`PORTOFINO_PAGEACTION_EXCEPTION`
`Configuration`	`portofinoConfiguration` The global configuration object.
`String`	`returnUrl` The URL the user cakeme from within the application.
`protected String`	`script` The Groovy script for this page.
`ServerInfo`	`serverInfo` Information about the web server.
`TemplateRegistry`	`templates` The templates registry.

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

Constructor Summary

Constructors
Constructor and Description

AbstractPageAction()

Constructors
Constructor and Description
`AbstractPageAction()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptsPathParameter()`
`Resolution`	`cancel()`
`DispatchElement`	`consumePathFragment(String pathFragment)` This is called to process a piece (fragment) of the requested URL.
`protected SelectionProvider`	`createTemplateSelectionProvider()`
`Resolution`	`forwardTo(String page)` Deprecated. use simply new ForwardResolution(page) instead.
`Resolution`	`forwardToPageActionError(Throwable e)` Returns a ForwardResolution to a standard page that reports an exception with an error message saying that the pageaction is not properly configured.
`Resolution`	`forwardToPageActionNotConfigured()` Returns a ForwardResolution to a standard page with an error message saying that the pageaction is not properly configured.
`String`	`getActionAPIPath()`
`String`	`getActionPath()`
`List`	`getButtons()`
`Object`	`getConfiguration()`
`protected String`	`getDefaultReturnUrl()`
`org.apache.commons.collections.MultiMap`	`getEmbeddedPageActions()`
`Map`	`getOgnlContext()`
`Page`	`getPage()`
`Form`	`getPageConfigurationForm()`
`Map<String,Object>`	`getPageDescription()` Returns a description of this PageAction.
`PageInstance`	`getPageInstance()` Returns the PageInstance of this element.
`NavigationItem`	`getPages()`
`String`	`getPageTemplate()`
`PageAction`	`getParent()`
`Configuration`	`getPortofinoConfiguration()`
`String`	`getResourcePath(String resource)` Returns the path inside the web application of a resource relative to this action's directory.
`String`	`getReturnUrl()` This is the URL (typically relative to the application, i.e. without scheme, host, and port components) where the action should redirect to after handling an event.
`String`	`getScript()`
`Object`	`getSubResource(String pathFragment)` REST support.
`org.apache.commons.collections.MultiMap`	`initEmbeddedPageActions()` Lifecycle method called by templates that can include embedded pages to compute the set of pages to embed and their locations and order.
`boolean`	`isMultipartRequest()`
`protected void`	`prepareConfigurationForms()` Sets up the Elements form(s)
`protected void`	`prepareScript()`
`protected void`	`readPageConfigurationFromRequest()` Reads the page configuration form values from the request.
`protected boolean`	`saveConfiguration(Object configuration)` Utility method to save the configuration object to a file in this page's directory.
`void`	`setPageConfigurationForm(Form pageConfigurationForm)`
`void`	`setPageInstance(PageInstance pageInstance)` Sets the PageInstance of this element.
`void`	`setPageTemplate(String pageTemplate)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setScript(String script)`
`protected boolean`	`updatePageConfiguration()` Updates the page with values from the page configuration.
`protected void`	`updateScript()`
`protected void`	`updateTemplate(File directory, FileFilter filter, EditPage edit)` Recursively applies a template to a subtree of pages.
`protected boolean`	`validatePageConfiguration()` Validates the page configuration form values.

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, preparePage

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

- Field Detail
  - copyright
```
public static final String copyright
```
    See Also:
    Constant Field Values
  - DEFAULT_LAYOUT_CONTAINER
```
public static final String DEFAULT_LAYOUT_CONTAINER
```
    See Also:
    Constant Field Values
  - PAGE_CONFIGURATION_FIELDS
```
public static final String[][] PAGE_CONFIGURATION_FIELDS
```
  - PAGE_CONFIGURATION_FIELDS_NO_DETAIL
```
public static final String[][] PAGE_CONFIGURATION_FIELDS_NO_DETAIL
```
  - PORTOFINO_PAGEACTION_EXCEPTION
```
public static final String PORTOFINO_PAGEACTION_EXCEPTION
```
    See Also:
    Constant Field Values
  - CONF_FORM_PREFIX
```
public static final String CONF_FORM_PREFIX
```
    See Also:
    Constant Field Values
  - pageInstance
```
public PageInstance pageInstance
```
    The PageInstance property. Injected.
  - portofinoConfiguration
```
public Configuration portofinoConfiguration
```
    The global configuration object. Injected.
  - templates
```
public TemplateRegistry templates
```
    The templates registry. Injected.
  - serverInfo
```
public ServerInfo serverInfo
```
    Information about the web server. Injected.
  - pageTemplate
```
protected String pageTemplate
```
    The page template to use. It can be set using a request parameter. If not set, the one from page.xml is used.
  - returnUrl
```
public String returnUrl
```
    The URL the user cakeme from within the application.
  - script
```
protected String script
```
    The Groovy script for this page.
  - pageConfigurationForm
```
public Form pageConfigurationForm
```
    The Form to configure standard page settings.
  - logger
```
public static final org.slf4j.Logger logger
```
- Constructor Detail
  - AbstractPageAction
```
public AbstractPageAction()
```
- Method Detail
  - saveConfiguration
```
protected boolean saveConfiguration(Object configuration)
```
    Utility method to save the configuration object to a file in this page's directory.
    
    Parameters:
    configuration - the object to save. It must be in a state that will produce a valid XML document.
    
    Returns:
    true if the object was correctly saved, false otherwise.
  - consumePathFragment
```
public DispatchElement consumePathFragment(String pathFragment)
```
    This is called to process a piece (fragment) of the requested URL. If the fragment matches a child page, that page is instantiated and initialized. Otherwise, the fragment is taken to be a parameter for the current page. Subclasses can override this method if they want to handle child pages differently (e.g. having them stored elsewhere).
    
    Specified by:
    
    consumePathFragment in interface DispatchElement
    
    Parameters:
    pathFragment - the fragment to process. In path /foo/bar/baz, foo, bar and baz are three different fragments.
    
    Returns:
    the object that will potentially continue path dispatch if there are other fragments to consume. This is either a child page or this. A null return value means that the dispatch failed (no child page exists and this page does not accept parameters).
  - acceptsPathParameter
```
protected boolean acceptsPathParameter()
```
  - getSubResource
```
@Path(value="{pathFragment}")
public Object getSubResource(@PathParam(value="pathFragment")
                              String pathFragment)
```
    REST support. Called by the JAX-RS implementation to handle a path fragment.
    
    Parameters:
    pathFragment - the path fragment.
    
    Returns:
    @see #consumePathFragment(String)
  - getParent
```
public PageAction getParent()
```
    Specified by:
    
    getParent in interface PageAction
  - getPages
```
@Path(value=":pages")
@GET
@Produces(value="application/json;charset=UTF-8")
public NavigationItem getPages()
```
  - initEmbeddedPageActions
```
public org.apache.commons.collections.MultiMap initEmbeddedPageActions()
```
    Description copied from interface: PageAction
    
    Lifecycle method called by templates that can include embedded pages to compute the set of pages to embed and their locations and order.
    
    Specified by:
    
    initEmbeddedPageActions in interface PageAction
    
    Returns:
    a multi-valued map layout-container: String -> embedded-pages: list(EmbeddedPageAction)
  - getResourcePath
```
public String getResourcePath(String resource)
```
    Returns the path inside the web application of a resource relative to this action's directory. E.g. getResourcePath("my.jsp") might return /WEB-INF/pages/this/that/my.jsp.
    
    Parameters:
    resource - the path of the resource, relative to this action's directory.
    
    Returns:
    the path of the resource, relative to the web application root.
  - getActionPath
```
public String getActionPath()
```
  - getActionAPIPath
```
public String getActionAPIPath()
```
  - getEmbeddedPageActions
```
public org.apache.commons.collections.MultiMap getEmbeddedPageActions()
```
  - isMultipartRequest
```
public boolean isMultipartRequest()
```
  - getPageConfigurationForm
```
public Form getPageConfigurationForm()
```
  - setPageConfigurationForm
```
public void setPageConfigurationForm(Form pageConfigurationForm)
```
  - cancel
```
public Resolution cancel()
```
  - getPageInstance
```
public PageInstance getPageInstance()
```
    Description copied from interface: DispatchElement
    
    Returns the PageInstance of this element.
    
    Specified by:
    
    getPageInstance in interface DispatchElement
  - setPageInstance
```
public void setPageInstance(PageInstance pageInstance)
```
    Description copied from interface: DispatchElement
    
    Sets the PageInstance of this element. Invoked automatically by the framework.
    
    Specified by:
    
    setPageInstance in interface DispatchElement
  - getPage
```
public Page getPage()
```
  - getReturnUrl
```
public String getReturnUrl()
```
    Description copied from interface: PageAction
    
    This is the URL (typically relative to the application, i.e. without scheme, host, and port components) where the action should redirect to after handling an event.
    
    Specified by:
    
    getReturnUrl in interface PageAction
    
    Returns:
    the return URL.
  - getDefaultReturnUrl
```
protected String getDefaultReturnUrl()
```
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - prepareConfigurationForms
```
protected void prepareConfigurationForms()
```
    Sets up the Elements form(s)
  - createTemplateSelectionProvider
```
protected SelectionProvider createTemplateSelectionProvider()
```
  - readPageConfigurationFromRequest
```
protected void readPageConfigurationFromRequest()
```
    Reads the page configuration form values from the request. Can be called to re-use the standard page configuration form.
  - validatePageConfiguration
```
protected boolean validatePageConfiguration()
```
    Validates the page configuration form values. Can be called to re-use the standard page configuration form.
    
    Returns:
    true iff the form was valid.
  - updatePageConfiguration
```
protected boolean updatePageConfiguration()
```
    Updates the page with values from the page configuration. Can be called to re-use the standard page configuration form. Should be called only after validatePageConfiguration() returned true.
    
    Returns:
    true iff the page was correctly saved.
  - updateTemplate
```
protected void updateTemplate(File directory,
                  FileFilter filter,
                  EditPage edit)
```
    Recursively applies a template to a subtree of pages.
    
    Parameters:
    directory - the starting page directory (root of the subtree).
    filter - the filter for selecting pages.
    edit - the object holding template configuration.
  - prepareScript
```
protected void prepareScript()
```
  - updateScript
```
protected void updateScript()
```
  - getOgnlContext
```
public Map getOgnlContext()
```
  - getScript
```
public String getScript()
```
  - setScript
```
public void setScript(String script)
```
  - getPortofinoConfiguration
```
public Configuration getPortofinoConfiguration()
```
  - forwardTo
```
@Deprecated
public Resolution forwardTo(String page)
```
    Deprecated. use simply new ForwardResolution(page) instead.
    
    Returns a ForwardResolution to the given page.
    
    Parameters:
    page - the path to the page, from the root of the webapp.
    
    Returns:
    a Resolution that forwards to the given page.
  - forwardToPageActionNotConfigured
```
public Resolution forwardToPageActionNotConfigured()
```
    Returns a ForwardResolution to a standard page with an error message saying that the pageaction is not properly configured.
  - forwardToPageActionError
```
public Resolution forwardToPageActionError(Throwable e)
```
    Returns a ForwardResolution to a standard page that reports an exception with an error message saying that the pageaction is not properly configured.
  - getPageTemplate
```
public String getPageTemplate()
```
    Specified by:
    
    getPageTemplate in interface PageAction
  - setPageTemplate
```
public void setPageTemplate(String pageTemplate)
```
  - getButtons
```
@Path(value=":buttons")
@GET
@Produces(value="application/json;charset=UTF-8")
public List getButtons()
```
  - getConfiguration
```
@Path(value=":configuration")
@GET
@Produces(value="application/json;charset=UTF-8")
public Object getConfiguration()
```
  - getPageDescription
```
@Path(value=":page")
@GET
@Produces(value="application/json;charset=UTF-8")
public Map<String,Object> getPageDescription()
```
    Returns a description of this PageAction.
    
    Returns:
    the page's description as JSON.
    Since:
    
    4.2.1

Class AbstractPageAction

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

DEFAULT_LAYOUT_CONTAINER

PAGE_CONFIGURATION_FIELDS

PAGE_CONFIGURATION_FIELDS_NO_DETAIL

PORTOFINO_PAGEACTION_EXCEPTION

CONF_FORM_PREFIX

pageInstance

portofinoConfiguration

templates

serverInfo

pageTemplate

returnUrl

script

pageConfigurationForm

logger

Constructor Detail

AbstractPageAction

Method Detail

saveConfiguration

consumePathFragment

acceptsPathParameter

getSubResource

getParent

getPages

initEmbeddedPageActions

getResourcePath

getActionPath

getActionAPIPath

getEmbeddedPageActions

isMultipartRequest

getPageConfigurationForm

setPageConfigurationForm

cancel

getPageInstance

setPageInstance

getPage

getReturnUrl

getDefaultReturnUrl

setReturnUrl

prepareConfigurationForms

createTemplateSelectionProvider

readPageConfigurationFromRequest

validatePageConfiguration

updatePageConfiguration

updateTemplate

prepareScript

updateScript

getOgnlContext

getScript

setScript

getPortofinoConfiguration

forwardTo

forwardToPageActionNotConfigured

forwardToPageActionError

getPageTemplate

setPageTemplate

getButtons

getConfiguration

getPageDescription