fr.paris.lutece.portal.util.mvc.xpage

Class MVCApplication

java.lang.Object

fr.paris.lutece.portal.util.mvc.xpage.MVCApplication

All Implemented Interfaces:

XPageApplication, Serializable

public abstract class MVCApplication
extends Object
implements XPageApplication

MVC XPage Application

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MVCApplication()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addError(String strMessage) Add an error message.
protected void	addError(String strMessageKey, Locale locale) Add an error message.
protected void	addInfo(String strMessage) Add an info message.
protected void	addInfo(String strMessageKey, Locale locale) Add an info message.
protected XPage	download(byte[] data, String strFilename, String strContentType) Initiates a download of a byte array
protected XPage	download(String strData, String strFilename, String strContentType) Initiates a file download
protected void	fillCommons(Map<String,Object> model) Fill the model with commons objects used in templates
protected String	getActionFullUrl(String strAction) Get Action URL
protected String	getActionUrl(String strAction) Get Action URL
protected String	getDefaultPagePath(Locale locale) Returns the default page path
protected String	getDefaultPageTitle(Locale locale) Returns the default page title
protected Locale	getLocale(javax.servlet.http.HttpServletRequest request) Default getLocale() implementation.
protected Map<String,Object>	getModel() Get a model Object filled with default values
XPage	getPage(javax.servlet.http.HttpServletRequest request, int nMode, Plugin plugin) Returns the content of the page
protected String	getViewFullUrl(String strView) Gets the view URL with the JSP path
protected String	getViewUrl(String strView) Get a View URL
protected XPage	getXPage() Returns a new XPage object with default values
protected XPage	getXPage(String strTemplate) Returns a new XPage object with default values and the content filled by a template
protected XPage	getXPage(String strTemplate, Locale locale) Returns a new XPage object with default values and the content filled by a template using a default model and for a given locale
protected XPage	getXPage(String strTemplate, Locale locale, Map<String,Object> model) Returns a new XPage object with default values and the content filled by a template using a given model and for a given locale
protected String	getXPageName() Returns the XPage name
protected void	populate(Object bean, javax.servlet.http.HttpServletRequest request) Populate a bean using parameters in http request
protected XPage	redirect(javax.servlet.http.HttpServletRequest request, String strTarget) Redirect to requested page
protected XPage	redirect(javax.servlet.http.HttpServletRequest request, String strView, Map<String,String> additionalParameters) Redirect to an url defined by given parameters
protected XPage	redirect(javax.servlet.http.HttpServletRequest request, String strView, String strParameter, int nValue) Redirect to an url defined by given parameters
protected XPage	redirect(javax.servlet.http.HttpServletRequest request, String strView, String strParameter1, int nValue1, String strParameter2, int nValue2) Redirect to an url defined by given parameters
protected XPage	redirectMessageBox(javax.servlet.http.HttpServletRequest request, MVCMessageBox messageBox) Redirect to a Message Box page
protected XPage	redirectView(javax.servlet.http.HttpServletRequest request, String strView) Redirect to requested view
protected XPage	responseJSON(String strJSON) Return a response as JSON content
protected XPage	responseXML(String strXML) Return a response as XML content
protected <T> boolean	validateBean(T bean) Validate a bean.
protected <T> boolean	validateBean(T bean, Locale locale) Validate a bean.

Methods inherited from class java.lang.Object

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

Constructor Detail

MVCApplication

public MVCApplication()

Method Detail

getPage

public XPage getPage(javax.servlet.http.HttpServletRequest request,
            int nMode,
            Plugin plugin)
              throws SiteMessageException,
                     UserNotSignedException

Returns the content of the page

Specified by:

getPage in interface XPageApplication

Parameters:

request - The http request

nMode - The current mode

plugin - The plugin object

Returns:

The XPage

Throws:

SiteMessageException - Message displayed if an exception occurs

UserNotSignedException - if an authentication is required by a view

getXPageName

protected String getXPageName()

Returns the XPage name

Returns:

The XPage name

getDefaultPageTitle

protected String getDefaultPageTitle(Locale locale)

Returns the default page title

Parameters:

locale - The locale

Returns:

The default page title

getDefaultPagePath

protected String getDefaultPagePath(Locale locale)

Returns the default page path

Parameters:

locale - The locale

Returns:

The default pagepath

getXPage

protected XPage getXPage()

Returns a new XPage object with default values

Returns:

An XPage Object

getXPage

protected XPage getXPage(String strTemplate)

Returns a new XPage object with default values and the content filled by a template

Parameters:

strTemplate - The template

Returns:

An XPage Object

getXPage

protected XPage getXPage(String strTemplate,
             Locale locale)

Returns a new XPage object with default values and the content filled by a template using a default model and for a given locale

Parameters:

strTemplate - The template

locale - The locale

Returns:

An XPage Object

getXPage

protected XPage getXPage(String strTemplate,
             Locale locale,
             Map<String,Object> model)

Returns a new XPage object with default values and the content filled by a template using a given model and for a given locale

Parameters:

strTemplate - The template

locale - The locale

model - The model

Returns:

An XPage Object

getModel

protected Map<String,Object> getModel()

Get a model Object filled with default values

Returns:

The model

populate

protected void populate(Object bean,
            javax.servlet.http.HttpServletRequest request)

Populate a bean using parameters in http request

Parameters:

bean - bean to populate

request - http request

validateBean

protected <T> boolean validateBean(T bean)

Validate a bean. If the validation failed, error messages of this MVCApplication are updated.< br/> This method should be used only if error messages of constraints of the bean are NOT i18n Keys. If they are I18n keys, the method validateBean(Object, Locale) should be used instead.

Type Parameters:

T - The bean class

Parameters:

bean - The bean

Returns:

true if validated otherwise false

validateBean

protected <T> boolean validateBean(T bean,
                       Locale locale)

Validate a bean. If the validation failed, error messages of this MVCApplication are updated.< br/> This method should be used only if error messages of constraints of the bean are i18n Keys. If they are not I18n keys, the method validateBean(Object) should be used instead.

Type Parameters:

T - The bean class

Parameters:

bean - The bean

locale - The locale

Returns:

true if validated otherwise false

addError

protected void addError(String strMessage)

Add an error message. The error message must NOT be an I18n key.

Parameters:

strMessage - The message

addError

protected void addError(String strMessageKey,
            Locale locale)

Add an error message. The error message must be an I18n key.

Parameters:

strMessageKey - The message

locale - The locale to display the message in

addInfo

protected void addInfo(String strMessage)

Add an info message. The info message must NOT be an I18n key.

Parameters:

strMessage - The message

addInfo

protected void addInfo(String strMessageKey,
           Locale locale)

Add an info message. The info message must be an I18n key.

Parameters:

strMessageKey - The message key

locale - The locale to display the message in

fillCommons

protected void fillCommons(Map<String,Object> model)

Fill the model with commons objects used in templates

Parameters:

model - The model

redirect

protected XPage redirect(javax.servlet.http.HttpServletRequest request,
             String strTarget)

Redirect to requested page

Parameters:

request - the http request

strTarget - the targeted page

Returns:

the page requested

redirect

protected XPage redirect(javax.servlet.http.HttpServletRequest request,
             String strView,
             String strParameter,
             int nValue)

Redirect to an url defined by given parameters

Parameters:

request - The HTTP request

strView - The View name

strParameter - The additional parameter

nValue - The additional parameter's value

Returns:

The XPage redirected

redirect

protected XPage redirect(javax.servlet.http.HttpServletRequest request,
             String strView,
             String strParameter1,
             int nValue1,
             String strParameter2,
             int nValue2)

Redirect to an url defined by given parameters

Parameters:

request - The HTTP request

strView - The View name

strParameter1 - The first additional parameter

nValue1 - The first additional parameter's value

strParameter2 - The second additionnal parameter

nValue2 - The second additionnal parameter's value

Returns:

The XPage redirected

redirect

protected XPage redirect(javax.servlet.http.HttpServletRequest request,
             String strView,
             Map<String,String> additionalParameters)

Redirect to an url defined by given parameters

Parameters:

request - The HTTP request

strView - The View name

additionalParameters - A map containing parameters to add to the URL. Keys of the map are parameters name, and values are parameters values

Returns:

The XPage redirected

redirectView

protected XPage redirectView(javax.servlet.http.HttpServletRequest request,
                 String strView)

Redirect to requested view

Parameters:

request - the http request

strView - the targeted view

Returns:

the page requested

getViewUrl

protected String getViewUrl(String strView)

Get a View URL

Parameters:

strView - The view name

Returns:

The URL

getViewFullUrl

protected String getViewFullUrl(String strView)

Gets the view URL with the JSP path

Parameters:

strView - The view

Returns:

The URL

getActionUrl

protected String getActionUrl(String strAction)

Get Action URL

Parameters:

strAction - The view name

Returns:

The URL

getActionFullUrl

protected String getActionFullUrl(String strAction)

Get Action URL

Parameters:

strAction - The view name

Returns:

The URL

download

protected XPage download(String strData,
             String strFilename,
             String strContentType)

Initiates a file download

Parameters:

strData - Data of the file to download

strFilename - Name of file

strContentType - content type to set to the response

Returns:

The page requested

download

protected XPage download(byte[] data,
             String strFilename,
             String strContentType)

Initiates a download of a byte array

Parameters:

data - Data to download

strFilename - Name of the downloaded file

strContentType - Content type to set to the response

Returns:

The page requested

responseJSON

protected XPage responseJSON(String strJSON)

Return a response as JSON content

Parameters:

strJSON - The JSON

Returns:

An unused XPage

responseXML

protected XPage responseXML(String strXML)

Return a response as XML content

Parameters:

strXML - The XML

Returns:

An unused XPage

redirectMessageBox

protected XPage redirectMessageBox(javax.servlet.http.HttpServletRequest request,
                       MVCMessageBox messageBox)

Redirect to a Message Box page

Parameters:

request - The HTTP request

messageBox - The MessageBox infos

Returns:

A redirect XPage

getLocale

protected Locale getLocale(javax.servlet.http.HttpServletRequest request)

Default getLocale() implementation. Could be overriden

Parameters:

request - The HTTP request

Returns:

The Locale