Spring MVC and FlashAttributes

A simple solution with Sping MVC to print info messages to the user after a redirect is RedirectAttribute. They will only show up a single time after a redirect. Spring initializes RedirectAttribute in the method param.

Example for setting a flash attribute:

@RequestMapping(value = "/create", method = RequestMethod.POST)
public String create(@ModelAttribute("market") Market market, BindingResult result, SessionStatus status, final RedirectAttributes redirectAttributes) {
	validator.validate(market, result);
	if (result.hasErrors()) {
		return CREATE_JSP;
	}
	// ... save ...
	status.setComplete();
	redirectAttributes.addFlashAttribute("message", "admin.message.saved");
	return String.format("redirect:/admin/market/view?id=%s", market.getId());
}

@RequestMapping(value = "/create", method = RequestMethod.POST)

public String create(@ModelAttribute("market") Market market, BindingResult result, SessionStatus status, final RedirectAttributes redirectAttributes) {

validator.validate(market, result);

if (result.hasErrors()) {

return CREATE_JSP;

}

// ... save ...

status.setComplete();

redirectAttributes.addFlashAttribute("message", "admin.message.saved");

return String.format("redirect:/admin/market/view?id=%s", market.getId());

}

and display it with the following code in your view

<c:if test="${message != null}">
	<div class="infoMsg"><spring:message code="${message}" /></div>
</c:if>

<c:if test="${message != null}">

</c:if>

Testing it

The messages are attached as an attribute in the request so they can be easily tested in a unit test:

@Test
public void testCreateSuccess() throws Exception {
    MockHttpServletRequest request = new MockHttpServletRequest(RequestMethod.POST.name(), "/admin/market/create");
    request.setAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
    request.addParameter("name", "ZZ");
    MockHttpServletResponse response = new MockHttpServletResponse();
    
    Object handler = handlerMapping.getHandler(request).getHandler();
    ModelAndView modelAndView = handlerAdapter.handle(request, response, handler);
    BindingResult bindingResult = (BindingResult) modelAndView.getModel().get(String.format("%s.%s", BindingResult.class.getName(), "market"));
    
    assertTrue("Should have no errors", bindingResult == null || !bindingResult.hasErrors());
    assertFlashAttributeNotNull("Should contain success message", request, "message");
    assertTrue(modelAndView.getViewName().startsWith("redirect:/admin/market/view?id="));
}

static public void assertFlashAttributeNotNull(String message, ServletRequest request, String name) {
	FlashMap flashMap = (FlashMap)request.getAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE);
	assertNotNull(message, flashMap.get(name));
}

@Test

public void testCreateSuccess() throws Exception {

MockHttpServletRequest request = new MockHttpServletRequest(RequestMethod.POST.name(), "/admin/market/create");

request.setAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());

request.addParameter("name", "ZZ");

MockHttpServletResponse response = new MockHttpServletResponse();

Object handler = handlerMapping.getHandler(request).getHandler();

ModelAndView modelAndView = handlerAdapter.handle(request, response, handler);

BindingResult bindingResult = (BindingResult) modelAndView.getModel().get(String.format("%s.%s", BindingResult.class.getName(), "market"));

assertTrue("Should have no errors", bindingResult == null || !bindingResult.hasErrors());

assertFlashAttributeNotNull("Should contain success message", request, "message");

assertTrue(modelAndView.getViewName().startsWith("redirect:/admin/market/view?id="));

}

static public void assertFlashAttributeNotNull(String message, ServletRequest request, String name) {

FlashMap flashMap = (FlashMap)request.getAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE);

assertNotNull(message, flashMap.get(name));

}

One thing is a bit wired. If spring initialize RedirectAttributes in the method and there are no errors in the BindingResult, it “feels” like there is some kind of redirect simulation. The ModelMap is empty after that and BindingResult is null. Without RedirectAttributes the BindingResult remains without errors in the model map. I think it’s more realistic with an empty ModelMap after the redirect, but I can’t understand why the behaviour is different?

Leave a reply

Getting BindingResult of Spring MVC in JUnit-Test

I found several variants of how to get Spring MVC BindingResult in a JUnit-Test but most of them doesn’t look very handy to me. But there is a very simple solution, too. The BindingResult is stored in the ModelMap with the Name:

org.springframework.validation.BindingResult.modelname

1	org.springframework.validation.BindingResult.modelname

Example

Method to test:

@RequestMapping(value = "/edit", method = RequestMethod.POST)
public String edit(@ModelAttribute("market") Market market, BindingResult result, SessionStatus status) {
	validator.validate(market, result);
	if (result.hasErrors()) {
		return EDIT_JSP;
	}
	// ... save ...
	status.setComplete();
	return String.format("redirect:/market/view?id=%s", market.getId());
}

@RequestMapping(value = "/edit", method = RequestMethod.POST)

public String edit(@ModelAttribute("market") Market market, BindingResult result, SessionStatus status) {

validator.validate(market, result);

if (result.hasErrors()) {

return EDIT_JSP;

}

// ... save ...

status.setComplete();

return String.format("redirect:/market/view?id=%s", market.getId());

}

Test:

@Test
public void testEditSuccess() throws Exception {
    Market market = createTestMarket("E1");
    
    MockHttpServletRequest request = new MockHttpServletRequest(RequestMethod.POST.name(), "/admin/market/edit");
    request.setAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());
    request.addParameter("id", String.valueOf(market.getId()));
    request.addParameter("name", "YY");
    MockHttpServletResponse response = new MockHttpServletResponse();
    
    Object handler = handlerMapping.getHandler(request).getHandler();
    ModelAndView modelAndView = handlerAdapter.handle(request, response, handler);
    BindingResult bindingResult = (BindingResult) modelAndView.getModel().get(String.format("%s.%s", BindingResult.class.getName(), "market"));
    
    assertTrue("Should have no errors", bindingResult == null || !bindingResult.hasErrors());
    assertFlashAttributeNotNull("Should contain success message", request, "message");
    assertTrue(modelAndView.getViewName().startsWith("redirect:/admin/market/view?id="));
}

@Test

public void testEditSuccess() throws Exception {

Market market = createTestMarket("E1");

MockHttpServletRequest request = new MockHttpServletRequest(RequestMethod.POST.name(), "/admin/market/edit");

request.setAttribute(DispatcherServlet.OUTPUT_FLASH_MAP_ATTRIBUTE, new FlashMap());

request.addParameter("id", String.valueOf(market.getId()));

request.addParameter("name", "YY");

MockHttpServletResponse response = new MockHttpServletResponse();

Object handler = handlerMapping.getHandler(request).getHandler();

ModelAndView modelAndView = handlerAdapter.handle(request, response, handler);

BindingResult bindingResult = (BindingResult) modelAndView.getModel().get(String.format("%s.%s", BindingResult.class.getName(), "market"));

assertTrue("Should have no errors", bindingResult == null || !bindingResult.hasErrors());

assertFlashAttributeNotNull("Should contain success message", request, "message");

assertTrue(modelAndView.getViewName().startsWith("redirect:/admin/market/view?id="));

}

Leave a reply

How to display Liferay EE license Information

I haven’t found a button or something in the control panel to display information about the current installed ee license until now. It happens to me that the date in the plain text information of the license file differs from the real license expiration date so I’m always nervous about license type and license expiration date. But there is an url to display the license information. Liferay redirects every request to this url if there are to much requests to a developer license or if the server license is expired. To prevent this you should check your license immediately after the license installation.

http://example.com/c/portal/ee/license

A valid server license looks like:

Liferay Portal Enterprise Edition 6.0 EE SP2
Bunyan / Build 6012 / July 27, 2011
Owner     CUSTOMERNAME
Description     CUSTOMERDESCRIPTION
Product     Portal Production
Type     Production
Version     6.0
Start Date     December 01, 2010 11:00:00 PM UTC
Expiration Date     December 01, 2014 11:00:00 PM UTC

Liferay Portal Enterprise Edition 6.0 EE SP2

Bunyan / Build 6012 / July 27, 2011

Owner CUSTOMERNAME

Description CUSTOMERDESCRIPTION

Product Portal Production

Type Production

Version 6.0

Start Date December 01, 2010 11:00:00 PM UTC

Expiration Date December 01, 2014 11:00:00 PM UTC

A valid developer license looks like:

Liferay Portal Enterprise Edition 6.0 EE SP2
Bunyan / Build 6012 / July 27, 2011
Owner 	DEVELOPERNAME
Description 	12 Months workstation key
Product 	Portal Development
Type 	Developer
Version 	6.0 SP 2
Maximum HTTP Sessions 	10
Start Date 	09 July 2012 09:42:43 UTC
Expiration Date 	09 July 2013 09:42:43 UTC

Liferay Portal Enterprise Edition 6.0 EE SP2

Bunyan / Build 6012 / July 27, 2011

Owner DEVELOPERNAME

Description 12 Months workstation key

Product Portal Development

Type Developer

Version 6.0 SP 2

Maximum HTTP Sessions 10

Start Date 09 July 2012 09:42:43 UTC

Expiration Date 09 July 2013 09:42:43 UTC

Leave a reply

SQL-Statement to give administration role to a regular liferay user

To change a regular liferay user to an administration account – for example if you are still able to register to your portal but have forgotten your admin password – use the following sql-statemnet.

INSERT INTO Users_Roles (userId, roleId)
   VALUES (
      (select userId from User_ where emailAddress = 'mailadressOfFreshUser@example.com'),
      (select roleId from Role_ where name = 'Administrator')
   );

INSERT INTO Users_Roles (userId, roleId)

VALUES (

(select userId from User_ where emailAddress = 'mailadressOfFreshUser@example.com'),

(select roleId from Role_ where name = 'Administrator')

);

Don’t forget the database cache! (restart)

Leave a reply

Konvertieren einer Liferay-Datenbank von Latin-1 auf UTF-8

Auf dem diesjährigen Liferay-Symposium meldeten sich einige User beim Q & A mit Brian Chan mit der Frage, wie man eine fälschlich in Latin-1 angelegte Datenbank in UTF-8 konvertiert. Da wir das soeben bei einer Datenbank durchgeführt haben, hier eine kurze Anleitung:

Zunächst bitte sicherstellen, dass die Konsole auf UTF-8 gestellt ist. Wenn man den Datenbankdump mit vi aufmacht und Sonderzeichen richtig angezeigt werden, dann stimmt’s.

Liferay runterfahren, Datenbank-Dump ziehen und sichern:

mysqldump -u root -p liferay &gt; dump.sql
cp dump.sql dump.sql.bak

1 2	mysqldump -u root -p liferay > dump.sql cp dump.sql dump.sql.bak

dump.sql mit vi aufmachen und tabellendefinitionen per Suchen & Ersetzen ändern:

vi dump.sql
:1,$:s/ DEFAULT CHARSET=latin1/ DEFAULT CHARSET=utf8/g 
:wq

vi dump.sql

:1,$:s/ DEFAULT CHARSET=latin1/ DEFAULT CHARSET=utf8/g

:wq

Datenbank löschen und diesmal richtig anlegen:

mysql -u root -e "DROP DATABASE liferay"
mysql -u root -e "CREATE DATABASE liferay CHARACTER SET utf8"

1 2	mysql -u root -e "DROP DATABASE liferay" mysql -u root -e "CREATE DATABASE liferay CHARACTER SET utf8"

Dump wieder einspielen:

mysql -u root -p liferay &lt; dump.sql

1	mysql -u root -p liferay < dump.sql

Jetzt Liferay wieder starten und dann sollte es das schon gewesen sein.

P.S.: Diese Anleitung ist eigentlich nicht Liferay-Spezifisch und sollte auch bei anderen Anwendungen helfen.

Leave a reply