Package org.kohsuke.stapler

Class ResponseImpl

java.lang.Object
javax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
org.kohsuke.stapler.ResponseImpl
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, StaplerResponse
public class ResponseImpl extends javax.servlet.http.HttpServletResponseWrapper implements StaplerResponse
StaplerResponse implementation.
Author:
Kohsuke Kawaguchi

  • Field Summary

    Fields inherited from interface javax.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, javax.servlet.http.HttpServletResponse response)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    encode(String s)
    Escapes non-ASCII characters.
    void
    forward(Object it, String url, StaplerRequest request)
    Evaluates the url against the given object and forwards the request to the result.
    void
    forwardToPreviousPage(StaplerRequest request)
    Redirects the browser to where it came from (the referer.)
    OutputStream
    getCompressedOutputStream(javax.servlet.http.HttpServletRequest req)
     
    Writer
    getCompressedWriter(javax.servlet.http.HttpServletRequest req)
     
    net.sf.json.JsonConfig
    getJsonConfig()
    The JsonConfig to be used when serializing java beans to JSON previously set by StaplerResponse.setJsonConfig(JsonConfig).
    javax.servlet.ServletOutputStream
    getOutputStream()
     
    PrintWriter
    getWriter()
     
    int
    reverseProxyTo(URL url, StaplerRequest req)
    Performs the reverse proxy to the given URL.
    void
    sendRedirect(int statusCode, String url)
    Works like StaplerResponse.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(StaplerRequest req, Object exposedBean, ExportConfig config)
    Serves the exposed bean in the specified flavor.
    void
    serveExposedBean(StaplerRequest req, Object exposedBean, Flavor flavor)
    Serves the exposed bean in the specified flavor.
    void
    serveFile(StaplerRequest req, InputStream data, long lastModified, int contentLength, String fileName)
     
    void
    serveFile(StaplerRequest req, InputStream data, long lastModified, long expiration, int contentLength, String fileName)
     
    void
    serveFile(StaplerRequest req, InputStream data, long lastModified, long expiration, long contentLength, String fileName)
    Serves a static resource.
    void
    serveFile(StaplerRequest req, InputStream data, long lastModified, long contentLength, String fileName)
    Serves a static resource.
    void
    serveFile(StaplerRequest req, URL resource)
    Serves a static resource.
    void
    serveFile(StaplerRequest req, URL resource, long expiration)
     
    void
    serveLocalizedFile(StaplerRequest request, URL res)
    Works like StaplerResponse.serveFile(StaplerRequest, URL) but chooses the locale specific version of the resource if it's available.
    void
    serveLocalizedFile(StaplerRequest request, URL res, long expiration)
    Works like StaplerResponse.serveFile(StaplerRequest, 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 javax.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 javax.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 javax.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 javax.servlet.ServletResponse

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

  • Constructor Details

    • ResponseImpl

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

  • Method Details