Package com.spec.web.expresso.message

Interface Response

All Known Implementing Classes:

HttpResponse

public interface Response

Modifies the response that will be send to the client.

Method Summary

Modifier and Type	Method	Description
boolean	_closeOutputStream()	Closes the output stream.
OutputStream	getOutputStream()	Returns the output stream from response servlet.
Response	resetResponse()	Resets the response
Response	resetResponseBody()	Resets the body of the response
Response	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.
Response	setHtml(String html)	Sends html response
Response	setResponseHeader(String name, String value)	Sets the response headers.
Response	setStatusCode(Integer statusCode)	Sets the status code of the response.
Response	writeResponse(String response)	Sets the http response body

Method Details

writeResponse

Response writeResponse(String response)

Sets the http response body

Parameters:

response - the response body

Returns:

returns the current class instance for method chaining.

setStatusCode

Response setStatusCode(Integer statusCode)

Sets the status code of the response.

Parameters:

statusCode - http staus code ex: 200, 404

Returns:

returns the current class instance for method chaining.

setResponseHeader

Response setResponseHeader(String name,
 String value)

Sets the response headers.

Parameters:

name - the name of the header

value - the value of the header

Returns:

returns the current class instance for method chaining.

setContentTypeHeader

Response setContentTypeHeader(String contentType)

Sets the content type header

Parameters:

contentType - the content type the message body is made of

Returns:

returns the current class instance for method chaining.

setHtml

Response setHtml(String html)

Sends html response

Parameters:

html - The html response to send

Returns:

returns the current class instance for method chaining.

resetResponse

Response resetResponse()

Resets the response

Returns:

returns the current class instance for method chaining.

resetResponseBody

Response resetResponseBody()

Resets the body of the response

Returns:

returns the current class instance for method chaining.

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Returns the output stream from response servlet.

Returns:

OutputStream

Throws:

IOException - IOException

_closeOutputStream

boolean _closeOutputStream()

Closes the output stream. Returns true if successfull

Returns:

Returns true if successfull.

setCookies

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

Sets a cookie that will be sent to the client.

Parameters:

cookie - Cookie instance

moreCookies - More cookies :)