Package com.spec.web.expresso.message

Class HttpResponse

java.lang.Object

com.spec.web.expresso.message.HttpResponse

All Implemented Interfaces:

Response

public class HttpResponse
extends Object
implements Response

Wrapper class over HttpServletResponse. Helps in handling http response

Constructor Summary

Constructors

Constructor	Description
HttpResponse(jakarta.servlet.http.HttpServletResponse resp)	Constructs an instance of this class

Method Summary

Modifier and Type	Method	Description
boolean	_closeOutputStream()	Closes the output stream.
jakarta.servlet.http.HttpServletResponse	getHttpServletResponse()	Returns the httpservletresponse used internally by Expresso.
OutputStream	getOutputStream()	Returns the output stream from response servlet.
jakarta.servlet.http.HttpServletResponse	getRawHttpServletResponse()	resturns the raw http servlet response
HttpResponse	resetResponse()	Resets the response object
HttpResponse	resetResponseBody()	Resets the body of the response
HttpResponse	setContentTypeHeader(String contentType)	Sets the content type header
void	setCookies(jakarta.servlet.http.Cookie cookie, jakarta.servlet.http.Cookie... moreCookies)	Sets a cookie that will be sent to the client.
HttpResponse	setHtml(String html)	Sends html Note: Resets any data present in response object
HttpResponse	setResponseHeader(String name, String value)	Sets the Http response headers
HttpResponse	setStatusCode(Integer statusCode)	Set the Http status code of the response
HttpResponse	writeResponse(String response)	Set the http response body

Methods inherited from class java.lang.Object

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

Constructor Details

HttpResponse

public HttpResponse(jakarta.servlet.http.HttpServletResponse resp)

Constructs an instance of this class

Parameters:

resp - HttpServletResponse to wrap

Method Details

writeResponse

public HttpResponse writeResponse(String response)

Set the http response body

Specified by:

writeResponse in interface Response

Parameters:

response - The response send to the client.

Returns:

returns the current class instance for method chaining.

setStatusCode

public HttpResponse setStatusCode(Integer statusCode)

Set the Http status code of the response

Specified by:

setStatusCode in interface Response

Parameters:

statusCode - The status code of the message

Returns:

returns the current class instance for method chaining.

setResponseHeader

public HttpResponse setResponseHeader(String name,
 String value)

Sets the Http response headers

Specified by:

setResponseHeader in interface Response

Parameters:

name - the name of the header

value - the value of the header

Returns:

returns the current class instance for method chaining.

setContentTypeHeader

public HttpResponse setContentTypeHeader(String contentType)

Sets the content type header

Specified by:

setContentTypeHeader in interface Response

Parameters:

contentType - the content type the message body is made of

Returns:

returns the current class instance for method chaining.

setHtml

public HttpResponse setHtml(String html)

Sends html Note: Resets any data present in response object

Specified by:

setHtml in interface Response

Parameters:

html - The html response to send

Returns:

returns the current class instance for method chaining.

resetResponse

public HttpResponse resetResponse()

Resets the response object

Specified by:

resetResponse in interface Response

Returns:

returns the current class instance for method chaining.

getRawHttpServletResponse

public jakarta.servlet.http.HttpServletResponse getRawHttpServletResponse()

resturns the raw http servlet response

Returns:

current http servlet response

resetResponseBody

public HttpResponse resetResponseBody()

Resets the body of the response

Specified by:

resetResponseBody in interface Response

Returns:

returns the current class instance for method chaining.

getHttpServletResponse

public jakarta.servlet.http.HttpServletResponse getHttpServletResponse()

Returns the httpservletresponse used internally by Expresso.

Returns:

HttpServletResponse

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Returns the output stream from response servlet.

Specified by:

getOutputStream in interface Response

Returns:

OutputStream

Throws:

IOException - IOException

_closeOutputStream

public boolean _closeOutputStream()

Closes the output stream. Returns true if successfull

Specified by:

_closeOutputStream in interface Response

Returns:

Returns true if successfull.

setCookies

public void setCookies(jakarta.servlet.http.Cookie cookie,
 jakarta.servlet.http.Cookie... moreCookies)

Sets a cookie that will be sent to the client.

Specified by:

setCookies in interface Response

Parameters:

cookie - Cookie instance

moreCookies - More cookies :)