fr.paris.lutece.portal.util.mvc.admin

Class MVCAdminJspBean

java.lang.Object

fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

fr.paris.lutece.portal.web.admin.PluginAdminPageJspBean

fr.paris.lutece.portal.util.mvc.admin.MVCAdminJspBean

All Implemented Interfaces:

Serializable

public abstract class MVCAdminJspBean
extends PluginAdminPageJspBean
implements Serializable

MVC Admin JspBean implementation let use MVC model to develop admin feature.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MVCAdminJspBean()

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 void	download(byte[] data, String strFilename, String strContentType) Initiates a download of a byte array
protected void	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	getActionUrl(String strAction) Get Action URL
protected String	getControllerJsp() Return the JSP name used as controller
protected String	getControllerPath() Return the path of the JSP used as controller
protected Map<String,Object>	getModel() Get a model Object filled with default values
protected String	getPage(String strTemplate) Return the page content
protected String	getPage(String strPageTitleProperty, String strTemplate) Return the page content
protected String	getPage(String strPageTitleProperty, String strTemplate, Map<String,Object> model) Return the page content
protected String	getViewFullUrl(String strView) Gets the view URL with the JSP path
protected String	getViewUrl(String strView) Get a View URL
String	processController(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process request as a controller
protected String	redirect(javax.servlet.http.HttpServletRequest request, String strTarget) Redirect to requested page
protected String	redirect(javax.servlet.http.HttpServletRequest request, String strView, Map<String,String> additionalParameters) Redirect to an url defined by given parameters
protected String	redirect(javax.servlet.http.HttpServletRequest request, String strView, String strParameter, int nValue) Redirect to an url defined by given parameters
protected String	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 String	redirectView(javax.servlet.http.HttpServletRequest request, String strView) Redirect to requested view
protected <T> boolean	validateBean(T bean, String strPrefix) Validate a bean

Methods inherited from class fr.paris.lutece.portal.web.admin.PluginAdminPageJspBean

getPlugin, init

Methods inherited from class fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

getAdminPage, getFeatureIcon, getHomeUrl, getLocale, getPageTitle, getUser, populate, setFeatureGroup, setFeatureIcon, setPageTitleProperty, validate, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MVCAdminJspBean

public MVCAdminJspBean()

Method Detail

processController

public String processController(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                         throws AccessDeniedException

Process request as a controller

Parameters:

request - The HTTP request

response - The HTTP response

Returns:

The page content

Throws:

AccessDeniedException - If the user's has no right

addError

protected void addError(String strMessage)

Add an error message

Parameters:

strMessage - The message

addError

protected void addError(String strMessageKey,
            Locale locale)

Add an error message

Parameters:

strMessageKey - The message

locale - The locale

addInfo

protected void addInfo(String strMessage)

Add an info message

Parameters:

strMessage - The message

addInfo

protected void addInfo(String strMessageKey,
           Locale locale)

Add an info message

Parameters:

strMessageKey - The message key

locale - The locale

fillCommons

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

Fill the model with commons objects used in templates

Parameters:

model - The model

getModel

protected Map<String,Object> getModel()

Get a model Object filled with default values

Returns:

The model

getPage

protected String getPage(String strTemplate)

Return the page content

Parameters:

strTemplate - The template

Returns:

The page

getPage

protected String getPage(String strPageTitleProperty,
             String strTemplate)

Return the page content

Parameters:

strPageTitleProperty - The page title property

strTemplate - The template

Returns:

The page

getPage

protected String getPage(String strPageTitleProperty,
             String strTemplate,
             Map<String,Object> model)

Return the page content

Parameters:

strPageTitleProperty - The page title property

strTemplate - The template

model - The model

Returns:

The page

validateBean

protected <T> boolean validateBean(T bean,
                       String strPrefix)

Validate a bean

Type Parameters:

T - The bean class

Parameters:

bean - The bean

strPrefix - The prefix

Returns:

true if validated otherwise false

getControllerJsp

protected String getControllerJsp()

Return the JSP name used as controller

Returns:

The JSP name

getControllerPath

protected String getControllerPath()

Return the path of the JSP used as controller

Returns:

The controller path

redirect

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

Redirect to requested page

Parameters:

request - the http request

strTarget - the targeted page

Returns:

null. The page should be redirected

redirect

protected String 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 redirection result

redirect

protected String 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 redirection result

redirect

protected String 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 String redirectView(javax.servlet.http.HttpServletRequest request,
                  String strView)

Redirect to requested view

Parameters:

request - the http request

strView - the targeted view

Returns:

The redirection result

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

download

protected void 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

download

protected void 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