Package com.predic8.membrane.core.http

Class Response

java.lang.Object

com.predic8.membrane.core.http.Message

com.predic8.membrane.core.http.Response

Direct Known Subclasses:

NoResponse

public class Response
extends Message

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Response.ResponseBuilder

Field Summary

Fields inherited from class com.predic8.membrane.core.http.Message

body, header, version

Constructor Summary

Constructors

Constructor	Description
Response()

Method Summary

Modifier and Type	Method	Description
static Response.ResponseBuilder	accepted()
static Response.ResponseBuilder	badGateway(String message)
static Response.ResponseBuilder	badRequest()
static Response.ResponseBuilder	badRequest(String message)
static Response.ResponseBuilder	badRequest(String message, boolean escape)
static Response.ResponseBuilder	continue100()
protected void	createBody(InputStream in)
<T extends Message> T	createSnapshot(Runnable bodyUpdatedCallback, BodyCollectingMessageObserver.Strategy strategy, long limit)
int	estimateHeapSize()
static Response.ResponseBuilder	forbidden()
static Response.ResponseBuilder	forbidden(String message)
static Response.ResponseBuilder	found(String location)
static Response.ResponseBuilder	fromStatusCode(int statusCode, String msg)
static Response.ResponseBuilder	gatewayTimeout(String message)
String	getName()
String	getStartLine()
int	getStatusCode()
String	getStatusMessage()
boolean	hasNoContent()
static Response.ResponseBuilder	internalServerError()
static Response.ResponseBuilder	internalServerError(String message)
boolean	isKeepAlive()
boolean	isOk()
boolean	isRedirect()
boolean	isServerError()
boolean	isUserError()
static Response.ResponseBuilder	methodNotAllowed()
static Response.ResponseBuilder	noContent()
static Response.ResponseBuilder	notFound()
static Response.ResponseBuilder	notImplemented()
static Response.ResponseBuilder	notModified(String date)
static Response.ResponseBuilder	ok()
static Response.ResponseBuilder	ok(String msg)
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.
static Response.ResponseBuilder	redirect(String uri, boolean permanent)
static Response.ResponseBuilder	redirectWithout300(String uri)
static Response.ResponseBuilder	redirectWithout300(String uri, String body)
static Response.ResponseBuilder	serviceUnavailable(String message)
void	setStatusCode(int statusCode)
void	setStatusMessage(String statusMessage)
boolean	shouldNotContainBody()
static Response.ResponseBuilder	statusCode(int statusCode)
static Response.ResponseBuilder	unauthorized()
static Response.ResponseBuilder	unauthorized(String message)

Methods inherited from class com.predic8.membrane.core.http.Message

addObserver, containsObserver, createMessageSnapshot, discardBody, getBody, getBodyAsStream, getBodyAsStreamDecoded, getBodyAsStringDecoded, getCharset, getErrorMessage, getHeader, getVersion, hasMsgReleased, isBodyEmpty, isCSS, isDeflate, isGzip, isHTML, isHTTP10, isHTTP11, isImage, isJavaScript, isJSON, isReleased, isXML, readBody, release, setBody, setBodyContent, setErrorMessage, setHeader, setReleased, setVersion, toString, write, writeStartLine

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response()

Method Details

ok

public static Response.ResponseBuilder ok(String msg)
                                   throws Exception

Throws:

Exception

statusCode

public static Response.ResponseBuilder statusCode(int statusCode)

ok

public static Response.ResponseBuilder ok()

accepted

public static Response.ResponseBuilder accepted()

noContent

public static Response.ResponseBuilder noContent()

found

public static Response.ResponseBuilder found(String location)

notModified

public static Response.ResponseBuilder notModified(String date)

badRequest

public static Response.ResponseBuilder badRequest()

badRequest

public static Response.ResponseBuilder badRequest(String message)

badRequest

public static Response.ResponseBuilder badRequest(String message,
 boolean escape)

continue100

public static Response.ResponseBuilder continue100()

redirect

public static Response.ResponseBuilder redirect(String uri,
 boolean permanent)

redirectWithout300

public static Response.ResponseBuilder redirectWithout300(String uri)

redirectWithout300

public static Response.ResponseBuilder redirectWithout300(String uri,
 String body)

serviceUnavailable

public static Response.ResponseBuilder serviceUnavailable(String message)

internalServerError

public static Response.ResponseBuilder internalServerError()

notImplemented

public static Response.ResponseBuilder notImplemented()

internalServerError

public static Response.ResponseBuilder internalServerError(String message)

badGateway

public static Response.ResponseBuilder badGateway(String message)

gatewayTimeout

public static Response.ResponseBuilder gatewayTimeout(String message)

forbidden

public static Response.ResponseBuilder forbidden()

notFound

public static Response.ResponseBuilder notFound()

forbidden

public static Response.ResponseBuilder forbidden(String message)

unauthorized

public static Response.ResponseBuilder unauthorized(String message)

fromStatusCode

public static Response.ResponseBuilder fromStatusCode(int statusCode,
 String msg)

unauthorized

public static Response.ResponseBuilder unauthorized()

methodNotAllowed

public static Response.ResponseBuilder methodNotAllowed()

getStartLine

public String getStartLine()

Specified by:

getStartLine in class Message

getStatusCode

public int getStatusCode()

setStatusCode

public void setStatusCode(int statusCode)

getStatusMessage

public String getStatusMessage()

setStatusMessage

public void setStatusMessage(String statusMessage)

parseStartLine

public void parseStartLine(InputStream in)
                    throws IOException,
EndOfStreamException

Specified by:

parseStartLine in class Message

Throws:

IOException

EndOfStreamException

read

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

Description copied from class: Message

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

Overrides:

read in class Message

Throws:

IOException

EndOfStreamException

createBody

protected void createBody(InputStream in)
                   throws IOException

Overrides:

createBody in class Message

Throws:

IOException

isRedirect

public boolean isRedirect()

hasNoContent

public boolean hasNoContent()

getName

public String getName()

Overrides:

getName in class Message

shouldNotContainBody

public boolean shouldNotContainBody()

Specified by:

shouldNotContainBody in class Message

isOk

public boolean isOk()

isUserError

public boolean isUserError()

isServerError

public boolean isServerError()

isKeepAlive

public boolean isKeepAlive()

Overrides:

isKeepAlive in class Message

estimateHeapSize

public int estimateHeapSize()

Overrides:

estimateHeapSize in class Message

createSnapshot

public <T extends Message> T createSnapshot(Runnable bodyUpdatedCallback,
 BodyCollectingMessageObserver.Strategy strategy,
 long limit)

Specified by:

createSnapshot in class Message