• This tutorial uses the source code of the ConsultingAgency application. If you have not completed the first tutorial in the series Modifying JSP Pages in the Generated JavaServer Faces CRUD Application where you start modifying the generated code, you may want to do that now. Alternatively, you can download the project that is used as the starting point for this series as a .zip archive or get the project sources from Kenai.
• This project uses some experimental JSF libraries to add Ajax functionality described in the third tutorial in the series. The JSF libraries are bundled with NetBeans IDE 6.5. If you are using NetBeans IDE 6.7, you will need to install the JSF Extensions (Ajax) plugin from the NetBeans Beta Update Center. Alternatively, you can remove the source code that implements the Ajax functionality and skip the third document in the series. For details, see the section on Removing Ajax Functionality. For more about the functionality provided by the plugin, see the section Enabling Ajax in the Application in the Generating a JavaServer Faces CRUD Application from a Database tutorial.

• When you open the project, you might see a warning about a missing project resource if the JSF Extensions (Ajax) plugin is not installed. You need to install the plugin to add the JSF libraries required by the project. Alternatively, you can remove the requirement for the plugin by following the steps in the section Removing Ajax Functionality. For more about the functionality provided by the plugin, see the section Enabling Ajax in the Application in the Generating a JavaServer Faces CRUD Application from a Database tutorial.
• When you open the project, you might see a warning about a missing server. To resolve the problem, right-click the project node in the Project window, choose Resolve Missing Server Problem and then specify your local GlassFish v2.x server instance in the dialog box.
• If you use the zip archive or get the sources from Kenai, you need to use the MySQL database server and create and populate the consult database as described in the Generating a JavaServer Faces CRUD Application from a Database tutorial.

Getting Project Sources from Kenai

If you are using NetBeans IDE 6.7, you can get the sources from the remote repository and open the project in the IDE. You can find the sources in the repository of the Consulting Agency Solution Project. The repository contains the project sources for each of the tutorials in this series.

To get the sources for this tutorial from the repository on Kenai, perform the following steps.

1. Choose Team > Kenai > Get Sources from Kenai from the main menu.

   Alternatively, you can choose Open Kenai Project to add the project to the Kenai dashboard and then get the project sources.

2. In the Get Sources from Kenai dialog box, locate the Kenai Repository by clicking Browse to open the Browse Kenai Projects dialog box.
3. Search for the Consulting Agency Solution Project.
4. Select the Consulting Agency Solution Project and click OK.
5. Click Browse to specify the Folder to Get and select base2. Click OK.
   
6. Click Browse to specify the Local Folder for the sources (the local folder must be empty).
7. Click Get From Kenai.

   When you click Get From Kenai, the IDE initializes the local folder as a Subversion repository and checks out the project sources.

8. Click Open Project in the dialog that appears when checkout is complete.

For more information about getting sources from Kenai, see Opening a Kenai Project.

Modifying the JPA Controller for Billable Entities

1. Open the jpa.controllers.BillableJpaController.java class in the editor and add the following find and get methods:

   public List<Billable> findBillableEntities(int maxResults, int firstResult, String query, Map<String, Object> parameters) {
       return findBillableEntities(false, maxResults, firstResult, query, parameters);
   }
   
   private List<Billable> findBillableEntities(boolean all, int maxResults, int firstResult, String query, Map<String, Object> parameters) {
       EntityManager em = getEntityManager();
       try {
           Query q = em.createQuery(query);
           if (parameters != null) {
               for (String name : parameters.keySet()) {
                   q.setParameter(name, parameters.get(name));
               }
           }
           if (!all) {
               q.setMaxResults(maxResults);
               q.setFirstResult(firstResult);
           }
           return q.getResultList();
       } finally {
           em.close();
       }
   }
   
   public int getBillableCount(String query, Map<String, Object> parameters) {
       EntityManager em = getEntityManager();
       try {
           Query q = em.createQuery(query);
           if (parameters != null) {
               for (String name : parameters.keySet()) {
                   q.setParameter(name, parameters.get(name));
               }
           }
           return ((Long) q.getSingleResult()).intValue();
       }
       finally {
           em.close();
       }
   }

2. Fix your imports (to import java.util.Map) and save your changes.

Modifying the JPA Controller for Consultant Entities

1. Open the jpa.controllers.ConsultantJpaController class in the editor and add the following find methods for consultants.

   public List<Consultant> findConsultantEntities(int maxResults, int firstResult, String query, Map<String, Object> parameters) {
       return findConsultantEntities(false, maxResults, firstResult, query, parameters);
   }
   
   private List<Consultant> findConsultantEntities(boolean all, int maxResults, int firstResult, String query, Map<String, Object> parameters) {
       EntityManager em = getEntityManager();
       try {
           Query q = em.createQuery(query);
           if (parameters != null) {
               for (String name : parameters.keySet()) {
                   q.setParameter(name, parameters.get(name));
               }
           }
           if (!all) {
               q.setMaxResults(maxResults);
               q.setFirstResult(firstResult);
           }
           return q.getResultList();
       }
       finally {
           em.close();
       }
   }
      

2. Fix your imports (to import java.util.Map) and save your changes.

Modifying the JPA Controller for Project Entities

1. Open the jpa.controllers.ProjectJpaController class in the editor and add the following find methods for projects.

   public List<Project> findProjectEntities(String query, Map<String, Object> parameters) {
       return findProjectEntities(true, -1, -1, query, parameters);
   }
   
   private List<Project> findProjectEntities(boolean all, int maxResults, int firstResult, String query, Map<String, Object> parameters) {
       EntityManager em = getEntityManager();
       try {
           Query q = em.createQuery(query);
           if (parameters != null) {
               for (String name : parameters.keySet()) {
                   q.setParameter(name, parameters.get(name));
               }
           }
           if (!all) {
               q.setMaxResults(maxResults);
               q.setFirstResult(firstResult);
           }
           return q.getResultList();
       }
       finally {
           em.close();
       }
   }
      

2. Fix your imports (to import java.util.Map) and save your changes.

Editing the JSF Controller Class for Billable

In this exercise you will modify some of the existing methods in the jsf.BillableController.java class to retrieve billable items associated with the consultant. You will also add some methods to implement the search function for billable items, check if the user is allowed to perform the operation and add a validator for endDate.

1. Open the jsf.BillableController.java class in the editor.
2. Add the following member fields:

   private Map<String, Object> searchParameters = null;
   private static final String[] properties = {"billableId", "startDate", "endDate", "hours", "hourlyRate", "description", "project", "consultantId"};
      

3. Add the following getSearchHours() and setSearchHours(Short) methods that are called from Search.jsp.

   public Short getSearchHours() {
       if (billable == null) {
           return null;
       }
       short billableHours = billable.getHours();
       if (billableHours == -1) {
           return null;
       }
       return new Short(billableHours);
   }
   
   public void setSearchHours(Short hours) {
       if (billable == null) {
           return;
       }
       short hoursAsPrimitive = hours == null ? -1 : hours.shortValue();
       billable.setHours(hoursAsPrimitive);
   }

4. Make the following changes (in bold) to the getPagingInfo() method.

   public PagingInfo getPagingInfo() {
       if (pagingInfo.getItemCount() == -1) {
           pagingInfo.setItemCount(getItemCount());
       }
       return pagingInfo;
   }

5. Make the following changes (in bold) to the getBillable() method to call getNewBillable().

   public Billable getBillable() {
       if (billable == null) {
           billable = (Billable) JsfUtil.getObjectFromRequestParameter("jsfcrud.currentBillable", converter, null);
       }
       if (billable == null) {
           billable = getNewBillable();
       }
       return billable;
   }

6. Make the following changes (in bold) to the createSetup() method.

   public String createSetup() {
       reset(false);
       billable = getNewBillable();
       return "billable_create";
   }

7. Make the following changes (in bold) to the validateCreate(FacesContext,UIComponent,Object) method.

   public void validateCreate(FacesContext facesContext, UIComponent component, Object value) {
       Billable newBillable = getNewBillable();
       String newBillableString = converter.getAsString(FacesContext.getCurrentInstance(), null, newBillable);
       String billableString = converter.getAsString(FacesContext.getCurrentInstance(), null, billable);
       if (!newBillableString.equals(billableString)) {
           createSetup();
       }
   }

8. Add the getNewBillable() method to the class to set values for fields the consultant cannot modify. Notice that the method calls the getLoggedInConsultant() method in the AuthenticationPhaseListener class.

   private Billable getNewBillable() {
       Billable result = new Billable();
       Consultant consultant = AuthenticationPhaseListener.getLoggedInConsultant();
       result.setConsultantId(consultant);
       result.setHourlyRate(consultant.getHourlyRate());
       result.setBillableHourlyRate(consultant.getBillableHourlyRate());
       return result;
   }

9. Now you will add code to some of the methods to call an isOperationForbidden method to check if the user can perform the operation.

   Add the following code (in bold) to the create() method before the try block.

   public String create() {
       if (isOperationForbidden()) {
           return null;
       }
       try {
           jpaController.create(billable);
           ...
   }

10. Add the following code (in bold) to the scalarSetup(String destination) method, before the return statement.

    private String scalarSetup(String destination) {
            ...
            return relatedOrListOutcome();
        }
        if (isOperationForbidden()) {
            return null;
        }
        return destination;
    }

11. Add the following code (in bold) to the edit() method before the try block.

    public String edit() {
        ...
                JsfUtil.addErrorMessage("Could not edit billable. Try again.");
            }
            return outcome;
        }
        if (isOperationForbidden()) {
            return null;
        }
        try {
            jpaController.edit(billable);
        ...
    }

12. Add the following code (in bold) to the destroy() method, before String idAsString = JsfUtil.getRequestParameter("jsfcrud.currentBillable");

    public String destroy() {
        if (isOperationForbidden()) {
            return null;
        }
        String idAsString = JsfUtil.getRequestParameter("jsfcrud.currentBillable");
        Long id = new Long(idAsString);
        try {
        ...
    }

13. Add the isOperationForbidden() method to the class to check if the logged in consultant can modify the data.

    private boolean isOperationForbidden() {
        boolean forbidden = false;
        Consultant loggedInConsultant = AuthenticationPhaseListener.getLoggedInConsultant();
        if (loggedInConsultant == null) {
            forbidden = true;
        } else if (billable == null) {
            //destroy operation
            String consultantOfCurrentBillableAsString = JsfUtil.getRequestParameter("jsfcrud.timecard.consultantOfCurrentBillable");
            if (consultantOfCurrentBillableAsString != null) {
                Integer consultantOfCurrentBillableAsInteger = new Integer(consultantOfCurrentBillableAsString);
                if (!consultantOfCurrentBillableAsInteger.equals(loggedInConsultant.getConsultantId())) {
                    forbidden = true;
                }
            }
        } else if (!loggedInConsultant.equals(billable.getConsultantId())) {
            //detail or edit operation
            forbidden = true;
        }
        if (forbidden) {
            JsfUtil.addErrorMessage("You do not have permission to perform the requested operation.");
        }
        return forbidden;
    }

14. Modify the getBillableItems() method to add the following code (in bold) to add search parameters and set a query when getting the billable items.

    public List<Billable> getBillableItems() {
        if (billableItems == null) {
            getPagingInfo();
            tweakSearchParameters();
            String query = getQueryForParameters("select object(o) from Billable as o");
            billableItems = jpaController.findBillableEntities(pagingInfo.getBatchSize(), pagingInfo.getFirstItem(), query, searchParameters);
        }
        return billableItems;
    }

15. Add the following methods to the class to implement the search function, including the tweakSearchParameters and getQueryForParameters methods.

    public String searchSetup() {
        reset(false);
        billable = new Billable();
        billable.setHours((short)-1);
        return "billable_search";
    }
    
    public String search() {
        searchParameters = new HashMap<String, Object>();
        Object[] values = {billable.getBillableId(), billable.getStartDate(), billable.getEndDate(), new Short(billable.getHours()), billable.getHourlyRate(), billable.getDescription(), billable.getProject(), null};
        for (int i = 0; i < properties.length; i++) {
            if (values[i] != null) {
                if("hours".equals(properties[i])) {
                    if (((Short)values[i]).shortValue() == -1) {
                        continue;
                    }
                } else if (values[i] instanceof String) {
                    String trimmedValue = ((String)values[i]).trim();
                    if (trimmedValue.length() == 0) {
                        continue;
                    }
                    trimmedValue = trimmedValue.replaceAll("~", "~~");
                    trimmedValue = trimmedValue.replaceAll("%", "~%");
                    values[i] = "%" + trimmedValue + "%";
                }
                searchParameters.put(properties[i], values[i]);
            }
        }
        reset(true, false);
        return "billable_list";
    }
    
    public int getItemCount() {
        tweakSearchParameters();
        String query = getQueryForParameters("select count(o) from Billable as o");
        return jpaController.getBillableCount(query, searchParameters);
    }
    
    private String getQueryForParameters(String baseQuery) {
        if (searchParameters == null) {
            return baseQuery;
        }
        StringBuffer where = new StringBuffer();
        for (int i = 0; i < properties.length; i++) {
            if (searchParameters.containsKey(properties[i])) {
                if (where.length() > 0) {
                    where.append(" and ");
                }
                if ("startDate".equals(properties[i])) {
                    where.append("(o.startDate is null or o.startDate >= :startDate) and (o.endDate is null or o.endDate >= :startDate)");
                }
                else if ("endDate".equals(properties[i])) {
                    where.append("(o.startDate is null or o.startDate <= :endDate) and (o.endDate is null or o.endDate <= :endDate)");
                }
                else if (searchParameters.get(properties[i]) instanceof String) {
                    where.append("o." + properties[i] + " like :" + properties[i] + " escape '~'");
                }
                else {
                    where.append("o." + properties[i] + " = :" + properties[i]);
                }
            }
        }
        if (where.length() > 0) {
            baseQuery += " where " + where;
        }
        return baseQuery;
    }
    
    private void tweakSearchParameters() {
        if (searchParameters == null) {
            searchParameters = new HashMap<String,Object>();
        }
        if (searchParameters.get(properties[properties.length - 1]) == null) {
            Consultant loggedInConsultant = AuthenticationPhaseListener.getLoggedInConsultant();
            searchParameters.put(properties[properties.length - 1], loggedInConsultant);
        }
    }

    Note. Notice that the searchSetup method returns "billable_search". You will later configure the JSF navigation rules so that Search.jsp is loaded when the outcome is "billable_search".

16. Modify the next() and prev() methods to change reset(false) to reset(false, false) so that searchParameters are also reset.

    public String next() {
        reset(false, false);
        getPagingInfo().nextPage();
        return "billable_list";
    }
    
    public String prev() {
        reset(false, false);
        getPagingInfo().previousPage();
        return "billable_list";
    }

17. Modify the reset(boolean) method to also reset searchParameters and add a new reset(boolean) method.

    private void reset(boolean resetFirstItem, boolean resetSearchParameters) {
        billable = null;
        billableItems = null;
        pagingInfo.setItemCount(-1);
        if (resetFirstItem) {
            pagingInfo.setFirstItem(0);
        }
        if (resetSearchParameters) {
            searchParameters = null;
        }
    }
    
    private void reset(boolean resetFirstItem) {
        reset(resetFirstItem, true);
    }

18. Add the following validator method for endDate used in Search.jsp, New.jsp and Edit.jsp.

    public void validateEndDate(FacesContext facesContext, UIComponent component, Object value) {
        ValueHolder startDateInputField = (ValueHolder)facesContext.getViewRoot().findComponent("form1:startDate");
        Date startDate = (Date)startDateInputField.getLocalValue();
        if (startDate != null) {
            Date endDate = (Date)value;
            if (startDate.after(endDate)) {
                throw new ValidatorException(new FacesMessage(FacesMessage.SEVERITY_ERROR, "The end date cannot precede the start date.", null));
            }
        }
    }

19. Fix your imports (make sure you import java.util.Date and javax.faces.validator.ValidatorException) and save your changes.

Editing the JSF Controller Class for Consultant

In this exercise you add the login and logout methods. The login method is invoked from login.jsp and the logout method is invoked from welcomeJSF.jsp.

1. Open the jsf.ConsultantController.java class in the editor.
2. Add the following login() and logout() methods.

   public String login() {
       if (consultant == null) {
           JsfUtil.addErrorMessage("An error occurred attempting to log in.");
           return null;
       }
       String query = "select object(o) from Consultant as o where o.email = :email and o.password = :password";
       Map<String, Object> parameters = new HashMap<String, Object>();
       String email = consultant.getEmail();
       parameters.put("email", email);
       parameters.put("password", consultant.getPassword());
       List<Consultant> consultants = null;
       try {
           consultants = jpaController.findConsultantEntities(1, 0, query, parameters);
       } catch (Exception e) {
           JsfUtil.ensureAddErrorMessage(e, "A persistence error occurred.");
       }
       if (consultants != null && consultants.size() > 0) {
           Consultant c = consultants.get(0);
           FacesContext.getCurrentInstance().getExternalContext().getSessionMap().put(AuthenticationPhaseListener.AUTHENTICATED_CONSULTANT_KEY, c);
           JsfUtil.addSuccessMessage("Welcome, " + email + ".");
           return "welcome";
       } else {
           JsfUtil.addErrorMessage("Invalid login.");
           return null;
       }
   }
   
   public String logout() {
       HttpSession session = (HttpSession) FacesContext.getCurrentInstance().getExternalContext().getSession(false);
       if (session != null) {
           session.invalidate();
       }
       JsfUtil.addSuccessMessage("You are now logged out.");
       return "login";
   }

3. Fix your imports (make sure you import java.util.Map) and save your changes.

Editing the JSF Controller Class for Project

In this exercise you add methods that determine the projects that are displayed in the project drop-down list when a consultant creates, updates and searches billable items. The drop down list only displays projects associated with the logged in consultant. AssignedProjectsForLoggedInConsultantSelectOne is invoked from the New.jsp and Edit.jsp pages. BilledProjectsForLoggedInConsultantSelectOne is invoked from the Search.jsp page.

1. Open the jsf.ProjectController class in the editor.
2. Add the following methods:

   public SelectItem[] getBilledProjectsForLoggedInConsultantSelectOne() {
       String query = "select distinct b.project from Billable as b where b.consultantId = :consultant";
       Map<String, Object> parameters = new HashMap<String, Object>();
       Consultant loggedInConsultant = AuthenticationPhaseListener.getLoggedInConsultant();
       parameters.put("consultant", loggedInConsultant);
       return JsfUtil.getSelectItems(jpaController.findProjectEntities(query, parameters), true);
   }
   
   public SelectItem[] getAssignedProjectsForLoggedInConsultantSelectOne() {
       Consultant loggedInConsultant = AuthenticationPhaseListener.getLoggedInConsultant();
       Collection<Project> assignedProjectsCollection = loggedInConsultant.getProjectCollection();
       List assignedProjectsList = new ArrayList(assignedProjectsCollection);
       return JsfUtil.getSelectItems(assignedProjectsList, true);
   }

3. Fix your imports (to import java.util.Collection and java.util.Map) and save your changes.

Troubleshooting

If you are attempting to run the project for the first time and you encounter problems displayed in the Output window, see the Troubleshooting section of the first tutorial in the series.