public interface Part
This class represents a part or form item that was received within a
multipart/form-data
POST request.
This is an adaptation of the javax.servlet.Part interface introduced into the Servlet 3.0 specification.
The API has been kept that same but the package has changed not to conflict with the Servlet spec.
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes the underlying storage for a file item, including deleting any
associated temporary disk file.
|
String |
getContentType()
Gets the content type of this part.
|
String |
getHeader(String name)
Returns the value of the specified mime header
as a
String . |
Collection<String> |
getHeaderNames()
Gets the header names of this Part.
|
Collection<String> |
getHeaders(String name)
Gets the values of the Part header with the given name.
|
InputStream |
getInputStream()
Gets the content of this part as an InputStream
|
String |
getName()
Gets the name of this part
|
long |
getSize()
Returns the size of this file.
|
void |
write(String fileName)
A convenience method to write this uploaded item to disk.
|
InputStream getInputStream() throws IOException
IOException
- If an error occurs in retrieving the content
as an InputStreamString getContentType()
String getName()
long getSize()
long
specifying the size of this part, in bytes.void write(String fileName) throws IOException
This method is not guaranteed to succeed if called more than once for the same part. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.
fileName
- the name of the file to which the stream will be
written. The file is created relative to the location as
specified in the MultipartConfigIOException
- if an error occurs.void delete() throws IOException
IOException
- if an error occurs.String getHeader(String name)
String
. If the Part did not include a header
of the specified name, this method returns null
.
If there are multiple headers with the same name, this method
returns the first header in the part.
The header name is case insensitive. You can use
this method with any request header.name
- a String
specifying the
header nameString
containing the
value of the requested
header, or null
if the part does not
have a header of that nameCollection<String> getHeaders(String name)
Any changes to the returned Collection
must not
affect this Part
.
Part header names are case insensitive.
name
- the header name whose values to returnCollection
of the values of
the header with the given nameCollection<String> getHeaderNames()
Some servlet containers do not allow
servlets to access headers using this method, in
which case this method returns null
Any changes to the returned Collection
must not
affect this Part
.
Collection
of the header
names of this PartCopyright © 2003–2016 MuleSoft, Inc.. All rights reserved.