Home > Articles > Open Source > Ajax & JavaScript

JSP Custom Tags

How Do JSP Custom Tags Work?

This section gives you a brief overview of the mechanics of JSP custom tag extensions, as a basis for delving further into a study of JSP custom tags.

The Tag Handler Class

The behavior of a tag is determined by a JavaBean known as a Tag Handler class. It must implement either the javax.servlet.jsp.tagext.Tag interface or its BodyTag extension. Two classes in the servlet application programming interface (API) do that for you already: TagSupport and BodyTagSupport. Usually, you can extend one of them to define a Tag Handler class.

The Tag Library Descriptor

Tags are always part of a tag library, which is defined by an XML file called a tag library descriptor (TLD) file. Its main purpose is to connect the Tag Handler class with a tag name that will appear in the JSP document. It also gives the JSP container more information about the tags it describes. For example, it declares the tag attributes that can be used with the tag and tells whether they are required or optional.

The Name of a Tag

A JSP tag is approximately an XML tag. Some come standard with all JSP implementations. The name of a tag is in the form prefix:suffix. The prefix is defined in a taglib directive in the JSP file. The directive associates the tags with that prefix and with a particular tag library descriptor file. The suffix is the name that the TLD file associates with a Tag Handler class.

Tag Attributes and Tag Handler Properties

A tag can also have attributes, like an XML tag. (There are some differences in how quotes are used, however.) These attributes enable the JSP page author to pass values to the Tag Handler class. Each tag attribute corresponds to a property within the bean that implements the Tag (or BodyTag) interface.

The BodyContent Class and Body Content Processing

Body content can exist between a start tag and an end tag. The TLD description of the tag can enforce empty content or allow JSP or tag-dependent content. Tags that implement only the Tag interface, usually by extending TagSupport, can only ignore or include body content in the JSP. Tags that implement BodyTag, usually by extending BodyTagSupport, can manipulate and iteratively process body content. The BodyContent class is a special JspWriter object that encapsulates the body content while a tag is manipulating it.

Tag Action Methods in a Tag Handler

The methods within the Tag Handler class are related to the various parts of the tag. Thus, there is a method to handle the opening tag, called doStartTag(). Another method, doEndTag(), handles the closing tag. If a tag has attributes, then each one requires a property-setter method in the Tag Handler class and can have a get method. If the tag has a body, two other methods handles that: doInitBody() and doAfterBody(). Each method returns certain final static constants to control the sequential execution of these methods.

Context and Nesting of Tag Handler Instances

When a JSP is translated into source code for a servlet, the Tag Handler class for any custom tags on the JSP are instantiated within the _jspService() method of the servlet. The tag handler instance has a property set to refer to the powerful pageContext object of the JSP. Tags can nest. If a tag is nested in another, its parent property contains a reference to the tag it is nested in. Tags can find each other and share objects in any Web application scope. BodyContents can form a stack to facilitate nested manipulation of body content.

Translation-Time Tag Extension Methods

The javax.servlet.jsp.tagext package contains classes that implement JSP custom tags. Besides the ones mentioned previously, there are other classes that give the JSP container information at JSP translation time about tags and the variables they use:

  • TagAttributeInfo

  • TagData

  • TagExtraInfo

  • TagInfo

  • TagLibraryInfo

  • VariableInfo

The doStartTag() Method

Implementing the Tag interface implies defining a doStartTag() method. A Tag Handler class can either do that or extend the TagSupport class and override its doStartTag() method to begin the action. When the method begins, the JSP container will have set the pageContext property and also the parent property (null, if the tag is not nested). It will also have set all the tag attribute properties provided in the start tag. As the developer, you control whether the body content is processed next by returning the appropriate constant. Here is what a doStartTag looks like when you want to ignore body content:

public int doStartTag() throws JspException {
// do something, or nothing
return SKIP_BODY;
}

This means that everything between the opening and closing tags of the custom JSP element will be ignored. If that is not the desired behavior, you can return a different value, as follows:

public int doStartTag() throws JspException {
// do something, or nothing
return EVAL_BODY_INCLUDE
}

This means that everything between the opening and closing tags of the custom JSP element will be evaluated into the current output stream object. In the case of a simple, non-nested tag, that object starts out being the JspWriter instance named "out." The tag element in the TLD for the tag must not have a value of empty, of course. SKIP_BODY and EVAL_BODY_INCLUDE are the only return values for doStartTag() if only Tag is implemented. If BodyTag is implemented, a new BodyContent output stream will be created, and returning EVAL_BODY_TAG will throw a JspException. Tags that implement BodyTag should return either SKIP_BODY or EVAL_BODY_TAG, as follows:

public int doStartTag() throws JspException {
// do something, or nothing
return EVAL_BODY_TAG;
}

After this last example of doStartTag(), the JSP container can invoke two other methods to process the body content: doInitBody() and doAfterBody(), discussed next.

The doInitBody() Method

The doInitBody() method can be used to do some processing before any body content is evaluated (into the BodyContent output stream). After the invocation of doInitBody(), the tag body content is evaluated and the doAfterBody() method is invoked.

The doAfterBody() Method

The doAfterBody() method is invoked after the first evaluation of the body content (if it is not empty). By returning SKIP_BODY, the doAfterBody() method can tell the JSP container that the processing of the body content is finished:

public int doAfterBody() throws JspException {
// do something, or nothing
return SKIP_BODY;
}

Sometimes the tag handler class must continually process the body content of a custom tag in a loop. You can tell the JSP container to repeatedly evaluate the body content and doAfterBody() invocation by returning EVAL_BODY_TAG from doAfterBody(). Note that because processing can change the body content or its context, each body content evaluation can have differing results.

public int doAfterBody() throws JspException {
//do something, or nothing
return EVAL_BODY_TAG;
}

The doEndTag() Method

Whether only the Tag interface or the BodyTag interface is implemented by a Tag Handler class, the doEndTag() method is invoked by the container. It can be used for any final processing in the action, whether body content has been evaluated or not. The container will call the release() method to release tag state.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020