org.mule.runtime.http.api.domain.entity.multipart

Class HttpPart

java.lang.Object

org.mule.runtime.http.api.domain.entity.multipart.HttpPart

All Implemented Interfaces:

Part

public class HttpPart
extends Object
implements Part

Default implementation of a Part.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SIZE

Constructor Summary

Constructors

Constructor and Description
HttpPart(String partName, byte[] content, String contentType, int size)
HttpPart(String partName, String fileName, byte[] content, String contentType, int size)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String headerName, String headerValue)
String	getContentType() Gets the content type of this part.
String	getFileName()
String	getHeader(String headerName) 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 headerName) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_SIZE

public static final int NO_SIZE

See Also:

Constant Field Values

Constructor Detail

HttpPart

public HttpPart(String partName,
                byte[] content,
                String contentType,
                int size)

HttpPart

public HttpPart(String partName,
                String fileName,
                byte[] content,
                String contentType,
                int size)

Method Detail

getContentType

public String getContentType()

Description copied from interface: Part

Gets the content type of this part.

Specified by:

getContentType in interface Part

Returns:

The content type of this part.

getHeader

public String getHeader(String headerName)

Description copied from interface: Part

Returns the value of the specified mime header as a 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.

Specified by:

getHeader in interface Part

Parameters:

headerName - a String specifying the header name

Returns:

a String containing the value of the requested header, or null if the part does not have a header of that name

getHeaderNames

public Collection<String> getHeaderNames()

Description copied from interface: Part

Gets the header names of this Part.

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.

Specified by:

getHeaderNames in interface Part

Returns:

a (possibly empty) Collection of the header names of this Part

getHeaders

public Collection<String> getHeaders(String headerName)

Description copied from interface: Part

Gets the values of the Part header with the given name.

Any changes to the returned Collection must not affect this Part.

Part header names are case insensitive.

Specified by:

getHeaders in interface Part

Parameters:

headerName - the header name whose values to return

Returns:

a (possibly empty) Collection of the values of the header with the given name

addHeader

public void addHeader(String headerName,
                      String headerValue)

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Part

Gets the content of this part as an InputStream

Specified by:

getInputStream in interface Part

Returns:

The content of this part as an InputStream

Throws:

IOException - If an error occurs in retrieving the content as an InputStream

getName

public String getName()

Description copied from interface: Part

Gets the name of this part

Specified by:

getName in interface Part

Returns:

The name of this part as a String

getSize

public long getSize()

Description copied from interface: Part

Returns the size of this file.

Specified by:

getSize in interface Part

Returns:

a long specifying the size of this part, in bytes.

getFileName

public String getFileName()