ZK Essentials/Handling the Login Process using ZK MVC and Sessions/Managing credentials using ZK Sessions

This article is out of date, please refer to http://books.zkoss.org/zkessentials-book/master/ for more up to date information.

One of the paradigms used within the essentials guide is the singleton managers which live within the session. The basic premise for storing singletons in the session is the fact that they are available anywhere at any time and are also specific to user credentials. When the session expires, the login credentials are conveniently cleared.

The Credentials Manager

For managing credentials we create a singleton named UserCredentialManager which wraps a UserDAO. Besides, the UserCredentialManager will unveil two getInstance methods, one takes a Session and the other one does not. The basic concept is that when the instance is retrieved, it checks the Session for an existing credential manager. lf there is no present, it creates a new one.

The code below demonstrates the two getInstance methods along with the creation of the userDAO in the constructor.

<syntax lang="java" high="11,18"> public class UserCredentialManager {

private static final String KEY_USER_MODEL = UserCredentialManager.class.getName()+"_MODEL"; private UserDAO userDAO; private User user;

private UserCredentialManager(){ userDAO = new UserDAO(); }

public static UserCredentialManager getInstance(){ return getIntance(Sessions.getCurrent()); } /** * * @return */ public static UserCredentialManager getInstance(Session zkSession){ HttpSession httpSession = (HttpSession) zkSession.getNativeSession();

// Session session = Executions.getCurrent().getDesktop().getSession(); // Session session = Executions.getCurrent().getSession(); Session session = Sessions.getCurrent(); synchronized(zkSession){ UserCredentialManager userModel = (UserCredentialManager) zkSession.getAttribute(KEY_USER_MODEL); if(userModel==null){ zkSession.setAttribute(KEY_USER_MODEL, userModel = new UserCredentialManager()); } return userModel; } } } </syntax>

The manager is very standardized, exposing a login method. If successful, it sets the User object and a isAuthenticated method which checks to see whether the user is null and returns accordingly. Once this is put into practice, we can now make use of it in our controller to change the page flow of the application.

Redirecting the user depending on the UserCredentialManager

If we think back to our login page and the use case scenarios, we have two situations we need to check for a valid user: one is when the users navigate to the page and the other is when the users press the confirm button. If the user is authenticated, we need a way to redirect to the index page. This should be dealt with the Execution class which provides information about the current execution, such as the request parameters.

A GenericForwardComposer contains an Execution object, execution, which is accessible. If we need to access it outside of a GenericForwardComposer we can retrieve the current execution by calling the getCurrent() method in the Executions class as it is static.

The Executions class has a method named Executions.sendRedirect(String), which redirects the user to a page you indicate. In this case, it is “index.zul.”

<syntax lang="java" high="2"> if(UserCredentialManager.getIntance(session).isAuthenticated()){ execution.sendRedirect("index.zul"); } </syntax>

This concludes the login topic, and the next session we will see how to display information to users using a Grid and Listbox.