com.predic8.membrane.core.http

Class Message

java.lang.Object

com.predic8.membrane.core.http.Message

Direct Known Subclasses:

Request, Response

public abstract class Message
extends Object

A HTTP message (request or response).

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractBody	body
protected Header	header
protected String	version

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
void	addObserver(MessageObserver observer)
boolean	containsObserver(MessageObserver obs)
protected void	createBody(InputStream in)
<T extends Message> T	createMessageSnapshot(T result)
abstract <T extends Message> T	createSnapshot()
void	discardBody()
int	estimateHeapSize()
AbstractBody	getBody()
InputStream	getBodyAsStream() Probably you want to use getBodyAsStreamDecoded() instead:
InputStream	getBodyAsStreamDecoded() Returns the logical body content.
String	getBodyAsStringDecoded() As this method has bad performance, it should not be used in any critical component.
String	getCharset()
String	getErrorMessage()
Header	getHeader()
String	getName()
abstract String	getStartLine()
String	getVersion()
boolean	hasMsgReleased()
boolean	isBodyEmpty()
boolean	isCSS()
boolean	isDeflate()
boolean	isGzip()
boolean	isHTML()
boolean	isHTTP10()
boolean	isHTTP11()
boolean	isImage()
boolean	isJavaScript()
boolean	isJSON()
boolean	isKeepAlive()
boolean	isReleased()
boolean	isXML()
protected abstract void	parseStartLine(InputStream in)
void	read(InputStream in, boolean createBody) If the message is HTTP 1.1 but the header has no information about the content length, then an assumption is made that after the body the server will send an EOF.
void	readBody()
void	release() preserve synchronized keyword, notify method is called
void	setBody(AbstractBody b) Sets the body.
void	setBodyContent(byte[] content) Sets the body.
void	setErrorMessage(String errorMessage)
void	setHeader(Header srcHeader)
void	setReleased(boolean released)
void	setVersion(String version)
String	toString()
void	write(OutputStream out)
void	writeStartLine(OutputStream out) The start line supposedly only contains ASCII characters.

Methods inherited from class java.lang.Object

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

Field Detail

header

protected Header header

body

protected AbstractBody body

version

protected String version

Constructor Detail

Message

public Message()

Method Detail

read

public void read(InputStream in,
                 boolean createBody)
          throws IOException,
                 EndOfStreamException

If the message is HTTP 1.1 but the header has no information about the content length, then an assumption is made that after the body the server will send an EOF. So the body is read till end of the stream. See http://www.ietf.org/rfc/rfc2145.txt

Throws:

IOException

EndOfStreamException

readBody

public void readBody()
              throws IOException

Throws:

IOException

discardBody

public void discardBody()
                 throws IOException

Throws:

IOException

getBody

public AbstractBody getBody()

getBodyAsStream

public InputStream getBodyAsStream()

Probably you want to use getBodyAsStreamDecoded() instead:

Transfer-Encodings (e.g. chunking) have been unapplied, but Content-Encodings (e.g. gzip) have not.

Returns the body as a stream.

Supports streaming: The HTTP message does not have to be completely received yet for this method to return.

See Also:

AbstractBody.getContentAsStream()

getBodyAsStreamDecoded

public InputStream getBodyAsStreamDecoded()

Returns the logical body content.

Any Transfer-Encodings (e.g. chunking) and/or Content-Encodings (e.g. gzip) have been unapplied.

Supports streaming: The HTTP message does not have to be completely received yet for this method to return.

getBodyAsStringDecoded

public String getBodyAsStringDecoded()

As this method has bad performance, it should not be used in any critical component. (Use getBodyAsStreamDecoded() instead.)

Allocates a new String object for the whole body (potentially performing charset conversion).

Blocks until the body has been fully received.

(... and more bad internal performance)

Returns:

the message's body as a Java String.

setBody

public void setBody(AbstractBody b)

Sets the body. Does NOT adjust the header fields (Content-Length etc.): Use setBodyContent(byte[]) instead.

setBodyContent

public void setBodyContent(byte[] content)

Sets the body. Also adjusts the header fields (Content-Length, Content-Encoding, Transfer-Encoding).

createBody

protected void createBody(InputStream in)
                   throws IOException

Throws:

IOException

parseStartLine

protected abstract void parseStartLine(InputStream in)
                                throws IOException,
                                       EndOfStreamException

Throws:

IOException

EndOfStreamException

getHeader

public Header getHeader()

release

public void release()

preserve synchronized keyword, notify method is called

hasMsgReleased

public boolean hasMsgReleased()

setHeader

public void setHeader(Header srcHeader)

write

public final void write(OutputStream out)
                 throws IOException

Throws:

IOException

writeStartLine

public void writeStartLine(OutputStream out)
                    throws IOException

The start line supposedly only contains ASCII characters. But since HttpUtil.readLine(InputStream) converts the input byte-by-byte to char-by-char, we use ISO-8859-1 for output.

Throws:

IOException

getStartLine

public abstract String getStartLine()

isHTTP11

public boolean isHTTP11()

isHTTP10

public boolean isHTTP10()

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

toString

public String toString()

Overrides:

toString in class Object

isKeepAlive

public boolean isKeepAlive()

getErrorMessage

public String getErrorMessage()

setErrorMessage

public void setErrorMessage(String errorMessage)

getName

public String getName()

isBodyEmpty

public boolean isBodyEmpty()
                    throws IOException

Throws:

IOException

isImage

public boolean isImage()

isXML

public boolean isXML()

isJSON

public boolean isJSON()

isHTML

public boolean isHTML()

isCSS

public boolean isCSS()

isJavaScript

public boolean isJavaScript()

isGzip

public boolean isGzip()

isDeflate

public boolean isDeflate()

getCharset

public String getCharset()

addObserver

public void addObserver(MessageObserver observer)

estimateHeapSize

public int estimateHeapSize()

createSnapshot

public abstract <T extends Message> T createSnapshot()
                                              throws Exception

Throws:

Exception

createMessageSnapshot

public <T extends Message> T createMessageSnapshot(T result)
                                            throws IOException

Throws:

IOException

isReleased

public boolean isReleased()

setReleased

public void setReleased(boolean released)

containsObserver

public boolean containsObserver(MessageObserver obs)