JSP Attribute Action

JSP Attribute Action Element

  • All the JSP action elements are used during the request processing phase, and not as the directive elements and script elements, which are used during the translation phase
  • All JSP action elements are specified in XML tags and can not be used in an XML directive as these have no end tag
  • The JSP attribute action element defines an attribute value for another JSP XML element.
  • Here is the notation for the JSP attribute action element:
    XML Description
    <jsp:attribute attributes > content </jsp:attribute> The content is an attribute value, typically created by nested JSP XML element.
  • The following table lists the attribute(s) for the JSP attribute action element:
    Attribute Valid values Default Description
    name String value n/a The name of the attribute to assign a value.
    trim true or false false Determines whether or not white space appearing at the beginning and end of the element body should be discarded

Example of using JSP attribute action element.

In the example we use Netbeans IDE and Glassfish Server.

You can download this example here (needed tools can be found in the right menu on this page).

If you like to participate in the review of this example you must first create a Web project in Netbeans (the project name is AttributeAction).

In this example, we will add two files, header.jsp and footer.jsp.

  • It is customary to place all include files, which are used several times in the WEB-INF folder. Some would also like the include files should have the extension .jspf, but this is not a requirement.
    Here is the file we want to include at the top of all pages:
    <h1>Book inventory control</h1>
    <hr>

    For those who participate in the review: create a JSP file in Netbeans and replace generated code for the JSP with that shown above (the JSP file name is Header.jsp and folder should be WEB-INF).

    Here is the file we want to include at the bottom of all pages:
    <hr>
    Status on <%= (new java.util.Date()).toString() %>

    For those who participate in the review: create a JSP file in Netbeans and replace generated code for the JSP with that shown above (the JSP file name is Footer.jsp and folder should be WEB-INF).

In this example, we will add two java files, Book.java and Library.java.

  • We need a java class with information about each book in a library.
    Here is the Book.java:
    package doc;
    
    public class Book {
    
      private String isbn_no;
      private String short_desc;
      private double price;
    
      public Book(String isbn_no, String short_desc, double price) {
        this.isbn_no = isbn_no;
        this.short_desc = short_desc;
        this.price = price;
      }
    
      public String getIsbn_no() {
        return isbn_no;
      }
    
      public String getShort_desc() {
        return short_desc;
      }
    
      public double getprice() {
        return price;
      }
    }

    For those who participate in the review: create a java class in Netbeans and replace generated code for the java file with that shown above (the java file name is Book and package should be doc).

  • We want to register isbn number, description and price of each book we have in our library (Perhaps not the most suitable properties for a book in a library, but anyway ...).
  • We need a java class to control what books we have in our library.
    Here is the Library.java:
    package doc;
    
    import java.util.ArrayList;
    import java.util.List;
    
    public class Library {
    
      private List<Book> books;
    
      public void addBook(Book book) {
        books.add(book);
      }
    
      public Library() {
        books = new ArrayList<Book>();
        addBook(new Book("0201703092", "The Practical SQL", 39));
        addBook(new Book("0471777781", "Professional Ajax", 32));
        addBook(new Book("0764557599", "Professional C#", 42));
      }
    
      public List<Book> getBooks() {
        return books;
      }
    
      public void DeleteBooks(String[] isbns) {
        for (String isbn : isbns) {
          for (Book book : books) {
            if (book.getIsbn_no().equals(isbn)) {
              books.remove(book);
              break;
            }
          }
        }
      }
    }

    For those who participate in the review: create a java class in Netbeans and replace generated code for the java file with that shown above (the java file name is Library and package should be doc).

  • In this class we have a member variable, books, which shall contain all the books in the library. This is instantiated in the default constructor. We've also added some books in this constructor.
  • Moreover, we have a method to add new books and a method of removing books from the library.
  • Finally, we have created a method that returns a list of all the books in the library.

At last we need a JSP file(s) to demonstrate how we use the JSP Attribute action Element.

  • Here is the main JSP file:
    <%@page import="java.util.regex.Pattern"%>
    <%@page contentType="text/html" pageEncoding="UTF-8" 
            import="java.util.*, doc.*" %>
    <!DOCTYPE html >
    <html>
      <head>
        <title>Library Book Control</title>
        <style>
          .gradientdown {
            background:  #e0e6ff;
            background: -webkit-linear-gradient(top, #e0e6ff 0%,#eeeeee 100%); /* Chrome10+,Safari5.1+ */
            background: -o-linear-gradient(#e0e6ff, #eeeeee); /* For Opera 11.1 to 12.0 */
            background: -moz-linear-gradient(top, #e0e6ff, #eeeeee); /* For Firefox 3.6 to 15 */
            background: linear-gradient(top, #e0e6ff 0%,#eeeeee 100%); /* W3C Standard syntax (must be last) */
          }
          table tr.data:nth-of-type(odd) { 
            background: #eeeeee; 
          }
    
          input[type=text] {
            width: 150px;
            padding:5px; 
            border:2px solid #ccc; 
            -webkit-border-radius: 5px;
            border-radius: 5px;
            background-color: lemonchiffon;
          }
    
          input[type=text]:focus {
            border-color:#000ff;
          }
          input[type=submit] {
            width: 166px;
            padding:5px; 
            background:#e0e6ff; 
            cursor:pointer;
            -webkit-border-radius: 5px;
            border-radius: 5px; 
            border: outset #333 2px;
            margin-top: 10px;
          }
        </style>    
      </head>
      <body>
        <div style="max-width:400px; ">
          <jsp:include >
            <jsp:attribute name="page">
              /WEB-INF/header.jsp
            </jsp:attribute>
          </jsp:include>
          <%!
            Library library = new Library();
    
          %>
          <%
            String action = request.getParameter("action");
            if (action != null) {
              if (action.equals("del")) {
                String[] isbns = request.getParameterValues("isbns");
                if (isbns != null) {
                  library.DeleteBooks(isbns);
                }
              }
              if (action.equals("add")) {
                String decimalPattern = "[0-9]+(\\.[0-9][0-9]*)*";
                String isbn_no = request.getParameter("isbn_no");
                String short_desc = request.getParameter("short_desc");
                double price = 0;
                String priceStr = request.getParameter("price");
                boolean match = Pattern.matches(decimalPattern, priceStr);
                if (match) {
                  price = Double.parseDouble(priceStr);
                }
                Book book = new Book(isbn_no, short_desc, price);
                library.addBook(book);
              }
            }
          %>
          <% request.setAttribute("library", library);%> 
          <jsp:include >
            <jsp:attribute name="page">
              /ListBooks.jsp
            </jsp:attribute>
          </jsp:include>        
          <jsp:include >
            <jsp:attribute name="page">
              /AddBook.jsp
            </jsp:attribute>
          </jsp:include>
          <jsp:include >
            <jsp:attribute name="page" >
              /WEB-INF/footer.jsp
            </jsp:attribute>
          </jsp:include>
    
        </div>
      </body>
    </html>

    For those who participate in the review: create a JSP file in Netbeans and replace generated code for the JSP with that shown above (the JSP file name is index).

  • As you can see we have used 4 different include action with the attribute, page, given as an attribute action element.
  • The request.setAttribute("library", library); is set as the include file ListBooks.jsp need it.
    Here is the file ListBooks.jsp, which is included in the file index.jsp:
    <%@page import="doc.Library"%>
    <%@page import="java.util.List"%>
    <%@page import="doc.Book"%>
    <h3>Library book list</h3>
    <form action='index.jsp' method="GET">
      <table  >
        <tr class="gradientdown">
          <th style="width:100px;">Isbn_no</th> 
          <th style="width:150px;">Short desc</th> 
          <th style="width:90px;">Price</th> 
          <th style="width:60px;">Del.</th>
        </tr>
        <%
          Library library = (Library) request.getAttribute("library");
          List<Book> books = library.getBooks();
          for (Book book : books) {
        %>
        <tr class="data">
          <td><%= book.getIsbn_no()%></td> 
          <td><%= book.getShort_desc()%></td> 
          <td><%= book.getprice()%></td> 
          <td><input type="checkbox" name="isbns" 
                     value="<%= book.getIsbn_no()%>" />
          </td> 
        </tr>       
        <%
          }
        %>
      </table>
      <input type="hidden" name="action" value="del"/>
      <input type="submit"  value="Delete book(s)" />
    </form>

    For those who participate in the review: create a JSP file in Netbeans and replace generated code for the JSP with that shown above (the JSP file name is ListBooks).

    Here is the file AddBook.jsp, which is included in the file index.jsp:
    <hr>
    <h3>Add a book</h3>
    <form action='index.jsp' method="POST">
      <table>
        <tr>
          <td><input type="text" name="isbn_no" 
                     placeholder="Isbn number" /></td> 
        </tr>
        <tr>
          <td><input type="text" name="short_desc" 
                     placeholder="Short desc."/></td> 
        </tr>
        <tr>
          <td><input type="text" name="price" 
                     placeholder="Price" /></td> 
        </tr>
      </table>
      <input type="hidden" name="action" value="add"/>
      <input type="submit"  value="Add book" />
    </form>

    For those who participate in the review: create a JSP file in Netbeans and replace generated code for the JSP with that shown above (the JSP file name is AddBook).

How does this work?

  • We have created two JSP files, Header.jsp and Footer,jsp, which we have included in the index.jsp file with JSP include action element and used the JSP attribute action element to specify the page attribute in the include action element .
  • In a declaration scripting elements (<%!) in the index.jsp file we have created an instance of our library. Remember that this is not user session related, but is related to the life of the JSP.
  • In a scriptlet scripting we expect one of two action, delete on or more books from the library or add a new book to the library. Java code is implemented for these action in index.jsp file also.
  • Because we want to use the library class and the book class, we need to import these classes with the page directive.
  • When any delete or add is finish we uses scriptlet scripting to list all the books that exists in the library with the possibility to delete any of them. This list is created through the file ListBooks.jsp, which we include in the index.jsp file using the include action element and attribute action element.
  • At last we have created a form to add a new book to the library. This form input is created through the file List Books.jsp, which we include in the index.jsp file using the include action element and attribute action element.

Creating Deployment descriptor.

  • To run this JSP you have to deploy it to a web-server or a Application server. To deploy means to install the JSP with some instruction to a such server.
  • The instructions are mainly defined to be deployment descriptors. The standard part of the deployment descriptor should be in an XML-file with the name web.xml.

    You may need to create a Deployment descriptor file, web.xml in Netbeans.

  • The contents of the web.xml file should look like this:
    <?xml version="1.0" encoding="UTF-8"?>
    <web-app version="3.1" xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
     http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd">
        <servlet>
            <servlet-name>BookControl</servlet-name>
            <jsp-file>/index.jsp</jsp-file>
        </servlet>
        <servlet-mapping>
            <servlet-name>BookControl</servlet-name>
            <url-pattern>/BookControl</url-pattern>
        </servlet-mapping>
        <session-config>
            <session-timeout>
                30
            </session-timeout>
        </session-config>
        <welcome-file-list>
            <welcome-file>BookControl</welcome-file>
        </welcome-file-list>
    </web-app>
  • This file starts with the normal xml tag for a XML file and the root tag for the deployment descriptor is web-app. Every ting inside the last tag is to tell the server about our application, which in this case is a JSP file.
  • With a servlet tag we give the JSP file a servlet name, which is used in the servlet-mapping tag to specify a url for the JSP file.
  • In this way we can have many urls for the same JSP file.
  • If no session-timeout (the server ends the service of the application after this time) is given a standard timeout for the server is used as timeout for the application.
  • The welcome-file tag specifies the startup for our application, which in this case and our application is the welcome file with url BookControl. Reorganize the welcome-file-list to what is shown above.

Creating Web-server Deployment descriptor.

  • The context-root (in example /AttributeAction) for the application will in most cases be specified by a server vendor deployment descriptor.

    For those who participate in the review: create a Glassfish deployment descriptor in Netbeans.

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE sun-web-app PUBLIC "-//Sun Microsystems, 
    Inc.//DTD GlassFish Application Server 3.0 Servlet 3.0//EN" 
    "http://www.sun.com/software/appserver/dtds/sun-web-app_3_0-0.dtd">
    <sun-web-app error-url="">
      <context-root>/AttributeAction</context-root>
      <class-loader delegate="true"/>
      <jsp-config>
        <property name="keepgenerated" value="true">
          <description>
            Keep a copy of the generated servlet class' java code.
          </description>
        </property>
      </jsp-config>
    </sun-web-app>

Run the application.

  • For those who participate in the review: right click the Web-project and select Run.
  • This results in that the application will be deployed to the server and started.
  • The browser will display:

Another JSP attribute action example, you'll find under JSP Element action.

© 2010 by Finnesand Data. All rights reserved.
This site aims to provide FREE programming training and technics.
Finnesand Data as site owner gives no warranty for the correctness in the pages or source codes.
The risk of using this web-site pages or any program codes from this website is entirely at the individual user.