Java Doc for MultipartRequest.java in  » Portal » Open-Portal » com » sun » portal » proxylet » servlet » 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 » Portal » Open Portal » com.sun.portal.proxylet.servlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.portal.proxylet.servlet.MultipartRequest

MultipartRequest
public class MultipartRequest (Code)
Extracts parameter values from "multipart; form-data" contained in incoming HTTP servlet requests. For further details concerning multipart requests see RFC 1867.

Inner Class :class DataBlock

Field Summary
final public static  StringfDoubleDash
    
final public static  StringfEOLN
    
final public static  StringfEmptyLine
     Sequence containing two end of line sequences in multipart data sections thus creating an empty line.

Constructor Summary
public  MultipartRequest(HttpServletRequest request)
     A convenience constructor allowing size of multipart content of incoming request to be of maximum size.
public  MultipartRequest(HttpServletRequest request, int maxSize)
     Creates new IncomingMultiPartHttpServlet out of .
Parameters:
  request - HttpServletRequest containing multipart message
Parameters:
  maxSize - max.

Method Summary
public  StringgetBoundary()
     Extracts boundary from ContentType.
public  byte[]getByteContent()
     Getter method to access #mDataBytes.
public  intgetContentLength()
     Extracts ContentLength from #mRequest.
public  StringgetContentType()
     Extracts ContentType from #mRequest.
public  ServletInputStreamgetDataInputStream()
     Extracts DataInputStream from #mRequest.
public  StringgetFileContentType(String name)
     Extracts content-type from parameter block with the name specified if available.
public  StringgetFileName(String name)
     Extracts file name from parameter block with the name specified if available.
public  byte[]getFileValue(String name)
     Extracts the binary content of parameter if available.
public  StringgetHeaderParameter(String name)
     To be consistent the name of this method should actually be getParameter.
public  StringgetMultipartHeader(String name)
     Returns a string containing value of the specified parameter, or null if parameter does not exist.
Parameters:
  name - String containing the name of the requested parameter value.
public  StringgetMultipartValue(String name)
     Returns a string containing value of the specified parameter, or null if parameter does not exist.
Parameters:
  name - String containing the name of the requested parameter value.
public  StringgetParameter(String name)
     To be consistent the name of this method should actually be getParameter.
public  StringgetQueryString()
     Gets any query string that is part of the HTTP request URI (behind the '?').
public  StringgetRemoteAddr()
     Get IP address of calling client host from embedded HttpServletRequest.
public  StringgetRequestURL()
    
public  StringgetScheme()
    
public  StringgetServerName()
    
public  intgetServerPort()
    
public  StringgetShortFileName(String name)
     Retrieves the file name contained in the DataBlock with the specified name stripped of any references to its path.
Parameters:
  name - String containing name of data block of which file name isrequested.
public  booleanisSecure()
     Determines whether request was made using a safe channel or not.
final public static  StringnewString(byte[] bytes)
    

Field Detail
fDoubleDash
final public static String fDoubleDash(Code)
Terminating sequence at end of multipart section



fEOLN
final public static String fEOLN(Code)
End of line sequence in multipart data sections



fEmptyLine
final public static String fEmptyLine(Code)
Sequence containing two end of line sequences in multipart data sections thus creating an empty line.




Constructor Detail
MultipartRequest
public MultipartRequest(HttpServletRequest request) throws ServletException(Code)
A convenience constructor allowing size of multipart content of incoming request to be of maximum size.
Parameters:
  request - HttpServletRequest containing multipart message
exception:
  ServletException - is thrown if thrown by this(request, -1);



MultipartRequest
public MultipartRequest(HttpServletRequest request, int maxSize) throws ServletException(Code)
Creates new IncomingMultiPartHttpServlet out of .
Parameters:
  request - HttpServletRequest containing multipart message
Parameters:
  maxSize - max. allowable size of multipart message. If smaller than 0 it is assumed tobe Integer.MAX_VALUE
exception:
  ServletException - is thrown if either of the following occurs:
  • incoming request does not have a multipart message
  • multipart message is too large too process
  • IOException occurs while reading multipart message

See Also:   MultipartRequest.MultipartRequest(HttpServletRequest,int)




Method Detail
getBoundary
public String getBoundary()(Code)
Extracts boundary from ContentType. ContentType associtated with #mRequest.



getByteContent
public byte[] getByteContent()(Code)
Getter method to access #mDataBytes. mDataBytes Array of bytes containing byte content of original request.



getContentLength
public int getContentLength()(Code)
Extracts ContentLength from #mRequest. ContentLength associtated with #mRequest.



getContentType
public String getContentType()(Code)
Extracts ContentType from #mRequest. ContentType associtated with #mRequest.



getDataInputStream
public ServletInputStream getDataInputStream() throws IOException(Code)
Extracts DataInputStream from #mRequest. DataInputStream associtated with #mRequest



getFileContentType
public String getFileContentType(String name)(Code)
Extracts content-type from parameter block with the name specified if available.
Parameters:
  name - String containing name of parameter of which content-type is requested String Containing requested content-type if name belongs to a file data blockotherwise null



getFileName
public String getFileName(String name)(Code)
Extracts file name from parameter block with the name specified if available.
Parameters:
  name - String containing name of parameter of which file name is requested String Containing requested file name if name belongs to a file data blockotherwise null



getFileValue
public byte[] getFileValue(String name)(Code)
Extracts the binary content of parameter if available.
Parameters:
  name - String containing name of parameter of which binary content is requested String Containing substring of mDataString with requested binary content



getHeaderParameter
public String getHeaderParameter(String name)(Code)
To be consistent the name of this method should actually be getParameter. However, getParameter will be used to access the parameters included in the multipart body. The same applies to the other methods for accessing parameter names and values. Methods for accessing the HttpServletRequest parameters include the word "Header".
Parameters:
  name - String containing name of requested parameter value String containing header parameter value



getMultipartHeader
public String getMultipartHeader(String name)(Code)
Returns a string containing value of the specified parameter, or null if parameter does not exist.
Parameters:
  name - String containing the name of the requested parameter value. String or null



getMultipartValue
public String getMultipartValue(String name)(Code)
Returns a string containing value of the specified parameter, or null if parameter does not exist.
Parameters:
  name - String containing the name of the requested parameter value. String or null



getParameter
public String getParameter(String name)(Code)
To be consistent the name of this method should actually be getParameter. However, as the depatcher uses the getParameter method to access the object path. The object path parameter, however, is included in the multipart body of mRequest and is not really a HttpServletRequest. Thus getParameter will be used to access the parameters included in the multipart body. The same applies to the other methods for accessing parameter names and values. Methods for accessing the HttpServletRequest parameters include the word "Header".
Parameters:
  name - String containing name of requested parameter value String containing header parameter value
See Also:   MultipartRequest.getHeaderParameter



getQueryString
public String getQueryString()(Code)
Gets any query string that is part of the HTTP request URI (behind the '?'). Same as the CGI variable QUERY_STRING. query string that is part of this request's URI, or null if it contains no query string



getRemoteAddr
public String getRemoteAddr()(Code)
Get IP address of calling client host from embedded HttpServletRequest. String with IP address of calling client host.



getRequestURL
public String getRequestURL()(Code)
Retrieves URL used to contact server String with URL used to send request



getScheme
public String getScheme()(Code)
Retrieves scheme used to make request, such as ftp, http, https String with scheme used to make request.



getServerName
public String getServerName()(Code)
Retrieves name of server from incoming HttpServletRequest String with name of server



getServerPort
public int getServerPort()(Code)
Retrieves port id of server from incoming HttpServletRequest int with port id of server



getShortFileName
public String getShortFileName(String name)(Code)
Retrieves the file name contained in the DataBlock with the specified name stripped of any references to its path.
Parameters:
  name - String containing name of data block of which file name isrequested. String containing file name extracted from DataBlock with given name



isSecure
public boolean isSecure()(Code)
Determines whether request was made using a safe channel or not. true if channel was safe (eg https) otherwise false



newString
final public static String newString(byte[] bytes)(Code)
Creates a new String out of an array of bytes or out of null
Parameters:
  bytes - an array of bytes or null an empty string if bytes is null otherwise a new Stringout of bytes



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.