net.lecousin.framework.network.mime.entity

Class FormUrlEncodedEntity

java.lang.Object

net.lecousin.framework.network.mime.MimeMessage

net.lecousin.framework.network.mime.entity.MimeEntity

net.lecousin.framework.network.mime.entity.FormUrlEncodedEntity

public class FormUrlEncodedEntity
extends MimeEntity

Form parameters using x-www-form-urlencoded format.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<net.lecousin.framework.util.Pair<String,String>>	parameters

Fields inherited from class net.lecousin.framework.network.mime.MimeMessage

CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, TRANSFER_ENCODING

Constructor Summary

Constructors

Modifier	Constructor and Description
	FormUrlEncodedEntity() Constructor.
protected	FormUrlEncodedEntity(MimeMessage from)

Method Summary

Modifier and Type	Method and Description
void	add(String name, String value) Add a parameter.
static net.lecousin.framework.concurrent.synch.AsyncWork<FormUrlEncodedEntity,Exception>	from(MimeMessage mime, boolean fromReceived) Parse the body of the given MimeMessage into a FormUrlEncodedEntity.
net.lecousin.framework.io.IO.Readable	getBodyToSend() Return the body to send, previoulsy set by setBodyToSend.
String	getParameter(String name) Return the parameter or null if not present.
List<net.lecousin.framework.util.Pair<String,String>>	getParameters() Return the parameters.
boolean	hasParameter(String name) Return true if the parameter is present.
net.lecousin.framework.concurrent.synch.SynchronizationPoint<IOException>	parse(net.lecousin.framework.io.IO.Readable source, Charset charset) Parse the given source.

Methods inherited from class net.lecousin.framework.network.mime.MimeMessage

addHeader, addHeader, addHeaderRaw, appendHeadersTo, appendHeadersTo, getBodyReceivedAsInput, getBodyReceivedAsOutput, getContentLength, getContentType, getContentTypeValue, getFirstHeader, getFirstHeaderLongValue, getFirstHeaderRawValue, getFirstHeaderValue, getHeaders, getHeaders, getHeadersValues, getLogger, getReadableStream, hasHeader, readHeader, removeHeaders, send, setBodyReceived, setBodyToSend, setContentLength, setHeader, setHeader, setHeaderRaw

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected List<net.lecousin.framework.util.Pair<String,String>> parameters

Constructor Detail

FormUrlEncodedEntity

public FormUrlEncodedEntity()

Constructor.

FormUrlEncodedEntity

protected FormUrlEncodedEntity(MimeMessage from)

Method Detail

from

public static net.lecousin.framework.concurrent.synch.AsyncWork<FormUrlEncodedEntity,Exception> from(MimeMessage mime,
                                                                                                     boolean fromReceived)

Parse the body of the given MimeMessage into a FormUrlEncodedEntity.

Parameters:

fromReceived - if true, the received body is parsed, else the body to send is parsed from the mime message.

add

public void add(String name,
                String value)

Add a parameter.

getParameters

public List<net.lecousin.framework.util.Pair<String,String>> getParameters()

Return the parameters.

hasParameter

public boolean hasParameter(String name)

Return true if the parameter is present.

getParameter

public String getParameter(String name)

Return the parameter or null if not present.

parse

public net.lecousin.framework.concurrent.synch.SynchronizationPoint<IOException> parse(net.lecousin.framework.io.IO.Readable source,
                                                                                       Charset charset)

Parse the given source.

getBodyToSend

public net.lecousin.framework.io.IO.Readable getBodyToSend()

Description copied from class: MimeMessage

Return the body to send, previoulsy set by setBodyToSend.

Overrides:

getBodyToSend in class MimeMessage