Package fi.iki.elonen

Class NanoHTTPD.Response

java.lang.Object

fi.iki.elonen.NanoHTTPD.Response

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

InternalRewrite

Enclosing class:

NanoHTTPD

public static class NanoHTTPD.Response
extends Object
implements Closeable

HTTP response. Return one of these from serve().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	NanoHTTPD.Response.ChunkedOutputStream	Output stream that will automatically send every write to the wrapped OutputStream according to chunked transfer: http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1
static interface	NanoHTTPD.Response.IStatus
static enum	NanoHTTPD.Response.Status	Some HTTP response status codes

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	chunkedTransfer	Use chunkedTransfer
private long	contentLength
private InputStream	data	Data of the response, may be null.
private boolean	encodeAsGzip
private final Map<String,String>	header	Headers for the HTTP response.
private boolean	keepAlive
private final Map<String,String>	lowerCaseHeader	copy of the header map with all the keys lowercase for faster searching.
private String	mimeType	MIME type of content, e.g.
private NanoHTTPD.Method	requestMethod	The request method that spawned this response.
private NanoHTTPD.Response.IStatus	status	HTTP status code after processing, e.g.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Response(NanoHTTPD.Response.IStatus status, String mimeType, InputStream data, long totalBytes)	Creates a fixed length response if totalBytes>=0, otherwise chunked.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)	Adds given line to the header.
void	close()
void	closeConnection(boolean close)	Indicate to close the connection after the Response has been sent.
InputStream	getData()
String	getHeader(String name)
String	getMimeType()
NanoHTTPD.Method	getRequestMethod()
NanoHTTPD.Response.IStatus	getStatus()
boolean	isCloseConnection()
protected void	printHeader(PrintWriter pw, String key, String value)
protected void	send(OutputStream outputStream)	Sends given response to the socket.
private void	sendBody(OutputStream outputStream, long pending)	Sends the body to the specified OutputStream.
private void	sendBodyWithCorrectEncoding(OutputStream outputStream, long pending)
private void	sendBodyWithCorrectTransferAndEncoding(OutputStream outputStream, long pending)
protected long	sendContentLengthHeaderIfNotAlreadyPresent(PrintWriter pw, long defaultSize)
void	setChunkedTransfer(boolean chunkedTransfer)
void	setData(InputStream data)
void	setGzipEncoding(boolean encodeAsGzip)
void	setKeepAlive(boolean useKeepAlive)
void	setMimeType(String mimeType)
void	setRequestMethod(NanoHTTPD.Method requestMethod)
void	setStatus(NanoHTTPD.Response.IStatus status)

Methods inherited from class java.lang.Object

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

Field Details

status

private NanoHTTPD.Response.IStatus status

HTTP status code after processing, e.g. "200 OK", Status.OK

mimeType

private String mimeType

MIME type of content, e.g. "text/html"

data

private InputStream data

Data of the response, may be null.

contentLength

private long contentLength

header

private final Map<String,String> header

Headers for the HTTP response. Use addHeader() to add lines. the lowercase map is automatically kept up to date.

lowerCaseHeader

private final Map<String,String> lowerCaseHeader

copy of the header map with all the keys lowercase for faster searching.

requestMethod

private NanoHTTPD.Method requestMethod

The request method that spawned this response.

chunkedTransfer

private boolean chunkedTransfer

Use chunkedTransfer

encodeAsGzip

private boolean encodeAsGzip

keepAlive

private boolean keepAlive

Constructor Details

Response

protected Response(NanoHTTPD.Response.IStatus status,
 String mimeType,
 InputStream data,
 long totalBytes)

Creates a fixed length response if totalBytes>=0, otherwise chunked.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

addHeader

public void addHeader(String name,
 String value)

Adds given line to the header.

closeConnection

public void closeConnection(boolean close)

Indicate to close the connection after the Response has been sent.

Parameters:

close - true to hint connection closing, false to let connection be closed by client.

isCloseConnection

public boolean isCloseConnection()

Returns:

true if connection is to be closed after this Response has been sent.

getData

public InputStream getData()

getHeader

public String getHeader(String name)

getMimeType

public String getMimeType()

getRequestMethod

public NanoHTTPD.Method getRequestMethod()

getStatus

public NanoHTTPD.Response.IStatus getStatus()

setGzipEncoding

public void setGzipEncoding(boolean encodeAsGzip)

setKeepAlive

public void setKeepAlive(boolean useKeepAlive)

send

protected void send(OutputStream outputStream)

Sends given response to the socket.

printHeader

protected void printHeader(PrintWriter pw,
 String key,
 String value)

sendContentLengthHeaderIfNotAlreadyPresent

protected long sendContentLengthHeaderIfNotAlreadyPresent(PrintWriter pw,
 long defaultSize)

sendBodyWithCorrectTransferAndEncoding

private void sendBodyWithCorrectTransferAndEncoding(OutputStream outputStream,
 long pending)
                                             throws IOException

Throws:

IOException

sendBodyWithCorrectEncoding

private void sendBodyWithCorrectEncoding(OutputStream outputStream,
 long pending)
                                  throws IOException

Throws:

IOException

sendBody

private void sendBody(OutputStream outputStream,
 long pending)
               throws IOException

Sends the body to the specified OutputStream. The pending parameter limits the maximum amounts of bytes sent unless it is -1, in which case everything is sent.

Parameters:

outputStream - the OutputStream to send data to

pending - -1 to send everything, otherwise sets a max limit to the number of bytes sent

Throws:

IOException - if something goes wrong while sending the data.

setChunkedTransfer

public void setChunkedTransfer(boolean chunkedTransfer)

setData

public void setData(InputStream data)

setMimeType

public void setMimeType(String mimeType)

setRequestMethod

public void setRequestMethod(NanoHTTPD.Method requestMethod)

setStatus

public void setStatus(NanoHTTPD.Response.IStatus status)