Class StaplerResponse.StaplerResponse2WrapperImpl
- All Implemented Interfaces:
HttpServletResponseWrapper.JakartaHttpServletResponseWrapper
,ServletResponseWrapper.JakartaServletResponseWrapper
,jakarta.servlet.http.HttpServletResponse
,jakarta.servlet.ServletResponse
,StaplerResponse.StaplerResponse2Wrapper
,StaplerResponse2
- Enclosing interface:
- StaplerResponse
-
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_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_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_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCookie
(jakarta.servlet.http.Cookie cookie) void
addDateHeader
(String name, long date) void
void
addIntHeader
(String name, int value) boolean
containsHeader
(String name) encodeRedirectUrl
(String url) encodeRedirectURL
(String url) void
void
forward
(Object it, String url, StaplerRequest2 request) Evaluates the url against the given object and forwards the request to the result.void
forwardToPreviousPage
(StaplerRequest2 request) Redirects the browser to where it came from (the referer.)int
getCompressedOutputStream
(jakarta.servlet.http.HttpServletRequest req) getCompressedWriter
(jakarta.servlet.http.HttpServletRequest req) getHeaders
(String name) net.sf.json.JsonConfig
The JsonConfig to be used when serializing java beans to JSON previously set byStaplerResponse2.setJsonConfig(JsonConfig)
.jakarta.servlet.ServletOutputStream
int
boolean
void
reset()
void
int
reverseProxyTo
(URL url, StaplerRequest2 req) Performs the reverse proxy to the given URL.void
sendError
(int sc) void
void
sendRedirect
(int statusCore, String url) Works likeStaplerResponse2.sendRedirect2(String)
but allows the caller to specify the HTTP status code.void
sendRedirect
(String location) void
sendRedirect2
(String url) Works likeHttpServletResponse.sendRedirect(String)
except that this method escapes the URL.void
serveExposedBean
(StaplerRequest2 req, Object exposedBean, ExportConfig exportConfig) Serves the exposed bean in the specified flavor.void
serveExposedBean
(StaplerRequest2 req, Object exposedBean, Flavor flavor) Serves the exposed bean in the specified flavor.void
serveFile
(StaplerRequest2 req, InputStream data, long lastModified, int contentLength, String fileName) void
serveFile
(StaplerRequest2 req, InputStream data, long lastModified, long expiration, int contentLength, String fileName) void
serveFile
(StaplerRequest2 req, InputStream data, long lastModified, long expiration, long contentLength, String fileName) Serves a static resource.void
serveFile
(StaplerRequest2 req, InputStream data, long lastModified, long contentLength, String fileName) Serves a static resource.void
serveFile
(StaplerRequest2 request, URL res) Serves a static resource.void
serveFile
(StaplerRequest2 request, URL res, long expiration) void
serveLocalizedFile
(StaplerRequest2 request, URL res) Works likeStaplerResponse2.serveFile(StaplerRequest2, URL)
but chooses the locale specific version of the resource if it's available.void
serveLocalizedFile
(StaplerRequest2 request, URL res, long expiration) Works likeStaplerResponse2.serveFile(StaplerRequest2, URL, long)
but chooses the locale specific version of the resource if it's available.void
setBufferSize
(int size) void
setCharacterEncoding
(String charset) void
setContentLength
(int len) void
setContentLengthLong
(long len) void
setContentType
(String type) void
setDateHeader
(String name, long date) void
void
setIntHeader
(String name, int value) void
setJsonConfig
(net.sf.json.JsonConfig config) The JsonConfig to be used when serializing java beans from js bound methods to JSON.void
void
setStatus
(int sc) void
void
setTrailerFields
(Supplier<Map<String, String>> supplier) javax.servlet.http.HttpServletResponse
javax.servlet.ServletResponse
-
Constructor Details
-
StaplerResponse2WrapperImpl
-
-
Method Details
-
forward
public void forward(Object it, String url, StaplerRequest2 request) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Evaluates the url against the given object and forwards the request to the result.This can be used for example inside an action method to forward a request to a JSP.
- Specified by:
forward
in interfaceStaplerResponse2
- Parameters:
it
- the URL is evaluated against this object. Must not be null.url
- the relative URL (e.g., "foo" or "foo/bar") to resolve against the "it" object.request
- Request to be forwarded.- Throws:
jakarta.servlet.ServletException
IOException
-
forwardToPreviousPage
public void forwardToPreviousPage(StaplerRequest2 request) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Redirects the browser to where it came from (the referer.)- Specified by:
forwardToPreviousPage
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
sendRedirect2
Description copied from interface:StaplerResponse2
Works likeHttpServletResponse.sendRedirect(String)
except that this method escapes the URL.- Specified by:
sendRedirect2
in interfaceStaplerResponse2
- Throws:
IOException
-
sendRedirect
Description copied from interface:StaplerResponse2
Works likeStaplerResponse2.sendRedirect2(String)
but allows the caller to specify the HTTP status code.- Specified by:
sendRedirect
in interfaceStaplerResponse2
- Throws:
IOException
-
serveFile
public void serveFile(StaplerRequest2 request, URL res) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Serves a static resource.This method sets content type, HTTP status code, sends the complete data and closes the response. This method also handles cache-control HTTP headers like "If-Modified-Since" and others.
- Specified by:
serveFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveFile
public void serveFile(StaplerRequest2 request, URL res, long expiration) throws jakarta.servlet.ServletException, IOException - Specified by:
serveFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveLocalizedFile
public void serveLocalizedFile(StaplerRequest2 request, URL res) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Works likeStaplerResponse2.serveFile(StaplerRequest2, URL)
but chooses the locale specific version of the resource if it's available. The convention of "locale specific version" is the same as that of property files. So Japanese resource forfoo.html
would be namedfoo_ja.html
.- Specified by:
serveLocalizedFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveLocalizedFile
public void serveLocalizedFile(StaplerRequest2 request, URL res, long expiration) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Works likeStaplerResponse2.serveFile(StaplerRequest2, URL, long)
but chooses the locale specific version of the resource if it's available. SeeStaplerResponse2.serveLocalizedFile(StaplerRequest2, URL)
for more details.- Specified by:
serveLocalizedFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveFile
public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, long expiration, long contentLength, String fileName) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Serves a static resource.This method works like
StaplerResponse2.serveFile(StaplerRequest2, URL)
but this version allows the caller to fetch data from anywhere.- Specified by:
serveFile
in interfaceStaplerResponse2
data
-InputStream
that contains the data of the static resource.lastModified
- The timestamp when the resource was last modified. SeeURLConnection.getLastModified()
for the meaning of the value. 0 if unknown, in which case "If-Modified-Since" handling will not be performed.expiration
- The number of milliseconds until the resource will "expire". Until it expires the browser will be allowed to cache it and serve it without checking back with the server. After it expires, the client will send conditional GET to check if the resource is actually modified or not. If 0, it will immediately expire.contentLength
- if the length of the input stream is known in advance, specify that value so that HTTP keep-alive works. Otherwise specify -1 to indicate that the length is unknown.fileName
- file name of this resource. Used to determine the MIME type. Since the only important portion is the file extension, this could be just a file name, or a full path name, or even a pseudo file name that doesn't actually exist. It supports both '/' and '\\' as the path separator. If this string starts with "mime-type:", like "mime-type:foo/bar", then "foo/bar" will be used as a MIME type without consulting the servlet container.- Throws:
jakarta.servlet.ServletException
IOException
-
serveFile
public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, long expiration, int contentLength, String fileName) throws jakarta.servlet.ServletException, IOException - Specified by:
serveFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveFile
public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, long contentLength, String fileName) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Serves a static resource. Expiration date is set to the value that forces browser to do conditional GET for all resources.- Specified by:
serveFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
- See Also:
-
serveFile
public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, int contentLength, String fileName) throws jakarta.servlet.ServletException, IOException - Specified by:
serveFile
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveExposedBean
public void serveExposedBean(StaplerRequest2 req, Object exposedBean, Flavor flavor) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Serves the exposed bean in the specified flavor.This method performs the complete output from the header to the response body. If the flavor is JSON, this method also supports JSONP via the
jsonp
query parameter.The
depth
parameter may be used to specify a recursion depth as inModel.writeTo(Object,int,DataWriter)
.As of 1.146, the
tree
parameter may be used to control the output in detail; seeNamedPathPruner(String)
for details.- Specified by:
serveExposedBean
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
serveExposedBean
public void serveExposedBean(StaplerRequest2 req, Object exposedBean, ExportConfig exportConfig) throws jakarta.servlet.ServletException, IOException Description copied from interface:StaplerResponse2
Serves the exposed bean in the specified flavor.This method performs the complete output from the header to the response body. If the flavor is JSON, this method also supports JSONP via the
jsonp
query parameter.The
depth
parameter may be used to specify a recursion depth as inModel.writeTo(Object,int,DataWriter)
As of 1.146, the
tree
parameter may be used to control the output in detail; seeNamedPathPruner(String)
for details.ExportConfig
is passed by the caller to control serialization behavior- Specified by:
serveExposedBean
in interfaceStaplerResponse2
- Throws:
jakarta.servlet.ServletException
IOException
-
getCompressedOutputStream
public OutputStream getCompressedOutputStream(jakarta.servlet.http.HttpServletRequest req) throws IOException - Specified by:
getCompressedOutputStream
in interfaceStaplerResponse2
- Throws:
IOException
-
getCompressedWriter
- Specified by:
getCompressedWriter
in interfaceStaplerResponse2
- Throws:
IOException
-
reverseProxyTo
Description copied from interface:StaplerResponse2
Performs the reverse proxy to the given URL.- Specified by:
reverseProxyTo
in interfaceStaplerResponse2
- Returns:
- The status code of the response.
- Throws:
IOException
-
setJsonConfig
public void setJsonConfig(net.sf.json.JsonConfig config) Description copied from interface:StaplerResponse2
The JsonConfig to be used when serializing java beans from js bound methods to JSON. Setting this to null will make the default config to be used.- Specified by:
setJsonConfig
in interfaceStaplerResponse2
- Parameters:
config
- the config
-
getJsonConfig
public net.sf.json.JsonConfig getJsonConfig()Description copied from interface:StaplerResponse2
The JsonConfig to be used when serializing java beans to JSON previously set byStaplerResponse2.setJsonConfig(JsonConfig)
. Will return the default config if nothing has previously been set.- Specified by:
getJsonConfig
in interfaceStaplerResponse2
- Returns:
- the config
-
getCharacterEncoding
- Specified by:
getCharacterEncoding
in interfacejakarta.servlet.ServletResponse
-
getContentType
- Specified by:
getContentType
in interfacejakarta.servlet.ServletResponse
-
getOutputStream
- Specified by:
getOutputStream
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
getWriter
- Specified by:
getWriter
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
setCharacterEncoding
- Specified by:
setCharacterEncoding
in interfacejakarta.servlet.ServletResponse
-
setContentLength
public void setContentLength(int len) - Specified by:
setContentLength
in interfacejakarta.servlet.ServletResponse
-
setContentLengthLong
public void setContentLengthLong(long len) - Specified by:
setContentLengthLong
in interfacejakarta.servlet.ServletResponse
-
setContentType
- Specified by:
setContentType
in interfacejakarta.servlet.ServletResponse
-
setBufferSize
public void setBufferSize(int size) - Specified by:
setBufferSize
in interfacejakarta.servlet.ServletResponse
-
getBufferSize
public int getBufferSize()- Specified by:
getBufferSize
in interfacejakarta.servlet.ServletResponse
-
flushBuffer
- Specified by:
flushBuffer
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
resetBuffer
public void resetBuffer()- Specified by:
resetBuffer
in interfacejakarta.servlet.ServletResponse
-
isCommitted
public boolean isCommitted()- Specified by:
isCommitted
in interfacejakarta.servlet.ServletResponse
-
reset
public void reset()- Specified by:
reset
in interfacejakarta.servlet.ServletResponse
-
setLocale
- Specified by:
setLocale
in interfacejakarta.servlet.ServletResponse
-
getLocale
- Specified by:
getLocale
in interfacejakarta.servlet.ServletResponse
-
addCookie
public void addCookie(jakarta.servlet.http.Cookie cookie) - Specified by:
addCookie
in interfacejakarta.servlet.http.HttpServletResponse
-
containsHeader
- Specified by:
containsHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeURL
- Specified by:
encodeURL
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeRedirectURL
- Specified by:
encodeRedirectURL
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeUrl
- Specified by:
encodeUrl
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeRedirectUrl
- Specified by:
encodeRedirectUrl
in interfacejakarta.servlet.http.HttpServletResponse
-
sendError
- Specified by:
sendError
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
sendError
- Specified by:
sendError
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
sendRedirect
- Specified by:
sendRedirect
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
setDateHeader
- Specified by:
setDateHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addDateHeader
- Specified by:
addDateHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setHeader
- Specified by:
setHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addHeader
- Specified by:
addHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setIntHeader
- Specified by:
setIntHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addIntHeader
- Specified by:
addIntHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setStatus
public void setStatus(int sc) - Specified by:
setStatus
in interfacejakarta.servlet.http.HttpServletResponse
-
setStatus
- Specified by:
setStatus
in interfacejakarta.servlet.http.HttpServletResponse
-
getStatus
public int getStatus()- Specified by:
getStatus
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeader
- Specified by:
getHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeaders
- Specified by:
getHeaders
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeaderNames
- Specified by:
getHeaderNames
in interfacejakarta.servlet.http.HttpServletResponse
-
setTrailerFields
- Specified by:
setTrailerFields
in interfacejakarta.servlet.http.HttpServletResponse
-
getTrailerFields
- Specified by:
getTrailerFields
in interfacejakarta.servlet.http.HttpServletResponse
-
toJavaxServletResponse
public javax.servlet.ServletResponse toJavaxServletResponse()- Specified by:
toJavaxServletResponse
in interfaceServletResponseWrapper.JakartaServletResponseWrapper
-
toJavaxHttpServletResponse
public javax.servlet.http.HttpServletResponse toJavaxHttpServletResponse()- Specified by:
toJavaxHttpServletResponse
in interfaceHttpServletResponseWrapper.JakartaHttpServletResponseWrapper
-
toStaplerResponse
- Specified by:
toStaplerResponse
in interfaceStaplerResponse.StaplerResponse2Wrapper
-