de.aristaflow.adept2.ui.htmlgui

Class HTMLContext.Response

java.lang.Object

de.aristaflow.adept2.ui.htmlgui.HTMLContext.Response

Enclosing interface:

HTMLContext

public static class HTMLContext.Response
extends java.lang.Object

A HTTP-response to be sent to the HTTP-client.

Author:

Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLContext.Response.MimeType Common mime types for dynamic content

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.InputStream	data Data of the response, may be null.
protected java.util.Map<java.lang.String,java.lang.String>	header Headers for the HTTP response.
protected java.lang.String	mimeType MIME type of content, e.g.
protected int	status HTTP status code after processing, e.g. "200 OK", HTTP_OK

Constructor Summary

Constructors

Constructor and Description
Response(int status, java.lang.String origMimeType, java.io.InputStream data) Creates a new HTTP-response with the designated status, MIME-type and data.
Response(int status, java.lang.String mimeType, java.lang.String txt) Convenience method that creates a HTTP-response by wrapping the designated String by an InputStream.

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value) Adds the designated line to the header of this HTTP-response.
java.io.InputStream	getData() Returns the response data.
java.util.Map<java.lang.String,java.lang.String>	getHeader() Returns the additional response headers.
java.lang.String	getMimeType() Returns the mime type of the response.
int	getStatus() Return the HTTP status code of the response.

Methods inherited from class java.lang.Object

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

Field Detail

status

protected int status

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

mimeType

protected java.lang.String mimeType

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

data

protected java.io.InputStream data

Data of the response, may be null.

header

protected java.util.Map<java.lang.String,java.lang.String> header

Headers for the HTTP response. Use addHeader() to add lines.

Constructor Detail

Response

public Response(int status,
                java.lang.String origMimeType,
                java.io.InputStream data)

Creates a new HTTP-response with the designated status, MIME-type and data.

Parameters:

status - The HTTP-status of the response to create.

origMimeType - The MIME-type of the HTTP-response to create. null is interpreted as HTMLContext.Response.MimeType.MIME_PLAINTEXT.

data - The contents of the HTTP-response to create.

Response

public Response(int status,
                java.lang.String mimeType,
                java.lang.String txt)

Convenience method that creates a HTTP-response by wrapping the designated String by an InputStream.

Parameters:

status - The HTTP-status of the response to create.

mimeType - The MIME-type of the HTTP-response to create.

txt - The contents of the HTTP-response to create.

Method Detail

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Adds the designated line to the header of this HTTP-response.

Parameters:

name - The name of the header-field to add to this HTTP-response.

value - The value of the header-field to add to this HTTP-response.

getStatus

public int getStatus()

Return the HTTP status code of the response.

Returns:

The HTTP status code of the response.

getMimeType

public java.lang.String getMimeType()

Returns the mime type of the response.

Returns:

The mime type of the response.

getData

public java.io.InputStream getData()

Returns the response data.

Returns:

The response data.

getHeader

public java.util.Map<java.lang.String,java.lang.String> getHeader()

Returns the additional response headers.

Returns:

Additional response headers.