Java Doc for MultipartPostMethod.java in  » Net » Apache-common-HttpClient » org » apache » commons » httpclient » methods » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » Apache common HttpClient » org.apache.commons.httpclient.methods 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.commons.httpclient.methods.ExpectContinueMethod
   org.apache.commons.httpclient.methods.MultipartPostMethod

MultipartPostMethod
public class MultipartPostMethod extends ExpectContinueMethod (Code)
Implements the HTTP multipart POST method.

The HTTP multipart POST method is defined in section 3.3 of RFC1867:

The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 1521. The multipart/form-data contains a series of parts. Each part is expected to contain a content-disposition header where the value is "form-data" and a name attribute specifies the field name within the form, e.g., 'content-disposition: form-data; name="xxxxx"', where xxxxx is the field name corresponding to that field. Field names originally in non-ASCII character sets may be encoded using the method outlined in RFC 1522.


author:
   Matthew Albright
author:
   Jeff Dever
author:
   Adrian Sutton
author:
   Mark Diggory
author:
   Mike Bowler
author:
   Oleg Kalnichevski
since:
   2.0org.apache.commons.httpclient.methods.multipart.MultipartRequestEntityorg.apache.commons.httpclient.methods.PostMethod



Field Summary
final public static  StringMULTIPART_FORM_CONTENT_TYPE
     The Content-Type for multipart/form-data.

Constructor Summary
public  MultipartPostMethod()
     No-arg constructor.
public  MultipartPostMethod(String uri)
     Constructor specifying a URI.

Method Summary
protected  voidaddContentLengthRequestHeader(HttpState state, HttpConnection conn)
     Adds a Content-Length request header, as long as no Content-Length request header already exists.
Parameters:
  state - current state of http requests
Parameters:
  conn - the connection to use for I/O
throws:
  IOException - if an I/O (transport) error occurs.
protected  voidaddContentTypeRequestHeader(HttpState state, HttpConnection conn)
     Adds a Content-Type request header.
Parameters:
  state - current state of http requests
Parameters:
  conn - the connection to use for I/O
throws:
  IOException - if an I/O (transport) error occurs.
public  voidaddParameter(String parameterName, String parameterValue)
    
public  voidaddParameter(String parameterName, File parameterFile)
    
public  voidaddParameter(String parameterName, String fileName, File parameterFile)
    
public  voidaddPart(Part part)
     Adds a part.
protected  voidaddRequestHeaders(HttpState state, HttpConnection conn)
     Populates the request headers map to with additional org.apache.commons.httpclient.Header headers to be submitted to the given HttpConnection .

This implementation adds tt>Content-Length and Content-Type headers, when appropriate.

Subclasses may want to override this method to to add additional headers, and may choose to invoke this implementation (via super) to add the "standard" headers.


Parameters:
  state - the HttpState state information associated with this method
Parameters:
  conn - the HttpConnection connection used to executethis HTTP method
throws:
  IOException - if an I/O (transport) error occurs.
public  StringgetName()
     Returns "POST".
public  Part[]getParts()
     Returns all parts.
protected  longgetRequestContentLength()
    
protected  booleanhasRequestContent()
    
public  voidrecycle()
     Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called.
protected  booleanwriteRequestBody(HttpState state, HttpConnection conn)
     Writes the request body to the given HttpConnection connection .
Parameters:
  state - the HttpState state information associated with this method
Parameters:
  conn - the HttpConnection connection used to executethis HTTP method true
throws:
  IOException - if an I/O (transport) error occurs.

Field Detail
MULTIPART_FORM_CONTENT_TYPE
final public static String MULTIPART_FORM_CONTENT_TYPE(Code)
The Content-Type for multipart/form-data.




Constructor Detail
MultipartPostMethod
public MultipartPostMethod()(Code)
No-arg constructor.



MultipartPostMethod
public MultipartPostMethod(String uri)(Code)
Constructor specifying a URI.
Parameters:
  uri - either an absolute or relative URI




Method Detail
addContentLengthRequestHeader
protected void addContentLengthRequestHeader(HttpState state, HttpConnection conn) throws IOException, HttpException(Code)
Adds a Content-Length request header, as long as no Content-Length request header already exists.
Parameters:
  state - current state of http requests
Parameters:
  conn - the connection to use for I/O
throws:
  IOException - if an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
since:
   3.0



addContentTypeRequestHeader
protected void addContentTypeRequestHeader(HttpState state, HttpConnection conn) throws IOException, HttpException(Code)
Adds a Content-Type request header.
Parameters:
  state - current state of http requests
Parameters:
  conn - the connection to use for I/O
throws:
  IOException - if an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
since:
   3.0



addParameter
public void addParameter(String parameterName, String parameterValue)(Code)
Adds a text field part
Parameters:
  parameterName - The name of the parameter.
Parameters:
  parameterValue - The value of the parameter.



addParameter
public void addParameter(String parameterName, File parameterFile) throws FileNotFoundException(Code)
Adds a binary file part
Parameters:
  parameterName - The name of the parameter
Parameters:
  parameterFile - The name of the file.
throws:
  FileNotFoundException - If the file cannot be found.



addParameter
public void addParameter(String parameterName, String fileName, File parameterFile) throws FileNotFoundException(Code)
Adds a binary file part with the given file name
Parameters:
  parameterName - The name of the parameter
Parameters:
  fileName - The file name
Parameters:
  parameterFile - The file
throws:
  FileNotFoundException - If the file cannot be found.



addPart
public void addPart(Part part)(Code)
Adds a part.
Parameters:
  part - The part to add.



addRequestHeaders
protected void addRequestHeaders(HttpState state, HttpConnection conn) throws IOException, HttpException(Code)
Populates the request headers map to with additional org.apache.commons.httpclient.Header headers to be submitted to the given HttpConnection .

This implementation adds tt>Content-Length and Content-Type headers, when appropriate.

Subclasses may want to override this method to to add additional headers, and may choose to invoke this implementation (via super) to add the "standard" headers.


Parameters:
  state - the HttpState state information associated with this method
Parameters:
  conn - the HttpConnection connection used to executethis HTTP method
throws:
  IOException - if an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
See Also:   MultipartPostMethod.writeRequestHeaders



getName
public String getName()(Code)
Returns "POST". "POST"



getParts
public Part[] getParts()(Code)
Returns all parts. an array of containing all parts



getRequestContentLength
protected long getRequestContentLength() throws IOException(Code)

Return the length of the request body.

Once this method has been invoked, the request parameters cannot be altered until the method is MultipartPostMethod.recycle recycled .

The request content length.



hasRequestContent
protected boolean hasRequestContent()(Code)
Returns true true
since:
   2.0beta1



recycle
public void recycle()(Code)
Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called. This method will also release the connection being used by this HTTP method.
See Also:   MultipartPostMethod.releaseConnection()



writeRequestBody
protected boolean writeRequestBody(HttpState state, HttpConnection conn) throws IOException, HttpException(Code)
Writes the request body to the given HttpConnection connection .
Parameters:
  state - the HttpState state information associated with this method
Parameters:
  conn - the HttpConnection connection used to executethis HTTP method true
throws:
  IOException - if an I/O (transport) error occurs. Some transport exceptionscan be recovered from.
throws:
  HttpException - if a protocol exception occurs. Usually protocol exceptions cannot be recovered from.



Methods inherited from org.apache.commons.httpclient.methods.ExpectContinueMethod
protected void addRequestHeaders(HttpState state, HttpConnection conn) throws IOException, HttpException(Code)(Java Doc)
public boolean getUseExpectHeader()(Code)(Java Doc)
abstract protected boolean hasRequestContent()(Code)(Java Doc)
public void setUseExpectHeader(boolean value)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.