org.xlightweb
Class Part

java.lang.Object
  org.xlightweb.Part

All Implemented Interfaces:

IHeader, IPart

Direct Known Subclasses:

HttpRequest, HttpResponse

public class Part
extends Object
implements IPart

Part

Constructor Summary

Part(File file)
constructor

Part(IHeader header, ByteBuffer[] body)
constructor

Part(IHeader header, File file)
constructor

Part(IHeader header, NonBlockingBodyDataSource body)
constructor

Part(IHeader header, String body)
constructor

Part(String contentType, ByteBuffer[] body)
constructor

Part(String contentType, String body)
constructor

Method Summary

void	addHeader(String headername, String headervalue) Adds a header with the given name and value.
void	addHeaderLine(String line) adds a raw header line
void	addHeaderlines(String... lines) adds raw header lines
boolean	containsHeader(String headername) Returns a boolean indicating whether the named header has already been set.
BlockingBodyDataSource	getBlockingBody()
BodyDataSource	getBody() returns the blocking body
String	getCharacterEncoding() Returns the name of the character encoding used in the body of this message.
String	getContentType() Returns the MIME type of the body of the messag, or null if the type is not known.
String	getDisposition() returns the content disposition header of the part, or null if the type is not known.
String	getDispositionParam(String name) returns the content disposition param value or null if not set see also rfc2183
String	getDispositionType() returns the content disposition type or null if not set see also rfc2183
String	getHeader(String headername) Returns the value of the specified header as a String.
String	getHeader(String headername, String dfltValue) Returns the value of the specified header as a String.
List<String>	getHeaderList(String headername) Returns all the values of the specified header as an List of String objects.
Enumeration	getHeaderNames() Returns an enumeration of all the header names.
Set<String>	getHeaderNameSet() Returns an set of all the header names.
Enumeration	getHeaders(String headername) Returns all the values of the specified header as an Enumeration of String objects.
NonBlockingBodyDataSource	getNonBlockingBody() returns the non-blocking body
IHeader	getPartHeader() returns the part header
String	getTransferEncoding() returns the Transfer-Encoding header parameter or null if the header is not set
boolean	hasBody() returns true if the part has a body
void	removeHeader(String headername) removes a header with the given name
void	setContentType(String type) sets the MIME type of the body of the part
void	setHeader(String headername, String headervalue) Sets a header with the given name and value.
void	setTransferEncoding(String transferEncoding) sets the Transfer-Encoding parameter
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Part

public Part(String contentType,
            String body)
     throws IOException

constructor

Parameters:

contentType - the content type

body - the body

Throws:

IOException - if an exception occurs

Part

public Part(IHeader header,
            String body)
     throws IOException

constructor

Parameters:

header - the header

body - the body

Throws:

IOException - if an exception occurs

Part

public Part(String contentType,
            ByteBuffer[] body)
     throws IOException

constructor

Parameters:

contentType - the content type

body - the body

Throws:

IOException - if an exception occurs

Part

public Part(File file)
     throws IOException

constructor

Parameters:

file - the file

Throws:

IOException - if an exception occurs

Part

public Part(IHeader header,
            File file)
     throws IOException

constructor

Parameters:

header - the header

file - the file

Throws:

IOException - if an exception occurs

Part

public Part(IHeader header,
            ByteBuffer[] body)
     throws IOException

constructor

Parameters:

header - the header

body - the body

Throws:

IOException - if an exception occurs

Part

public Part(IHeader header,
            NonBlockingBodyDataSource body)
     throws IOException

constructor

Parameters:

header - the header

body - the body

Throws:

IOException - if an exception occurs

Method Detail

getPartHeader

public IHeader getPartHeader()

returns the part header

Specified by:

getPartHeader in interface IPart

Returns:

the part header

getNonBlockingBody

public final NonBlockingBodyDataSource getNonBlockingBody()
                                                   throws IOException

returns the non-blocking body

Specified by:

getNonBlockingBody in interface IPart

Returns:

the body or null if parte is bodyless

Throws:

IOException

hasBody

public final boolean hasBody()

returns true if the part has a body

Specified by:

hasBody in interface IPart

Returns:

true, if the part has a body

getBlockingBody

public final BlockingBodyDataSource getBlockingBody()
                                             throws IOException

Specified by:

getBlockingBody in interface IPart

Throws:

IOException

getBody

public BodyDataSource getBody()
                       throws IOException

returns the blocking body

Specified by:

getBody in interface IPart

Returns:

the body or null if part is bodyless

Throws:

IOException

addHeader

public final void addHeader(String headername,
                            String headervalue)

Adds a header with the given name and value. This method allows headers to have multiple values.

Specified by:

addHeader in interface IHeader

Parameters:

headername - the name of the header

headervalue - the additional header value. If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

addHeaderLine

public final void addHeaderLine(String line)

adds a raw header line

Specified by:

addHeaderLine in interface IHeader

Parameters:

line - the headerline

addHeaderlines

public final void addHeaderlines(String... lines)

adds raw header lines

Specified by:

addHeaderlines in interface IHeader

Parameters:

lines - the headerlines

containsHeader

public final boolean containsHeader(String headername)

Returns a boolean indicating whether the named header has already been set.

Specified by:

containsHeader in interface IHeader

Returns:

true if the named header has already been set; false otherwise

getCharacterEncoding

public final String getCharacterEncoding()

Returns the name of the character encoding used in the body of this message. If the header defines no encoding, the default encoding will be returned

Specified by:

getCharacterEncoding in interface IHeader

Returns:

a String containing the name of the character encoding

getContentType

public final String getContentType()

Returns the MIME type of the body of the messag, or null if the type is not known.

Specified by:

getContentType in interface IHeader

Returns:

a String containing the name of the MIME type of the message, or null if the type is not known

getDisposition

public final String getDisposition()

returns the content disposition header of the part, or null if the type is not known.

see also rfc2183

Specified by:

getDisposition in interface IHeader

Returns:

a String containing the name of the content disposition of the part, or null if the type is not known

getDispositionParam

public final String getDispositionParam(String name)

returns the content disposition param value or null if not set

see also rfc2183

Specified by:

getDispositionParam in interface IHeader

Parameters:

name - the parameter name

Returns:

the content disposition param value or null if not set

getDispositionType

public final String getDispositionType()

returns the content disposition type or null if not set

see also rfc2183

Specified by:

getDispositionType in interface IHeader

Returns:

the content disposition type or null if not set

getHeader

public final String getHeader(String headername)

Returns the value of the specified 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 head in the part.

Specified by:

getHeader in interface IHeader

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

getHeader

public String getHeader(String headername,
                        String dfltValue)

Returns the value of the specified 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 head in the part.

Specified by:

getHeader in interface IHeader

Parameters:

headername - a String specifying the header name

dfltValue - the default value if the header is not set

Returns:

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

getHeaderList

public final List<String> getHeaderList(String headername)

Returns all the values of the specified header as an List of String objects.

Some headers, such as Accept-Language can be set by part producer as several headers each with a different value rather than sending the header as a comma separated list.

Specified by:

getHeaderList in interface IHeader

Parameters:

headername - a String specifying the header name

Returns:

an List containing the values of the requested header. If the part does not have any headers of that name return an empty enumeration.

getHeaderNames

public final Enumeration getHeaderNames()

Returns an enumeration of all the header names. If the part has no headers, this method returns an empty enumeration.

Specified by:

getHeaderNames in interface IHeader

Returns:

an enumeration of all the header names

getHeaderNameSet

public final Set<String> getHeaderNameSet()

Returns an set of all the header names. If the part has no headers, this method returns an empty Set.

Specified by:

getHeaderNameSet in interface IHeader

Returns:

an Set of all the header names

getHeaders

public final Enumeration getHeaders(String headername)

Returns all the values of the specified header as an Enumeration of String objects.

Some headers, such as Accept-Language can be set by part producer as several headers each with a different value rather than sending the header as a comma separated list.

Specified by:

getHeaders in interface IHeader

Parameters:

headername - a String specifying the header name

Returns:

an Enumeration containing the values of the requested header. If the part does not have any headers of that name return an empty enumeration.

getTransferEncoding

public final String getTransferEncoding()

returns the Transfer-Encoding header parameter or null if the header is not set

Specified by:

getTransferEncoding in interface IHeader

Returns:

the Transfer-Encoding header parameter or null if the header is not set

removeHeader

public final void removeHeader(String headername)

removes a header with the given name

Specified by:

removeHeader in interface IHeader

Parameters:

headername - the name of the header

setContentType

public final void setContentType(String type)

sets the MIME type of the body of the part

Specified by:

setContentType in interface IHeader

Parameters:

type - the MIME type of the body of the part

setHeader

public final void setHeader(String headername,
                            String headervalue)

Sets a header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Specified by:

setHeader in interface IHeader

Parameters:

headername - the name of the header

headervalue - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

setTransferEncoding

public final void setTransferEncoding(String transferEncoding)

sets the Transfer-Encoding parameter

Specified by:

setTransferEncoding in interface IHeader

Parameters:

transferEncoding - the Transfer-Encoding parameter

toString

public String toString()

Overrides:

toString in class Object