Package com.oorian.jakarta

Class JakartaHttpResponse

java.lang.Object

com.oorian.jakarta.JakartaHttpResponse

All Implemented Interfaces:

OorianHttpResponse

public class JakartaHttpResponse
extends Object
implements OorianHttpResponse

Adapter that wraps a HttpServletResponse to implement the framework-agnostic OorianHttpResponse interface.

This class is used by the thin Jakarta library to bridge between the servlet container and the Oorian common library.

Since:

2.1

Version:

1.0

Author:

Oorian Framework

See Also:

• OorianHttpResponse

Field Summary

Fields inherited from interface com.oorian.OorianHttpResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CREATED, SC_FORBIDDEN, SC_FOUND, SC_GONE, SC_INTERNAL_SERVER_ERROR, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_NO_CONTENT, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_SERVICE_UNAVAILABLE, SC_TEMPORARY_REDIRECT, SC_TOO_MANY_REQUESTS, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE

Constructor Summary

Constructors

Constructor	Description
JakartaHttpResponse(jakarta.servlet.http.HttpServletResponse response)	Creates a new adapter wrapping the given servlet response.

Method Summary

Modifier and Type	Method	Description
void	addCookie(OorianCookie cookie)	Adds a cookie to the response.
void	addHeader(String name, String value)	Adds a response header without replacing existing values.
boolean	containsHeader(String name)	Returns whether the response contains the specified header.
void	flushBuffer()	Forces any content in the buffer to be written to the client.
jakarta.servlet.http.HttpServletResponse	getDelegate()	Returns the underlying Jakarta servlet response.
OutputStream	getOutputStream()	Returns the output stream for writing binary response data.
int	getStatus()	Returns the current HTTP status code of this response.
PrintWriter	getWriter()	Returns a PrintWriter for writing character response data.
boolean	isCommitted()	Returns whether the response has been committed.
void	sendError(int sc, String msg)	Sends an error response with the specified status code and message.
void	sendRedirect(String url)	Sends a temporary redirect response to the specified URL.
void	setCharacterEncoding(String charset)	Sets the character encoding of the response.
void	setContentLength(int len)	Sets the content length of the response body.
void	setContentType(String type)	Sets the content type of the response.
void	setHeader(String name, String value)	Sets a response header, replacing any existing values.
void	setStatus(int sc)	Sets 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

Constructor Details

JakartaHttpResponse

public JakartaHttpResponse(jakarta.servlet.http.HttpServletResponse response)

Creates a new adapter wrapping the given servlet response.

Parameters:

response - The Jakarta servlet response to wrap.

Method Details

setContentType

public void setContentType(String type)

Description copied from interface: OorianHttpResponse

Sets the content type of the response.

Specified by:

setContentType in interface OorianHttpResponse

Parameters:

type - the MIME content type

setCharacterEncoding

public void setCharacterEncoding(String charset)

Description copied from interface: OorianHttpResponse

Sets the character encoding of the response.

Specified by:

setCharacterEncoding in interface OorianHttpResponse

Parameters:

charset - the character encoding name

setContentLength

public void setContentLength(int len)

Description copied from interface: OorianHttpResponse

Sets the content length of the response body.

Specified by:

setContentLength in interface OorianHttpResponse

Parameters:

len - the content length in bytes

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: OorianHttpResponse

Returns the output stream for writing binary response data.

Specified by:

getOutputStream in interface OorianHttpResponse

Returns:

the output stream

Throws:

IOException - if an I/O error occurs

getWriter

public PrintWriter getWriter()
                      throws IOException

Description copied from interface: OorianHttpResponse

Returns a PrintWriter for writing character response data.

Specified by:

getWriter in interface OorianHttpResponse

Returns:

the print writer

Throws:

IOException - if an I/O error occurs

setHeader

public void setHeader(String name,
 String value)

Description copied from interface: OorianHttpResponse

Sets a response header, replacing any existing values.

Specified by:

setHeader in interface OorianHttpResponse

Parameters:

name - the header name

value - the header value

addHeader

public void addHeader(String name,
 String value)

Description copied from interface: OorianHttpResponse

Adds a response header without replacing existing values.

Specified by:

addHeader in interface OorianHttpResponse

Parameters:

name - the header name

value - the header value

isCommitted

public boolean isCommitted()

Description copied from interface: OorianHttpResponse

Returns whether the response has been committed.

Specified by:

isCommitted in interface OorianHttpResponse

Returns:

true if the response has been committed

sendError

public void sendError(int sc,
 String msg)
               throws IOException

Description copied from interface: OorianHttpResponse

Sends an error response with the specified status code and message.

Specified by:

sendError in interface OorianHttpResponse

Parameters:

sc - the HTTP status code

msg - the error message

Throws:

IOException - if an I/O error occurs

setStatus

public void setStatus(int sc)

Description copied from interface: OorianHttpResponse

Sets the HTTP status code of the response.

Specified by:

setStatus in interface OorianHttpResponse

Parameters:

sc - the status code

sendRedirect

public void sendRedirect(String url)
                  throws IOException

Description copied from interface: OorianHttpResponse

Sends a temporary redirect response to the specified URL.

Specified by:

sendRedirect in interface OorianHttpResponse

Parameters:

url - the redirect URL

Throws:

IOException - if an I/O error occurs

addCookie

public void addCookie(OorianCookie cookie)

Description copied from interface: OorianHttpResponse

Adds a cookie to the response.

Specified by:

addCookie in interface OorianHttpResponse

Parameters:

cookie - the cookie to add

getStatus

public int getStatus()

Description copied from interface: OorianHttpResponse

Returns the current HTTP status code of this response.

Specified by:

getStatus in interface OorianHttpResponse

Returns:

the status code

containsHeader

public boolean containsHeader(String name)

Description copied from interface: OorianHttpResponse

Returns whether the response contains the specified header.

Specified by:

containsHeader in interface OorianHttpResponse

Parameters:

name - the header name

Returns:

true if the header has been set

flushBuffer

public void flushBuffer()
                 throws IOException

Description copied from interface: OorianHttpResponse

Forces any content in the buffer to be written to the client.

Specified by:

flushBuffer in interface OorianHttpResponse

Throws:

IOException - if an I/O error occurs

getDelegate

public jakarta.servlet.http.HttpServletResponse getDelegate()

Returns the underlying Jakarta servlet response.

Returns:

The wrapped HttpServletResponse.