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 jakarta.servlet.http.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(Cookie cookie)
void	addDateHeader(String name, long date)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
boolean	containsHeader(String name)
String	encodeRedirectURL(String url)
String	encodeURL(String url)
void	flushBuffer()
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
String	getHeader(String name)
Collection<String>	getHeaderNames()
Collection<String>	getHeaders(String name)
Locale	getLocale()
ServletOutputStream	getOutputStream()
int	getStatus()
Supplier<Map<String,String>>	getTrailerFields()
PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(int sc)
void	sendError(int sc, String msg)
void	sendRedirect(String location)
void	sendRedirect(String location, boolean clearBuffer)
void	sendRedirect(String location, int statusCode)
void	sendRedirect(String location, int statusCode, boolean clearBuffer)
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setCharacterEncoding(Charset charset)
void	setContentLength(int len)
void	setContentLengthLong(long len)
void	setContentType(String type)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
void	setPrintWriter(SokletServletPrintWriter printWriter)
void	setStatus(int sc)
void	setTrailerFields(Supplier<Map<String,String>> supplier)
MarshaledResponse	toMarshaledResponse()
Response	toResponse()
static SokletHttpServletResponse	withRequest(Request request)
static SokletHttpServletResponse	withRequestPath(String requestPath)

Methods inherited from class java.lang.Object

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

Method Details

withRequest

@Nonnull
public static SokletHttpServletResponse withRequest(@Nonnull
 Request request)

withRequestPath

@Nonnull
public static SokletHttpServletResponse withRequestPath(@Nonnull
 String requestPath)

toResponse

@Nonnull
public Response toResponse()

toMarshaledResponse

@Nonnull
public 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

@Nullable
public String encodeURL(@Nullable
 String url)

Specified by:

encodeURL in interface HttpServletResponse

encodeRedirectURL

@Nullable
public 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

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

@Nullable
public String getHeader(@Nullable
 String name)

Specified by:

getHeader in interface HttpServletResponse

getHeaders

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

Specified by:

getHeaders in interface HttpServletResponse

getHeaderNames

@Nonnull
public Collection<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletResponse

getCharacterEncoding

@Nonnull
public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletResponse

getContentType

@Nullable
public String getContentType()

Specified by:

getContentType in interface ServletResponse

getOutputStream

@Nonnull
public 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

sendRedirect

public void sendRedirect(@Nonnull
 String location,
 int statusCode)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(@Nonnull
 String location,
 boolean clearBuffer)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

sendRedirect

public void sendRedirect(@Nonnull
 String location,
 int statusCode,
 boolean clearBuffer)
                  throws IOException

Specified by:

sendRedirect in interface HttpServletResponse

Throws:

IOException

setTrailerFields

public void setTrailerFields(@Nullable
 Supplier<Map<String,String>> supplier)

Specified by:

setTrailerFields in interface HttpServletResponse

getTrailerFields

@Nullable
public Supplier<Map<String,String>> getTrailerFields()

Specified by:

getTrailerFields in interface HttpServletResponse

setCharacterEncoding

public void setCharacterEncoding(@Nullable
 Charset charset)

Specified by:

setCharacterEncoding in interface ServletResponse