Lab B.3: Adding Functionality

Goals

• Pass a value to a controller
• Pass a value from the controller to a JSP page
• Use the value in the JSP page
• Use the Debug Log

Prerequisites

• Lab B.2: Simple Interaction, to create a controller and input page

Exercise

Pass a Value to the Controller

Let's start by sending your name to the controller.

1. Click Designer > Pages
2. Click Hello.jsp
3. Customize the form to pass your name to the controller. (You could also create a form field for that, but here will just hardcode the value.)

   <syntaxhighlight lang="java" enclose="div">

   Press the button to see something cool.

   <form name="mainForm" action="/networking/controller/com/platform/demo/hello/HelloController?name={yourName}"

     ...                                                                                      ~~~~~~~~~~~~~~~~
   

   </syntaxhighlight> For example:

   <syntaxhighlight lang="java" enclose="div">

   Press the button to see something cool.

   <form name="mainForm" action="/networking/controller/com/platform/demo/hello/HelloController?name=Fred"

     ...
   

   </syntaxhighlight>

Customize the Controller

Next customize the controller to pass along data sent from the initial page. (You could do any processing you want here, and even select different targets, depending on the results. But for now, we'll just pass along the data.)

1. Click Designer > Classes
2. Click HelloController
3. Add the code to echo the incoming data and pass it to the target page:

   <syntaxhighlight lang="java" enclose="div">

   public ControllerResponse execute(HashMap params) throws Exception { // Just to show we got the parameters, and could process them if we wanted to String name = (String) params.get("name"); Functions.debug("HelloController: Hal will greet "+name); // Pass the parameters to the target page ControllerResponse cr = new ControllerResponse(); cr.setData(params); cr.setTargetPage("HelloWorld.jsp"); return cr; } </syntaxhighlight>

In this code, you echoed the incoming data to the Debug Log, before passing it to the target page. In the process, you identified where the message came from (HelloController), to make it easier to find in the log.

The controller should now look like this:

<syntaxhighlight lang="java" enclose="div">

package com.platform.demo.hello;

import com.platform.api.*; import java.util.HashMap;

public class HelloController implements com.platform.api.Controller {

   public ControllerResponse execute(HashMap params) throws Exception
   {
       // Just to show we got it, and could process it if we wanted to
       String name = (String) params.get("name");
       Functions.debug("HelloController: Hal will greet "+name);
       
       // Pass the parameters to the target page
       ControllerResponse cr = new ControllerResponse();
       cr.setData(params);
       cr.setTargetPage("HelloWorld.jsp");
       return cr;
   }

} </syntaxhighlight>

Customize the Destination Page

1. Click Designer > Pages
2. Click HelloWorld.jsp
3. Put this code at the top of the page to access the data sent by the controller, using the Implicit JSTL Object, param:

   <syntaxhighlight lang="java" enclose="div">

   <%@ taglib uri="/c" prefix="c" %>

   Hello ${param.name}!

   </syntaxhighlight>

4. Alternatively, use this code to process the data and to set a default value if none was provided.

   <syntaxhighlight lang="java" enclose="div">

   <% java.util.HashMap params = new java.util.HashMap(); String name = "World"; if (controllerResponse != null) { params = (java.util.HashMap)controllerResponse.getData(); if (params != null) { name = (String) params.get("name"); name += ", my friend"; } } %> </syntaxhighlight>
5. And then change the output line to use that value:

   <syntaxhighlight lang="java" enclose="div">

   Hello <%=name %>!

                          ^^^^^^^^^^^^
   

   </syntaxhighlight>

HelloWorld.jsp should now look like this:

<syntaxhighlight lang="java" enclose="div">

<%@ taglib uri="/c" prefix="c" %>

Hello ${param.name}!

</syntaxhighlight>

or this:

<syntaxhighlight lang="java" enclose="div">

<%

   java.util.HashMap params = new java.util.HashMap();
   String name = "World";
   if (controllerResponse != null) {
      params = (java.util.HashMap)controllerResponse.getData();
      if (params != null){
         name = (String) params.get("name");
         name += ", my friend";
      }
   }

%>

Hello <%=name %>!

</syntaxhighlight>

Try It Out

1. Visit https://{domain}/networking/pages/Hello.jsp.
   (For {domain}, substitute the URL you use to access the platform.)
2. Type in a name and click the button to see the results.
3. In the platform, click > Setup > Administration > Global Resources > Debug Log to view the entry you made in the log.
   If that window is already open, refresh it by clicking the "circling arrows" icon in the upper right: .

You should see an entry like this:

Learn More

• Platform ControlerResponse APIs
• Platform Functions
• JSP syntax
• Implicit JSTL Objects

Next

HowTo:Classes, APIs, and Naming Conventions