com.vordel.mime

Class FormURLEncodedBody

java.lang.Object

com.vordel.mime.Body

com.vordel.mime.FormURLEncodedBody

All Implemented Interfaces:

com.vordel.dispose.Disposable

public class FormURLEncodedBody
extends Body

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormURLEncodedBody.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_FORM_URL_ENCODED
static com.vordel.mime.ContentType	CT_APPLICATION_FORM_URL_ENCODED

Fields inherited from class com.vordel.mime.Body

CAN_INVALIDATE, contentType, CT_APP_OCTET_STREAM, CT_DEFAULT, CT_MULTIPART_FORM_DATA, CT_MULTIPART_RELATED, CT_TEXT_PLAIN, CT_TEXT_XML_UTF8, CT_XOP_APPLICATION_XML, PUSH_WRITE, REMOVE_XFER_ENCODING_ON_WRITE_DEPRECATED, RETAIN_XFER_ENCODING_ON_READ, WRITE_NO_CTE

Constructor Summary

Constructors

Constructor and Description
FormURLEncodedBody(com.vordel.mime.HeaderSet headers, com.vordel.mime.ContentType contentType, com.vordel.mime.QueryStringHeaderSet params)
FormURLEncodedBody(com.vordel.mime.HeaderSet headers, com.vordel.mime.ContentType contentType, com.vordel.mime.QueryStringHeaderSet params, boolean encode)

Method Summary

Modifier and Type	Method and Description
boolean	contentAvailable()
static FormURLEncodedBody	createBody()
void	formEncode(java.io.OutputStream into, java.lang.String encoding)
com.vordel.mime.QueryStringHeaderSet	getParameters()
static java.util.Map<java.lang.String,com.vordel.mime.QueryStringHeaderSet.QueryStringHeader>	getParams(Message m)
static FormURLEncodedBody	locate(Message m) Locate the FormURLEncodedBody from the message content if it exists.
static void	main(java.lang.String[] args)
protected void	parse(java.io.InputStream is) Parse a body from a specific InputStream.
static com.vordel.mime.Headers	parseParams(java.lang.String parameters, java.lang.String encoding)
protected void	purgeContent() Bodies are purged() when they are no longer in use.
static java.lang.String[]	splitParam(java.lang.String pair)
void	writeContent(java.io.OutputStream os, int flags) Write the content of the body to the specified OutputStream This is similar to Body.write(java.io.OutputStream, int), but does not include the headers for the body.

Methods inherited from class com.vordel.mime.Body

bufferInput, create, dispose, fini, getContentEncoding, getContentId, getContentLength, getContentType, getHeaders, getInputStream, getParent, getSource, initSource, parse, registerFactory, setParent, sevenbit, willwrite, write

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_FORM_URL_ENCODED

public static final java.lang.String APPLICATION_FORM_URL_ENCODED

See Also:

Constant Field Values

CT_APPLICATION_FORM_URL_ENCODED

public static final com.vordel.mime.ContentType CT_APPLICATION_FORM_URL_ENCODED

Constructor Detail

FormURLEncodedBody

public FormURLEncodedBody(com.vordel.mime.HeaderSet headers,
                          com.vordel.mime.ContentType contentType,
                          com.vordel.mime.QueryStringHeaderSet params)

FormURLEncodedBody

public FormURLEncodedBody(com.vordel.mime.HeaderSet headers,
                          com.vordel.mime.ContentType contentType,
                          com.vordel.mime.QueryStringHeaderSet params,
                          boolean encode)

Method Detail

getParameters

public com.vordel.mime.QueryStringHeaderSet getParameters()
                                                   throws java.io.IOException

Throws:

java.io.IOException

parseParams

public static com.vordel.mime.Headers parseParams(java.lang.String parameters,
                                                  java.lang.String encoding)
                                           throws java.io.IOException

Throws:

java.io.IOException

splitParam

public static java.lang.String[] splitParam(java.lang.String pair)
                                     throws java.io.IOException

Throws:

java.io.IOException

contentAvailable

public boolean contentAvailable()

Specified by:

contentAvailable in class Body

createBody

public static FormURLEncodedBody createBody()

getParams

public static java.util.Map<java.lang.String,com.vordel.mime.QueryStringHeaderSet.QueryStringHeader> getParams(Message m)
                                                                                                        throws java.io.IOException

Throws:

java.io.IOException

locate

public static FormURLEncodedBody locate(Message m)
                                 throws java.io.IOException

Locate the FormURLEncodedBody from the message content if it exists.

Parameters:

m - The Message in which to locate the FormURLEncodedBody

Returns:

The FormURLEncodedBody, or null if it doesn't exist

Throws:

java.io.IOException - If there is no HTTP content in the message, or no form body.

writeContent

public void writeContent(java.io.OutputStream os,
                         int flags)
                  throws java.io.IOException

Description copied from class: Body

Write the content of the body to the specified OutputStream This is similar to Body.write(java.io.OutputStream, int), but does not include the headers for the body.

Specified by:

writeContent in class Body

Parameters:

os - OutputStream The OutputStream destination for the Body.

flags - Customize what gets written.

Throws:

java.io.IOException - If there are problems writing to the OutputStream.

formEncode

public void formEncode(java.io.OutputStream into,
                       java.lang.String encoding)
                throws java.io.IOException

Throws:

java.io.IOException

parse

protected void parse(java.io.InputStream is)
              throws java.io.IOException

Description copied from class: Body

Parse a body from a specific InputStream.

This should be considered "private" to callers: it must be invoked via Body.parse()

Specified by:

parse in class Body

Parameters:

is - The InputStream from which to parse the body.

Throws:

java.io.IOException - if there are problems reading from the InputStream.

See Also:

Body.parse()

purgeContent

protected void purgeContent()

Description copied from class: Body

Bodies are purged() when they are no longer in use. This provides similar functionality to the "finalize()" method, but may be called by any caller, or in any thread, when it is known that a body is no longer in use.

Specified by:

purgeContent in class Body

main

public static void main(java.lang.String[] args)