blob: f3a14099c6e58bb099c92dc0a1f9f586c3db57bf [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="Date-Revision-yyyymmdd" content="20140918"/>
<meta http-equiv="Content-Language" content="en"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Preperable Interface</title>
<link href="//,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css">
<link href="//" rel="stylesheet">
<link href="/css/main.css" rel="stylesheet">
<link href="/css/custom.css" rel="stylesheet">
<link href="/highlighter/github-theme.css" rel="stylesheet">
<script src="//"></script>
<script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="/js/community.js"></script>
<a href="" class="github-ribbon">
<img style="position: absolute; right: 0; border: 0;" src="" alt="Fork me on GitHub">
<div role="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a>
<div id="struts-menu" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Home<b class="caret"></b>
<ul class="dropdown-menu">
<li><a href="/index.html">Welcome</a></li>
<li><a href="/download.cgi">Download</a></li>
<li><a href="/releases.html">Releases</a></li>
<li><a href="/announce-2021.html">Announcements</a></li>
<li><a href="">License</a></li>
<li><a href="">Thanks!</a></li>
<li><a href="">Sponsorship</a></li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Support<b class="caret"></b>
<ul class="dropdown-menu">
<li><a href="/mail.html">User Mailing List</a></li>
<li><a href="">Issue Tracker</a></li>
<li><a href="/security.html">Reporting Security Issues</a></li>
<li class="divider"></li>
<li><a href="">Version Notes</a></li>
<li><a href="">Security Bulletins</a></li>
<li class="divider"></li>
<li><a href="/maven/project-info.html">Maven Project Info</a></li>
<li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li>
<li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Documentation<b class="caret"></b>
<ul class="dropdown-menu">
<li><a href="/birdseye.html">Birds Eye</a></li>
<li><a href="/primer.html">Key Technologies</a></li>
<li><a href="/kickstart.html">Kickstart FAQ</a></li>
<li><a href="">Wiki</a></li>
<li class="divider"></li>
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/security/">Security Guide</a></li>
<li><a href="/core-developers/">Core Developers Guide</a></li>
<li><a href="/tag-developers/">Tag Developers Guide</a></li>
<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
<li><a href="/plugins/">Plugins</a></li>
<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
<li><a href="">FAQs</a></li>
<li><a href="">Plugin registry</a></li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Contributing<b class="caret"></b>
<ul class="dropdown-menu">
<li><a href="/youatstruts.html">You at Struts</a></li>
<li><a href="/helping.html">How to Help FAQ</a></li>
<li><a href="/dev-mail.html">Development Lists</a></li>
<li><a href="/contributors/">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/submitting-patches.html">Submitting patches</a></li>
<li><a href="/builds.html">Source Code and Builds</a></li>
<li><a href="/coding-standards.html">Coding standards</a></li>
<li><a href="">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/release-guidelines.html">Release Guidelines</a></li>
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="">Source Repository</a></li>
<li><a href="/updating-website.html">Updating the website</a></li>
<li class="apache"><a href=""><img src="/img/apache.png"></a></li>
<article class="container">
<section class="col-md-12">
<a class="edit-on-gh" href="" title="Edit this page on GitHub">Edit on GitHub</a>
<a href="index.html" title="back to Getting started"><< back to Getting started</a>
<h1 class="no_toc" id="preparable-interface">Preparable Interface</h1>
<ul id="markdown-toc">
<li><a href="#introduction" id="markdown-toc-introduction">Introduction</a></li>
<li><a href="#preparable-interface-1" id="markdown-toc-preparable-interface-1">Preparable Interface</a></li>
<li><a href="#example-application" id="markdown-toc-example-application">Example Application</a></li>
<li><a href="#summary" id="markdown-toc-summary">Summary</a></li>
<p>The example code for this tutorial, <strong>preparable-interface</strong>, is available at <a href="">struts-examples</a>.</p>
<h2 id="introduction">Introduction</h2>
<p>Often the data used to populate a form control is dynamically generated, perhaps from a database. When the user submits
the form, the Struts 2 validation interceptor attempts to validate the user’s form input. If validation fails the Struts 2
framework returns the value <code class="highlighter-rouge">input</code> but the <code class="highlighter-rouge">input</code> action is not re-executed. Rather the view associated with the <code class="highlighter-rouge">input</code>
result is rendered to the user. Usually this view is the page that displayed the original form.</p>
<p>This work-flow can cause a problem if one or more of the form fields or some other data displayed depends on a dynamic
look-up that that is accomplished in the Action class’s input method. Since the Action class’s input method is not
re-executed when validation fails, the view page may no longer have access to the correct information to create the form
or other display information.</p>
<p>The <a href="">Struts 2 user mailing list</a> is an excellent place to get help. If you are having
a problem getting the tutorial example applications to work search the Struts 2 mailing list. If you don’t find an answer
to your problem, post a question on the mailing list.</p>
<h2 id="preparable-interface-1">Preparable Interface</h2>
<p>Struts 2 provides the <a href="../maven/struts2-core/apidocs/com/opensymphony/xwork2/Preparable.html">Preparable interface</a>
to overcome this problem. An Action class that implements this interface must override the prepare method. The <code class="highlighter-rouge">prepare</code>
method will always be called by the Struts 2 framework’s <a href="../core-developers/prepare-interceptor.html">prepare interceptor</a>
whenever any method is called for the Action class and also when validation fails before the view is rendered.</p>
<p>In the <code class="highlighter-rouge">prepare</code> method you should put any statements that must be executed no matter what other Action class method will
be called and also statements that should be executed if validation fails. Usually statements in the prepare method set
the value for Action class instance fields that will be used to populate form controls and get the values that will be
used to set the initial form field values.</p>
<p>In addition to automatically running the prepare method the <a href="../core-developers/prepare-interceptor.html">prepare interceptor</a>
will also call a method named <code class="highlighter-rouge">prepare&lt;ActionMethodName&gt;</code>. For example, define a prepare method and a <code class="highlighter-rouge">prepareInput</code> method
in the Action class that implements <code class="highlighter-rouge">Preparable</code>. When the Struts 2 framework calls the input method, the prepare interceptor
will call the prepareInput and the prepare methods before calling the input method.</p>
<h2 id="example-application">Example Application</h2>
<p>If you examine class EditAction in the example application (see above) you’ll see that it implements the <code class="highlighter-rouge">Preparable</code> interface.
In the prepare method is this code:</p>
<p><strong> prepare Method</strong></p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">carModelsAvailable</span> <span class="o">=</span> <span class="n">carModelsService</span><span class="o">.</span><span class="na">getCarModels</span><span class="o">();</span>
<span class="n">setPersonBean</span><span class="o">(</span><span class="n">editService</span><span class="o">.</span><span class="na">getPerson</span><span class="o">());</span>
<p>The above statements get the car model values used to populate the car model check boxes displayed in the form and also
get the information about the Person object being edited.</p>
<p>When you run the example application, look in the log to see when the prepare method is called in relation to the input
and execute methods. Running the example application and examining the log should help you understand the impact of implementing
the <code class="highlighter-rouge">Preparable</code> interface and the prepare method.</p>
<h2 id="summary">Summary</h2>
<p>When your application requires specific statements to be executed no matter which method of the Action class is called
or when validation fails, you should implement the Preparable interface and override the prepare method.</p>
<td>Return to <a href="http-session.html">HTTP Session</a></td>
<td>onward to <a href="exclude-parameters.html">Exclude Parameters</a></td>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2018 <a href="">The Apache Software Foundation </a>.
All Rights Reserved.
<div class="col-md-12">
Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are
trademarks of The Apache Software Foundation.
<div class="col-md-12">Logo and website design donated by <a href="">SoftwareMill</a>.</div>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s); = id;
js.src = "//";
fjs.parentNode.insertBefore(js, fjs);
}(document, "script", "twitter-wjs");</script>
<script src="" async="async" defer="defer"></script>
<div id="fb-root"></div>
<script>(function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s); = id;
js.src = "//";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>