~ubuntu-branches/ubuntu/trusty/libstruts1.2-java/trusty-proposed

<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/action/ActionBase.html">ActionBase</A>, <A HREF="../../../../org/apache/struts/actions/AddFormBeanAction.html">AddFormBeanAction</A>, <A HREF="../../../../org/apache/struts/actions/AddForwardAction.html">AddForwardAction</A>, <A HREF="../../../../org/apache/struts/actions/AddMappingAction.html">AddMappingAction</A>, <A HREF="../../../../org/apache/struts/actions/DispatchAction.html">DispatchAction</A>, <A HREF="../../../../org/apache/struts/actions/ForwardAction.html">ForwardAction</A>, <A HREF="../../../../org/apache/struts/actions/IncludeAction.html">IncludeAction</A>, <A HREF="../../../../org/apache/struts/actions/ReloadAction.html">ReloadAction</A>, <A HREF="../../../../org/apache/struts/actions/RemoveFormBeanAction.html">RemoveFormBeanAction</A>, <A HREF="../../../../org/apache/struts/actions/RemoveForwardAction.html">RemoveForwardAction</A>, <A HREF="../../../../org/apache/struts/actions/RemoveMappingAction.html">RemoveMappingAction</A></DD>

</DL>

<HR>

<DL>

<DT>public class <B>Action</B><DT>extends java.lang.Object</DL>

<P>

An <strong>Action</strong> is an adapter between the contents of an incoming

HTTP request and the corresponding business logic that should be executed to

process this request. The controller (ActionServlet) will select an

appropriate Action for each request, create an instance (if necessary),

and call the <code>perform</code> method.

<p>

Actions must be programmed in a thread-safe manner, because the controller

will share the same instance for multiple simultaneous requests. In

this means you should design with the following items in mind:

<ul>

<li>Instance and static variables MUST NOT be used to store information

related to the state of a particular request. They MAY be used to

share global resources across requests for the same action.</li>

<li>Access to other resources (JavaBeans, session variables, etc.) MUST

be synchronized if those resources require protection. (Generally,

however, resource classes should be designed to provide their own

protection where necessary.</li>

</ul>

<p>

When an <code>Action</code> instance is first created, the controller

servlet will call <code>setServlet()</code> with a non-null argument to

identify the controller servlet instance to which this Action is attached.

When the controller servlet is to be shut down (or restarted), the

<code>setServlet()</code> method will be called with a <code>null</code>

argument, which can be used to clean up any allocated resources in use

by this Action.

<P>

100

<DL>

101

<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:03:01 $</DD>

102

<DT><B>Author: </B><DD>Craig R. McClanahan</DD>

103

</DL>

104

<HR>

105

106

<P>

107

108

109

110

111

112

113

114

115

116

<B>Field Summary</B></FONT></TD>

117

</TR>

118

119

120

<CODE>static java.lang.String</CODE></FONT></TD>

121

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#DATA_SOURCE_KEY">DATA_SOURCE_KEY</A></B></CODE>

122

123

<BR>

124

          The context attributes key under which our <strong>default</strong>

125

configured data source (which must implement

126

<code>javax.sql.DataSource</code>) is stored,

127

if one is configured for this application.</TD>

128

</TR>

129

130

131

<CODE>protected static java.util.Locale</CODE></FONT></TD>

132

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#defaultLocale">defaultLocale</A></B></CODE>

133

134

<BR>

135

          The system default Locale.</TD>

136

</TR>

137

138

139

<CODE>static java.lang.String</CODE></FONT></TD>

140

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#ERROR_KEY">ERROR_KEY</A></B></CODE>

141

142

<BR>

143

          The request attributes key under which your action should store an

144

<code>org.apache.struts.action.ActionErrors</code> object, if you

145

are using the corresponding custom tag library elements.</TD>

146

</TR>

147

148

149

<CODE>static java.lang.String</CODE></FONT></TD>

150

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#EXCEPTION_KEY">EXCEPTION_KEY</A></B></CODE>

151

152

<BR>

153

          The request attributes key under which Struts custom tags might store a

154

<code>Throwable</code> that caused them to report a JspException at

155

runtime.</TD>

156

</TR>

157

158

159

<CODE>static java.lang.String</CODE></FONT></TD>

160

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#FORM_BEANS_KEY">FORM_BEANS_KEY</A></B></CODE>

161

162

<BR>

163

          The context attributes key under which our

164

<code>org.apache.struts.action.ActionFormBeans</code> collection

165

is normally stored, unless overridden when initializing our

166

ActionServlet.</TD>

167

</TR>

168

169

170

<CODE>static java.lang.String</CODE></FONT></TD>

171

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#FORWARDS_KEY">FORWARDS_KEY</A></B></CODE>

172

173

<BR>

174

          The context attributes key under which our

175

<code>org.apache.struts.action.ActionForwards</code> collection

176

is normally stored, unless overridden when initializing our

177

ActionServlet.</TD>

178

</TR>

179

180

181

<CODE>static java.lang.String</CODE></FONT></TD>

182

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#LOCALE_KEY">LOCALE_KEY</A></B></CODE>

183

184

<BR>

185

          The session attributes key under which the user's selected

186

<code>java.util.Locale</code> is stored, if any.</TD>

187

</TR>

188

189

190

<CODE>static java.lang.String</CODE></FONT></TD>

191

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MAPPING_KEY">MAPPING_KEY</A></B></CODE>

192

193

<BR>

194

          The request attributes key under which our

195

<code>org.apache.struts.ActionMapping</code> instance

196

is passed.</TD>

197

</TR>

198

199

200

<CODE>static java.lang.String</CODE></FONT></TD>

201

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MAPPINGS_KEY">MAPPINGS_KEY</A></B></CODE>

202

203

<BR>

204

          The context attributes key under which our

205

<code>org.apache.struts.action.ActionMappings</code> collection

206

is normally stored, unless overridden when initializing our

207

ActionServlet.</TD>

208

</TR>

209

210

211

<CODE>static java.lang.String</CODE></FONT></TD>

212

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MESSAGES_KEY">MESSAGES_KEY</A></B></CODE>

213

214

<BR>

215

          The context attributes key under which our application resources are

216

normally stored, unless overridden when initializing our ActionServlet.</TD>

217

</TR>

218

219

220

<CODE>static java.lang.String</CODE></FONT></TD>

221

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#MULTIPART_KEY">MULTIPART_KEY</A></B></CODE>

222

223

<BR>

224

          The request attributes key under which our multipart class is stored.</TD>

225

</TR>

226

227

228

<CODE>protected  <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD>

229

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#servlet">servlet</A></B></CODE>

230

231

<BR>

232

          The controller servlet to which we are attached.</TD>

233

</TR>

234

235

236

<CODE>static java.lang.String</CODE></FONT></TD>

237

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#SERVLET_KEY">SERVLET_KEY</A></B></CODE>

238

239

<BR>

240

          The context attributes key under which we store the mapping defined

241

for our controller serlet, which will be either a path-mapped pattern

242

(<code>/action/*</code>) or an extension mapped pattern

243

(<code>*.do</code>).</TD>

244

</TR>

245

246

247

<CODE>static java.lang.String</CODE></FONT></TD>

248

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#TRANSACTION_TOKEN_KEY">TRANSACTION_TOKEN_KEY</A></B></CODE>

249

250

<BR>

251

          The session attributes key under which our transaction token is

252

stored, if it is used.</TD>

253

</TR>

254

</TABLE>

255

256

257

258

259

260

261

262

<B>Constructor Summary</B></FONT></TD>

263

</TR>

264

265

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#Action()">Action</A></B>()</CODE>

266

267

<BR>

268

           </TD>

269

</TR>

270

</TABLE>

271

272

273

274

275

276

277

278

<B>Method Summary</B></FONT></TD>

279

</TR>

280

281

282

<CODE>protected  java.lang.String</CODE></FONT></TD>

283

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#generateToken(javax.servlet.http.HttpServletRequest)">generateToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

284

285

<BR>

286

          Generate a new transaction token, to be used for enforcing a single

287

request for a particular transaction.</TD>

288

</TR>

289

290

291

<CODE>protected  java.util.Locale</CODE></FONT></TD>

292

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getLocale(javax.servlet.http.HttpServletRequest)">getLocale</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

293

294

<BR>

295

          Return the user's currently selected Locale.</TD>

296

</TR>

297

298

299

<CODE>protected  <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>

300

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getResources()">getResources</A></B>()</CODE>

301

302

<BR>

303

          Return the message resources for this application.</TD>

304

</TR>

305

306

307

<CODE> <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A></CODE></FONT></TD>

308

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#getServlet()">getServlet</A></B>()</CODE>

309

310

<BR>

311

          Return the controller servlet instance to which we are attached.</TD>

312

</TR>

313

314

315

<CODE>protected  boolean</CODE></FONT></TD>

316

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#isCancelled(javax.servlet.http.HttpServletRequest)">isCancelled</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

317

318

<BR>

319

          Returns <code>true</code> if the current form's cancel button was

320

pressed.</TD>

321

</TR>

322

323

324

<CODE>protected  boolean</CODE></FONT></TD>

325

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#isTokenValid(javax.servlet.http.HttpServletRequest)">isTokenValid</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

326

327

<BR>

328

          Return <code>true</code> if there is a transaction token stored in

329

the user's current session, and the value submitted as a request

330

parameter with this action matches it.</TD>

331

</TR>

332

333

334

<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>

335

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

336

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

337

javax.servlet.http.HttpServletRequest request,

338

javax.servlet.http.HttpServletResponse response)</CODE>

339

340

<BR>

341

          Process the specified HTTP request, and create the corresponding HTTP

342

response (or forward to another web component that will create it).</TD>

343

</TR>

344

345

346

<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>

347

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

348

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

349

javax.servlet.ServletRequest request,

350

javax.servlet.ServletResponse response)</CODE>

351

352

<BR>

353

          Process the specified non-HTTP request, and create the corresponding

354

non-HTTP response (or forward to another web component that will create

355

it).</TD>

356

</TR>

357

358

359

<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>

360

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionServlet, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet,

361

<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

362

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

363

javax.servlet.http.HttpServletRequest request,

364

javax.servlet.http.HttpServletResponse response)</CODE>

365

366

<BR>

367

          <B>Deprecated.</B> <I>Use the new perform() method without a servlet argument</I></TD>

368

</TR>

369

370

371

<CODE> <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A></CODE></FONT></TD>

372

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#perform(org.apache.struts.action.ActionServlet, org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">perform</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet,

373

<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

374

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

375

javax.servlet.ServletRequest request,

376

javax.servlet.ServletResponse response)</CODE>

377

378

<BR>

379

          <B>Deprecated.</B> <I>Use the new perform() method without a servlet argument</I></TD>

380

</TR>

381

382

383

<CODE>protected  void</CODE></FONT></TD>

384

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#resetToken(javax.servlet.http.HttpServletRequest)">resetToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

385

386

<BR>

387

          Reset the saved transaction token in the user's session.</TD>

388

</TR>

389

390

391

<CODE>protected  void</CODE></FONT></TD>

392

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#saveErrors(javax.servlet.http.HttpServletRequest, org.apache.struts.action.ActionErrors)">saveErrors</A></B>(javax.servlet.http.HttpServletRequest request,

393

<A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> errors)</CODE>

394

395

<BR>

396

          Save the specified error messages keys into the appropriate request

397

attribute for use by the <struts:errors> tag, if any messages

398

are required.</TD>

399

</TR>

400

401

402

<CODE>protected  void</CODE></FONT></TD>

403

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#saveToken(javax.servlet.http.HttpServletRequest)">saveToken</A></B>(javax.servlet.http.HttpServletRequest request)</CODE>

404

405

<BR>

406

          Save a new transaction token in the user's current session, creating

407

a new session if necessary.</TD>

408

</TR>

409

410

411

<CODE>protected  void</CODE></FONT></TD>

412

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#setLocale(javax.servlet.http.HttpServletRequest, java.util.Locale)">setLocale</A></B>(javax.servlet.http.HttpServletRequest request,

413

java.util.Locale locale)</CODE>

414

415

<BR>

416

          Set the user's currently selected Locale.</TD>

417

</TR>

418

419

420

421

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#setServlet(org.apache.struts.action.ActionServlet)">setServlet</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</CODE>

422

423

<BR>

424

          Set the controller servlet instance to which we are attached (if

425

<code>servlet</code> is non-null), or release any allocated resources

426

(if <code>servlet</code> is null).</TD>

427

</TR>

428

429

430

<CODE>protected  java.lang.String</CODE></FONT></TD>

431

<TD><CODE><B><A HREF="../../../../org/apache/struts/action/Action.html#toHex(byte[])">toHex</A></B>(byte[] buffer)</CODE>

432

433

<BR>

434

          Convert a byte array to a String of hexadecimal digits and return it.</TD>

435

</TR>

436

</TABLE>

437

438

439

440

<TD><B>Methods inherited from class java.lang.Object</B></TD>

441

</TR>

442

443

<TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>

444

</TR>

445

</TABLE>

446

447

<P>

448

449

450

451

452

453

454

455

<B>Field Detail</B></FONT></TD>

456

</TR>

457

</TABLE>

458

459

460

DATA_SOURCE_KEY</H3>

461

<PRE>

462

public static final java.lang.String <B>DATA_SOURCE_KEY</B></PRE>

463

<DL>

464

<DD>The context attributes key under which our <strong>default</strong>

465

configured data source (which must implement

466

<code>javax.sql.DataSource</code>) is stored,

467

if one is configured for this application.</DL>

468

<HR>

469

470

471

ERROR_KEY</H3>

472

<PRE>

473

public static final java.lang.String <B>ERROR_KEY</B></PRE>

474

<DL>

475

<DD>The request attributes key under which your action should store an

476

<code>org.apache.struts.action.ActionErrors</code> object, if you

477

are using the corresponding custom tag library elements.</DL>

478

<HR>

479

480

481

EXCEPTION_KEY</H3>

482

<PRE>

483

public static final java.lang.String <B>EXCEPTION_KEY</B></PRE>

484

<DL>

485

<DD>The request attributes key under which Struts custom tags might store a

486

<code>Throwable</code> that caused them to report a JspException at

487

runtime. This value can be used on an error page to provide more

488

detailed information about what really went wrong.</DL>

489

<HR>

490

491

492

FORM_BEANS_KEY</H3>

493

<PRE>

494

public static final java.lang.String <B>FORM_BEANS_KEY</B></PRE>

495

<DL>

496

<DD>The context attributes key under which our

497

<code>org.apache.struts.action.ActionFormBeans</code> collection

498

is normally stored, unless overridden when initializing our

499

ActionServlet.</DL>

500

<HR>

501

502

503

FORWARDS_KEY</H3>

504

<PRE>

505

public static final java.lang.String <B>FORWARDS_KEY</B></PRE>

506

<DL>

507

<DD>The context attributes key under which our

508

<code>org.apache.struts.action.ActionForwards</code> collection

509

is normally stored, unless overridden when initializing our

510

ActionServlet.</DL>

511

<HR>

512

513

514

LOCALE_KEY</H3>

515

<PRE>

516

public static final java.lang.String <B>LOCALE_KEY</B></PRE>

517

<DL>

518

<DD>The session attributes key under which the user's selected

519

<code>java.util.Locale</code> is stored, if any. If no such

520

attribute is found, the system default locale

521

will be used when retrieving internationalized messages. If used, this

522

attribute is typically set during user login processing.</DL>

523

<HR>

524

525

526

MAPPING_KEY</H3>

527

<PRE>

528

public static final java.lang.String <B>MAPPING_KEY</B></PRE>

529

<DL>

530

<DD>The request attributes key under which our

531

<code>org.apache.struts.ActionMapping</code> instance

532

is passed.</DL>

533

<HR>

534

535

536

MAPPINGS_KEY</H3>

537

<PRE>

538

public static final java.lang.String <B>MAPPINGS_KEY</B></PRE>

539

<DL>

540

<DD>The context attributes key under which our

541

<code>org.apache.struts.action.ActionMappings</code> collection

542

is normally stored, unless overridden when initializing our

543

ActionServlet.</DL>

544

<HR>

545

546

547

MESSAGES_KEY</H3>

548

<PRE>

549

public static final java.lang.String <B>MESSAGES_KEY</B></PRE>

550

<DL>

551

<DD>The context attributes key under which our application resources are

552

normally stored, unless overridden when initializing our ActionServlet.</DL>

553

<HR>

554

555

556

MULTIPART_KEY</H3>

557

<PRE>

558

public static final java.lang.String <B>MULTIPART_KEY</B></PRE>

559

<DL>

560

<DD>The request attributes key under which our multipart class is stored.</DL>

561

<HR>

562

563

564

SERVLET_KEY</H3>

565

<PRE>

566

public static final java.lang.String <B>SERVLET_KEY</B></PRE>

567

<DL>

568

<DD>The context attributes key under which we store the mapping defined

569

for our controller serlet, which will be either a path-mapped pattern

570

(<code>/action/*</code>) or an extension mapped pattern

571

(<code>*.do</code>).</DL>

572

<HR>

573

574

575

TRANSACTION_TOKEN_KEY</H3>

576

<PRE>

577

public static final java.lang.String <B>TRANSACTION_TOKEN_KEY</B></PRE>

578

<DL>

579

<DD>The session attributes key under which our transaction token is

580

stored, if it is used.</DL>

581

<HR>

582

583

584

defaultLocale</H3>

585

<PRE>

586

protected static java.util.Locale <B>defaultLocale</B></PRE>

587

<DL>

588

<DD>The system default Locale.</DL>

589

<HR>

590

591

592

servlet</H3>

593

<PRE>

594

protected <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>servlet</B></PRE>

595

<DL>

596

<DD>The controller servlet to which we are attached.</DL>

597

598

599

600

601

602

603

604

<B>Constructor Detail</B></FONT></TD>

605

</TR>

606

</TABLE>

607

608

609

Action</H3>

610

<PRE>

611

public <B>Action</B>()</PRE>

612

<DL>

613

</DL>

614

615

616

617

618

619

620

621

<B>Method Detail</B></FONT></TD>

622

</TR>

623

</TABLE>

624

625

626

getServlet</H3>

627

<PRE>

628

public <A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> <B>getServlet</B>()</PRE>

629

<DL>

630

<DD>Return the controller servlet instance to which we are attached.</DL>

631

<HR>

632

633

634

setServlet</H3>

635

<PRE>

636

public void <B>setServlet</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet)</PRE>

637

<DL>

638

<DD>Set the controller servlet instance to which we are attached (if

639

<code>servlet</code> is non-null), or release any allocated resources

640

(if <code>servlet</code> is null).<DD><DL>

641

<DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The new controller servlet, if any</DL>

642

</DD>

643

</DL>

644

<HR>

645

646

647

perform</H3>

648

<PRE>

649

public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet,

650

<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

651

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

652

javax.servlet.ServletRequest request,

653

javax.servlet.ServletResponse response)

654

throws java.io.IOException,

655

javax.servlet.ServletException</PRE>

656

<DL>

657

<DD><B>Deprecated.</B> <I>Use the new perform() method without a servlet argument</I>

658

<P>

659

<DD>Process the specified non-HTTP request, and create the corresponding

660

non-HTTP response (or forward to another web component that will create

661

it). Return an <code>ActionForward</code> instance describing where

662

and how control should be forwarded, or <code>null</code> if the

663

response has already been completed.<DD><DL>

664

<DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The ActionServlet instance owning this Action<DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>actionForm</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>response</CODE> - The servlet response we are processing<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs</DL>

665

</DD>

666

</DL>

667

<HR>

668

669

670

perform</H3>

671

<PRE>

672

public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

673

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

674

javax.servlet.ServletRequest request,

675

javax.servlet.ServletResponse response)

676

throws java.io.IOException,

677

javax.servlet.ServletException</PRE>

678

<DL>

679

<DD>Process the specified non-HTTP request, and create the corresponding

680

non-HTTP response (or forward to another web component that will create

681

it). Return an <code>ActionForward</code> instance describing where

682

and how control should be forwarded, or <code>null</code> if the

683

response has already been completed.

684

<p>

685

The default implementation attempts to forward to the HTTP version of

686

this method.<DD><DL>

687

<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>actionForm</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The non-HTTP request we are processing<DD><CODE>response</CODE> - The non-HTTP response we are creating<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs</DL>

688

</DD>

689

</DL>

690

<HR>

691

692

693

perform</H3>

694

<PRE>

695

public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet,

696

<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

697

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

698

javax.servlet.http.HttpServletRequest request,

699

javax.servlet.http.HttpServletResponse response)

700

throws java.io.IOException,

701

javax.servlet.ServletException</PRE>

702

<DL>

703

<DD><B>Deprecated.</B> <I>Use the new perform() method without a servlet argument</I>

704

<P>

705

<DD>Process the specified HTTP request, and create the corresponding

706

HTTP response (or forward to another web component that will create

707

it). Return an <code>ActionForward</code> instance describing where

708

and how control should be forwarded, or <code>null</code> if the

709

response has already been completed.<DD><DL>

710

711

</DD>

712

</DL>

713

<HR>

714

715

716

perform</H3>

717

<PRE>

718

public <A HREF="../../../../org/apache/struts/action/ActionForward.html">ActionForward</A> <B>perform</B>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping,

719

<A HREF="../../../../org/apache/struts/action/ActionForm.html">ActionForm</A> form,

720

javax.servlet.http.HttpServletRequest request,

721

javax.servlet.http.HttpServletResponse response)

722

throws java.io.IOException,

723

javax.servlet.ServletException</PRE>

724

<DL>

725

<DD>Process the specified HTTP request, and create the corresponding HTTP

726

response (or forward to another web component that will create it).

727

Return an <code>ActionForward</code> instance describing where and how

728

control should be forwarded, or <code>null</code> if the response has

729

already been completed.<DD><DL>

730

<DT><B>Parameters:</B><DD><CODE>mapping</CODE> - The ActionMapping used to select this instance<DD><CODE>actionForm</CODE> - The optional ActionForm bean for this request (if any)<DD><CODE>request</CODE> - The HTTP request we are processing<DD><CODE>response</CODE> - The HTTP response we are creating<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input/output error occurs<DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs</DL>

731

</DD>

732

</DL>

733

<HR>

734

735

736

generateToken</H3>

737

<PRE>

738

protected java.lang.String <B>generateToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>

739

<DL>

740

<DD>Generate a new transaction token, to be used for enforcing a single

741

request for a particular transaction.<DD><DL>

742

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing</DL>

743

</DD>

744

</DL>

745

<HR>

746

747

748

getLocale</H3>

749

<PRE>

750

protected java.util.Locale <B>getLocale</B>(javax.servlet.http.HttpServletRequest request)</PRE>

751

<DL>

752

<DD>Return the user's currently selected Locale.<DD><DL>

753

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing</DL>

754

</DD>

755

</DL>

756

<HR>

757

758

759

getResources</H3>

760

<PRE>

761

protected <A HREF="../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>getResources</B>()</PRE>

762

<DL>

763

<DD>Return the message resources for this application.</DL>

764

<HR>

765

766

767

isCancelled</H3>

768

<PRE>

769

protected boolean <B>isCancelled</B>(javax.servlet.http.HttpServletRequest request)</PRE>

770

<DL>

771

<DD>Returns <code>true</code> if the current form's cancel button was

772

pressed. This method will check if the cancel button generated by

773

<strong>CancelTag</strong> was pressed by the user in the

774

current request. If true, validation performed by an

775

<strong>ActionForm</strong> validate() method will have been

776

skipped by the controller servlet.<DD><DL>

777

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/struts/taglib/CancelTag.html"><CODE>CancelTag</CODE></A>,

778

<A HREF="../../../../org/apache/struts/action/ValidatingActionForm.html"><CODE>ValidatingActionForm</CODE></A></DL>

779

</DD>

780

</DL>

781

<HR>

782

783

784

isTokenValid</H3>

785

<PRE>

786

protected boolean <B>isTokenValid</B>(javax.servlet.http.HttpServletRequest request)</PRE>

787

<DL>

788

<DD>Return <code>true</code> if there is a transaction token stored in

789

the user's current session, and the value submitted as a request

790

parameter with this action matches it. Returns <code>false</code>

791

under any of the following circumstances:

792

<ul>

793

<li>No session associated with this request</li>

794

<li>No transaction token saved in the session</li>

795

<li>No transaction token included as a request parameter</li>

796

<li>The included transaction token value does not match the

797

transaction token in the user's session</li>

798

</ul><DD><DL>

799

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>

800

</DD>

801

</DL>

802

<HR>

803

804

805

resetToken</H3>

806

<PRE>

807

protected void <B>resetToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>

808

<DL>

809

<DD>Reset the saved transaction token in the user's session. This

810

indicates that transactional token checking will not be needed

811

on the next request that is submitted.<DD><DL>

812

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>

813

</DD>

814

</DL>

815

<HR>

816

817

818

saveErrors</H3>

819

<PRE>

820

protected void <B>saveErrors</B>(javax.servlet.http.HttpServletRequest request,

821

<A HREF="../../../../org/apache/struts/action/ActionErrors.html">ActionErrors</A> errors)</PRE>

822

<DL>

823

<DD>Save the specified error messages keys into the appropriate request

824

attribute for use by the <struts:errors> tag, if any messages

825

are required. Otherwise, ensure that the request attribute is not

826

created.<DD><DL>

827

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing<DD><CODE>errors</CODE> - Error messages object</DL>

828

</DD>

829

</DL>

830

<HR>

831

832

833

saveToken</H3>

834

<PRE>

835

protected void <B>saveToken</B>(javax.servlet.http.HttpServletRequest request)</PRE>

836

<DL>

837

<DD>Save a new transaction token in the user's current session, creating

838

a new session if necessary.<DD><DL>

839

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing</DL>

840

</DD>

841

</DL>

842

<HR>

843

844

845

setLocale</H3>

846

<PRE>

847

protected void <B>setLocale</B>(javax.servlet.http.HttpServletRequest request,

848

java.util.Locale locale)</PRE>

849

<DL>

850

<DD>Set the user's currently selected Locale.<DD><DL>

851

<DT><B>Parameters:</B><DD><CODE>request</CODE> - The request we are processing<DD><CODE>locale</CODE> - The user's selected Locale to be set, or null

852

to select the server's default Locale</DL>

853

</DD>

854

</DL>

855

<HR>

856

857

858

toHex</H3>

859

<PRE>

860

protected java.lang.String <B>toHex</B>(byte[] buffer)</PRE>

861

<DL>

862

<DD>Convert a byte array to a String of hexadecimal digits and return it.<DD><DL>

863

<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The byte array to be converted</DL>

864

</DD>

865

</DL>

866

867

<HR>

868

869

870

871

872

<TR>

873

874

875

876

877

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>

878

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>

879

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>

880

881

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>

882

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>

883

884

</TR>

885

</TABLE>

886

</TD>

887

888

</EM>

889

</TD>

890

</TR>

891

892

<TR>

893

894

 PREV CLASS 

895

 <A HREF="../../../../org/apache/struts/action/ActionBase.html"><B>NEXT CLASS</B></A></FONT></TD>

896

897

<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  

898

 <A HREF="Action.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>

899

</TR>

900

<TR>

901

902

SUMMARY:  INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>

903

904

DETAIL:  <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>

905

</TR>

906

</TABLE>

907

908

909

<HR>

910

911

</BODY>

912

</HTML>

Older »