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

<DT>All Known Implementing Classes: <DD><A HREF="../../../../org/apache/struts/upload/CommonsMultipartRequestHandler.html">CommonsMultipartRequestHandler</A>, <A HREF="../../../../org/apache/struts/upload/DiskMultipartRequestHandler.html">DiskMultipartRequestHandler</A></DD>

</DL>

<HR>

<DL>

<DT>public interface MultipartRequestHandler</DL>

MultipartRequestHandler provides an standard interface for struts to

deal with file uploads from forms with enctypes of "multipart/form-data".

Providers must provide a no-argument constructor for initialization.

<DL>

<DT>Author:</DT>

<DD>Mike Schachter</DD>

</DL>

<HR>

100

101

102

103

104

105

106

107

108

109

110

Field Summary</TD>

111

</TR>

112

113

114

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

115

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#ATTRIBUTE_MAX_LENGTH_EXCEEDED">ATTRIBUTE_MAX_LENGTH_EXCEEDED</A></CODE>

116

117

118

          This is the ServletRequest attribute that should be set when a multipart request is being read

119

and the maximum length is exceeded.</TD>

120

</TR>

121

</TABLE>

122

123

124

125

126

127

128

129

130

131

132

Method Summary</TD>

133

</TR>

134

135

136

137

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#finish()">finish</A>()</CODE>

138

139

140

          This method is called on when a successful form post

141

has been made.</TD>

142

</TR>

143

144

145

<CODE> java.util.Hashtable</CODE></TD>

146

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getAllElements()">getAllElements</A>()</CODE>

147

148

149

This method returns all elements of a multipart request.</TD>

150

</TR>

151

152

153

<CODE> java.util.Hashtable</CODE></TD>

154

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getFileElements()">getFileElements</A>()</CODE>

155

156

157

          This method is called on to retrieve all the FormFile

158

input elements of the request.</TD>

159

</TR>

160

161

162

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

163

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getMapping()">getMapping</A>()</CODE>

164

165

166

Get the ActionMapping instance for this request</TD>

167

</TR>

168

169

170

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

171

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getServlet()">getServlet</A>()</CODE>

172

173

174

Get the ActionServlet instance</TD>

175

</TR>

176

177

178

<CODE> java.util.Hashtable</CODE></TD>

179

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#getTextElements()">getTextElements</A>()</CODE>

180

181

182

          This method is called on to retrieve all the text

183

input elements of the request.</TD>

184

</TR>

185

186

187

188

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#handleRequest(javax.servlet.http.HttpServletRequest)">handleRequest</A>(javax.servlet.http.HttpServletRequest request)</CODE>

189

190

191

          After constructed, this is the first method called on

192

by ActionServlet.</TD>

193

</TR>

194

195

196

197

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#rollback()">rollback</A>()</CODE>

198

199

200

          This method is called on when there's some sort of problem

201

and the form post needs to be rolled back.</TD>

202

</TR>

203

204

205

206

<TD><CODE><A HREF="../../../../org/apache/struts/upload/MultipartRequestHandler.html#setMapping(org.apache.struts.action.ActionMapping)">setMapping</A>(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</CODE>

207

208

209

          Convienience method to set a reference to a working

210

ActionMapping instance.</TD>

211

</TR>

212

213

214

215

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

216

217

218

          Convienience method to set a reference to a working

219

ActionServlet instance.</TD>

220

</TR>

221

</TABLE>

222

223

224

225

226

227

228

229

230

231

Field Detail</TD>

232

</TR>

233

</TABLE>

234

235

236

ATTRIBUTE_MAX_LENGTH_EXCEEDED</H3>

237

<PRE>

238

public static final java.lang.String ATTRIBUTE_MAX_LENGTH_EXCEEDED</PRE>

239

<DL>

240

<DD>This is the ServletRequest attribute that should be set when a multipart request is being read

241

and the maximum length is exceeded. The value is a Boolean. If the maximum length isn't exceeded,

242

this attribute shouldn't be put in the ServletRequest. It's the job of the implementation to put this

243

attribute in the request if the maximum length is exceeded; in the handleRequest(HttpServletRequest) method.

244

245

<DL>

246

<DT>See Also:<DD><A HREF="../../../../constant-values.html#org.apache.struts.upload.MultipartRequestHandler.ATTRIBUTE_MAX_LENGTH_EXCEEDED">Constant Field Values</A></DL>

247

</DL>

248

249

250

251

252

253

254

255

256

257

258

Method Detail</TD>

259

</TR>

260

</TABLE>

261

262

263

setServlet</H3>

264

<PRE>

265

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

266

<DL>

267

<DD>Convienience method to set a reference to a working

268

ActionServlet instance.

269

270

271

</DL>

272

</DD>

273

</DL>

274

<HR>

275

276

277

setMapping</H3>

278

<PRE>

279

public void setMapping(<A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> mapping)</PRE>

280

<DL>

281

<DD>Convienience method to set a reference to a working

282

ActionMapping instance.

283

284

285

</DL>

286

</DD>

287

</DL>

288

<HR>

289

290

291

getServlet</H3>

292

<PRE>

293

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

294

<DL>

295

<DD>Get the ActionServlet instance

296

297

298

</DL>

299

</DD>

300

</DL>

301

<HR>

302

303

304

getMapping</H3>

305

<PRE>

306

public <A HREF="../../../../org/apache/struts/action/ActionMapping.html">ActionMapping</A> getMapping()</PRE>

307

<DL>

308

<DD>Get the ActionMapping instance for this request

309

310

311

</DL>

312

</DD>

313

</DL>

314

<HR>

315

316

317

handleRequest</H3>

318

<PRE>

319

public void handleRequest(javax.servlet.http.HttpServletRequest request)

320

throws javax.servlet.ServletException</PRE>

321

<DL>

322

<DD>After constructed, this is the first method called on

323

by ActionServlet. Use this method for all your

324

data-parsing of the ServletInputStream in the request

325

326

327

328

<DT>Throws:

329

<DD><CODE>javax.servlet.ServletException</CODE> - thrown if something goes wrong</DL>

330

</DD>

331

</DL>

332

<HR>

333

334

335

getTextElements</H3>

336

<PRE>

337

public java.util.Hashtable getTextElements()</PRE>

338

<DL>

339

<DD>This method is called on to retrieve all the text

340

input elements of the request.

341

342

343

344

<DT>Returns:<DD>A Hashtable where the keys and values are the names and

345

values of the request input parameters</DL>

346

</DD>

347

</DL>

348

<HR>

349

350

351

getFileElements</H3>

352

<PRE>

353

public java.util.Hashtable getFileElements()</PRE>

354

<DL>

355

<DD>This method is called on to retrieve all the FormFile

356

input elements of the request.

357

358

359

360

<DT>Returns:<DD>A Hashtable where the keys are the input names of the

361

files and the values are FormFile objects<DT>See Also:<DD><A HREF="../../../../org/apache/struts/upload/FormFile.html"><CODE>FormFile</CODE></A></DL>

362

</DD>

363

</DL>

364

<HR>

365

366

367

getAllElements</H3>

368

<PRE>

369

public java.util.Hashtable getAllElements()</PRE>

370

<DL>

371

<DD>This method returns all elements of a multipart request.

372

373

374

375

<DT>Returns:<DD>A Hashtable where the keys are input names and values

376

are either Strings or FormFiles</DL>

377

</DD>

378

</DL>

379

<HR>

380

381

382

rollback</H3>

383

<PRE>

384

public void rollback()</PRE>

385

<DL>

386

<DD>This method is called on when there's some sort of problem

387

and the form post needs to be rolled back. Providers

388

should remove any FormFiles used to hold information

389

by setting them to null and also physically delete

390

them if the implementation calls for writing directly

391

to disk.

392

NOTE: Currently implemented but not automatically

393

supported, ActionForm implementors must call rollback()

394

manually for rolling back file uploads.

395

396

397

</DL>

398

</DD>

399

</DL>

400

<HR>

401

402

403

finish</H3>

404

<PRE>

405

public void finish()</PRE>

406

<DL>

407

<DD>This method is called on when a successful form post

408

has been made. Some implementations will use this

409

to destroy temporary files or write to a database

410

or something of that nature.

411

412

413

</DL>

414

</DD>

415

</DL>

416

417

<HR>

418

419

420

421

422

<TR>

423

424

425

426

427

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

428

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

429

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

430

431

432

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

433

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

434

435

</TR>

436

</TABLE>

437

</TD>

438

439

440

</TD>

441

</TR>

442

443

<TR>

444

445

<A HREF="../../../../org/apache/struts/upload/FormFile.html">PREV CLASS</A>

446

NEXT CLASS</TD>

447

448

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

449

<A HREF="MultipartRequestHandler.html" TARGET="_top">NO FRAMES</A>

450

451

452

<!--

453

if(window==top) {

454

document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET="">All Classes</A>');

455

}

456

//-->

457

</SCRIPT>

458

459

<A HREF="../../../../allclasses-noframe.html" TARGET="">All Classes</A>

460

</NOSCRIPT>

461

</TD>

462

</TR>

463

<TR>

464

465

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

466

467

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

468

</TR>

469

</TABLE>

470

471

472

<HR>

473

474

</BODY>

475

</HTML>

Older »