Package org.kohsuke.stapler

Class ResponseImpl

java.lang.Object

jakarta.servlet.ServletResponseWrapper

jakarta.servlet.http.HttpServletResponseWrapper

org.kohsuke.stapler.ResponseImpl

All Implemented Interfaces:

jakarta.servlet.http.HttpServletResponse, jakarta.servlet.ServletResponse, StaplerResponse2

public class ResponseImpl
extends jakarta.servlet.http.HttpServletResponseWrapper
implements StaplerResponse2

StaplerResponse2 implementation.

Author:

Kohsuke Kawaguchi

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

Constructors

Constructor	Description
ResponseImpl(Stapler stapler, jakarta.servlet.http.HttpServletResponse response)
ResponseImpl(Stapler stapler, javax.servlet.http.HttpServletResponse response)	Deprecated. use ResponseImpl(Stapler, HttpServletResponse)

Method Summary

Modifier and Type	Method	Description
static String	encode(String s)	Escapes non-ASCII characters.
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.)
OutputStream	getCompressedOutputStream(jakarta.servlet.http.HttpServletRequest req)
Writer	getCompressedWriter(jakarta.servlet.http.HttpServletRequest req)
net.sf.json.JsonConfig	getJsonConfig()	The JsonConfig to be used when serializing java beans to JSON previously set by StaplerResponse2.setJsonConfig(JsonConfig).
jakarta.servlet.ServletOutputStream	getOutputStream()
PrintWriter	getWriter()
int	reverseProxyTo(URL url, StaplerRequest2 req)	Performs the reverse proxy to the given URL.
void	sendRedirect(int statusCode, String url)	Works like StaplerResponse2.sendRedirect2(String) but allows the caller to specify the HTTP status code.
void	sendRedirect(String url)
void	sendRedirect2(String url)	Works like HttpServletResponse.sendRedirect(String) except that this method escapes the URL.
void	serveExposedBean(StaplerRequest2 req, Object exposedBean, ExportConfig config)	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 req, URL resource)	Serves a static resource.
void	serveFile(StaplerRequest2 req, URL resource, long expiration)
void	serveLocalizedFile(StaplerRequest2 request, URL res)	Works like StaplerResponse2.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 like StaplerResponse2.serveFile(StaplerRequest2, URL, long) but chooses the locale specific version of the resource if it's available.
void	setJsonConfig(net.sf.json.JsonConfig config)	The JsonConfig to be used when serializing java beans from js bound methods to JSON.

Methods inherited from class jakarta.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, setDateHeader, setHeader, setIntHeader, setStatus, setStatus, setTrailerFields

Methods inherited from class jakarta.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletResponse

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, getTrailerFields, sendError, sendError, setDateHeader, setHeader, setIntHeader, setStatus, setStatus, setTrailerFields

Methods inherited from interface jakarta.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

Constructor Details

ResponseImpl

public ResponseImpl(Stapler stapler,
 jakarta.servlet.http.HttpServletResponse response)

ResponseImpl

@Deprecated
public ResponseImpl(Stapler stapler,
 javax.servlet.http.HttpServletResponse response)

Deprecated.

use ResponseImpl(Stapler, HttpServletResponse)

Method Details

getOutputStream

public jakarta.servlet.ServletOutputStream getOutputStream()
                                                    throws IOException

Specified by:

getOutputStream in interface jakarta.servlet.ServletResponse

Overrides:

getOutputStream in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface jakarta.servlet.ServletResponse

Overrides:

getWriter in class jakarta.servlet.ServletResponseWrapper

Throws:

IOException

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 interface StaplerResponse2

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 interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

sendRedirect

public void sendRedirect(@NonNull
 String url)
                  throws IOException

Specified by:

sendRedirect in interface jakarta.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class jakarta.servlet.http.HttpServletResponseWrapper

Throws:

IOException

sendRedirect2

public void sendRedirect2(@NonNull
 String url)
                   throws IOException

Description copied from interface: StaplerResponse2

Works like HttpServletResponse.sendRedirect(String) except that this method escapes the URL.

Specified by:

sendRedirect2 in interface StaplerResponse2

Throws:

IOException

sendRedirect

public void sendRedirect(int statusCode,
 @NonNull
 String url)
                  throws IOException

Description copied from interface: StaplerResponse2

Works like StaplerResponse2.sendRedirect2(String) but allows the caller to specify the HTTP status code.

Specified by:

sendRedirect in interface StaplerResponse2

Throws:

IOException

serveFile

public void serveFile(StaplerRequest2 req,
 URL resource,
 long expiration)
               throws jakarta.servlet.ServletException,
IOException

Specified by:

serveFile in interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

serveFile

public void serveFile(StaplerRequest2 req,
 URL resource)
               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 interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

serveLocalizedFile

public void serveLocalizedFile(StaplerRequest2 request,
 URL res)
                        throws jakarta.servlet.ServletException,
IOException

Description copied from interface: StaplerResponse2

Works like StaplerResponse2.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 for foo.html would be named foo_ja.html.

Specified by:

serveLocalizedFile in interface StaplerResponse2

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 like StaplerResponse2.serveFile(StaplerRequest2, URL, long) but chooses the locale specific version of the resource if it's available. See StaplerResponse2.serveLocalizedFile(StaplerRequest2, URL) for more details.

Specified by:

serveLocalizedFile in interface StaplerResponse2

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 interface StaplerResponse2

data - InputStream that contains the data of the static resource.

lastModified - The timestamp when the resource was last modified. See URLConnection.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 interface StaplerResponse2

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 interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• StaplerResponse2.serveFile(StaplerRequest2, InputStream, long, long, int, String)

serveFile

public void serveFile(StaplerRequest2 req,
 InputStream data,
 long lastModified,
 int contentLength,
 String fileName)
               throws jakarta.servlet.ServletException,
IOException

Specified by:

serveFile in interface StaplerResponse2

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 in Model.writeTo(Object,int,DataWriter).

As of 1.146, the tree parameter may be used to control the output in detail; see NamedPathPruner(String) for details.

Specified by:

serveExposedBean in interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

serveExposedBean

public void serveExposedBean(StaplerRequest2 req,
 Object exposedBean,
 ExportConfig config)
                      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 in Model.writeTo(Object,int,DataWriter)

As of 1.146, the tree parameter may be used to control the output in detail; see NamedPathPruner(String) for details.

ExportConfig is passed by the caller to control serialization behavior

Specified by:

serveExposedBean in interface StaplerResponse2

Throws:

jakarta.servlet.ServletException

IOException

getCompressedOutputStream

public OutputStream getCompressedOutputStream(jakarta.servlet.http.HttpServletRequest req)
                                       throws IOException

Specified by:

getCompressedOutputStream in interface StaplerResponse2

Throws:

IOException

getCompressedWriter

public Writer getCompressedWriter(jakarta.servlet.http.HttpServletRequest req)
                           throws IOException

Specified by:

getCompressedWriter in interface StaplerResponse2

Throws:

IOException

reverseProxyTo

public int reverseProxyTo(URL url,
 StaplerRequest2 req)
                   throws IOException

Description copied from interface: StaplerResponse2

Performs the reverse proxy to the given URL.

Specified by:

reverseProxyTo in interface StaplerResponse2

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 interface StaplerResponse2

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 by StaplerResponse2.setJsonConfig(JsonConfig). Will return the default config if nothing has previously been set.

Specified by:

getJsonConfig in interface StaplerResponse2

Returns:

the config

encode

@NonNull
public static String encode(@NonNull
 String s)

Escapes non-ASCII characters.