Class SokletHttpServletResponse

java.lang.Object

com.soklet.servlet.jakarta.SokletHttpServletResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

@NotThreadSafe
public final class SokletHttpServletResponse
extends Object
implements HttpServletResponse

Soklet integration implementation of HttpServletResponse.

Author:

Mark Allen

Field Summary

Fields inherited from interface HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MISDIRECTED_REQUEST, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PERMANENT_REDIRECT, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY

Method Summary

Modifier and Type	Method	Description
void	addCookie(@Nullable Cookie cookie)
void	addDateHeader(@Nullable String name, long date)
void	addHeader(@Nullable String name, @Nullable String value)
void	addIntHeader(@Nullable String name, int value)
boolean	containsHeader(@Nullable String name)
@Nullable String	encodeRedirectURL(@Nullable String url)
@Nullable String	encodeURL(@Nullable String url)
void	flushBuffer()
static @NonNull SokletHttpServletResponse	fromRawPath(@NonNull String rawPath, @NonNull ServletContext servletContext)	Creates a response bound to Soklet's raw path construct.
static @NonNull SokletHttpServletResponse	fromRequest(@NonNull Request request, @NonNull ServletContext servletContext)
static @NonNull SokletHttpServletResponse	fromRequest(@NonNull HttpServletRequest request)
int	getBufferSize()
@NonNull String	getCharacterEncoding()
@Nullable String	getContentType()
@Nullable String	getHeader(@Nullable String name)
@NonNull Collection<@NonNull String>	getHeaderNames()
@NonNull Collection<@NonNull String>	getHeaders(@Nullable String name)
Locale	getLocale()
@NonNull ServletOutputStream	getOutputStream()
int	getStatus()
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, @Nullable String msg)
void	sendRedirect(@Nullable String location)
void	sendRedirect(@Nullable String location, int sc, boolean clearBuffer)
void	setBufferSize(int size)
void	setCharacterEncoding(@Nullable String charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(@Nullable String type)
void	setDateHeader(@Nullable String name, long date)
void	setHeader(@Nullable String name, @Nullable String value)
void	setIntHeader(@Nullable String name, int value)
void	setLocale(@Nullable Locale locale)
void	setPrintWriter(@Nullable SokletServletPrintWriter printWriter)
void	setStatus(int sc)
@NonNull MarshaledResponse	toMarshaledResponse()
@NonNull Response	toResponse()

Methods inherited from class Object

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

Methods inherited from interface HttpServletResponse

getTrailerFields, sendRedirect, sendRedirect, setTrailerFields

Methods inherited from interface ServletResponse

setCharacterEncoding

Method Details

fromRequest

public static @NonNull SokletHttpServletResponse fromRequest(@NonNull HttpServletRequest request)

fromRequest

public static @NonNull SokletHttpServletResponse fromRequest(@NonNull Request request,
 @NonNull ServletContext servletContext)

fromRawPath

public static @NonNull SokletHttpServletResponse fromRawPath(@NonNull String rawPath,
 @NonNull ServletContext servletContext)

Creates a response bound to Soklet's raw path construct.

This is the exact path component sent by the client, without URL decoding and without a query string (for example, "/a%20b/c"). It corresponds to Request.getRawPath().

Parameters:

rawPath - raw path component of the request (no query string)

servletContext - servlet context for this response

Returns:

a response bound to the raw request path

toResponse

public @NonNull Response toResponse()

toMarshaledResponse

public @NonNull MarshaledResponse toMarshaledResponse()

setPrintWriter

public void setPrintWriter(@Nullable SokletServletPrintWriter printWriter)

addCookie

public void addCookie(@Nullable Cookie cookie)

Specified by:

addCookie in interface HttpServletResponse

containsHeader

public boolean containsHeader(@Nullable String name)

Specified by:

containsHeader in interface HttpServletResponse

encodeURL

public @Nullable String encodeURL(@Nullable String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectURL

public @Nullable String encodeRedirectURL(@Nullable String url)

Specified by:

encodeRedirectURL in interface HttpServletResponse

sendError

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

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendError

public void sendError(int sc)
               throws IOException

Specified by:

sendError in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(@Nullable String location)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(@Nullable String location,
 int sc,
 boolean clearBuffer)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

setDateHeader

public void setDateHeader(@Nullable String name,
 long date)

Specified by:

setDateHeader in interface HttpServletResponse

addDateHeader

public void addDateHeader(@Nullable String name,
 long date)

Specified by:

addDateHeader in interface HttpServletResponse

setHeader

public void setHeader(@Nullable String name,
 @Nullable String value)

Specified by:

setHeader in interface HttpServletResponse

addHeader

public void addHeader(@Nullable String name,
 @Nullable String value)

Specified by:

addHeader in interface HttpServletResponse

setIntHeader

public void setIntHeader(@Nullable String name,
 int value)

Specified by:

setIntHeader in interface HttpServletResponse

addIntHeader

public void addIntHeader(@Nullable String name,
 int value)

Specified by:

addIntHeader in interface HttpServletResponse

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface HttpServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface HttpServletResponse

getHeader

public @Nullable String getHeader(@Nullable String name)

Specified by:

getHeader in interface HttpServletResponse

getHeaders

public @NonNull Collection<@NonNull String> getHeaders(@Nullable String name)

Specified by:

getHeaders in interface HttpServletResponse

getHeaderNames

public @NonNull Collection<@NonNull String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletResponse

getCharacterEncoding

public @NonNull String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getContentType

public @Nullable String getContentType()

Specified by:

getContentType in interface ServletResponse

getOutputStream

public @NonNull ServletOutputStream getOutputStream()
                                             throws IOException

Specified by:

getOutputStream in interface ServletResponse

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface ServletResponse

Throws:

IOException

setCharacterEncoding

public void setCharacterEncoding(@Nullable String charset)

Specified by:

setCharacterEncoding in interface ServletResponse

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface ServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface ServletResponse

setContentType

public void setContentType(@Nullable String type)

Specified by:

setContentType in interface ServletResponse

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ServletResponse

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface ServletResponse

Throws:

IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface ServletResponse

reset

public void reset()

Specified by:

reset in interface ServletResponse

setLocale

public void setLocale(@Nullable Locale locale)

Specified by:

setLocale in interface ServletResponse

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletResponse