|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StaplerResponse
Defines additional operations made available by Stapler.
Right now, there's none.
Stapler.getCurrentResponse()
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_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 |
Method Summary | |
---|---|
void |
forward(java.lang.Object it,
java.lang.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.) |
void |
sendRedirect2(java.lang.String url)
Works like HttpServletResponse.sendRedirect(String) except that this method
escapes the URL. |
void |
serveExposedBean(StaplerRequest req,
java.lang.Object exposedBean,
Flavor flavor)
Serves the exposed bean in the specified flavor. |
void |
serveFile(StaplerRequest req,
java.io.InputStream data,
long lastModified,
int contentLength,
java.lang.String fileName)
Serves a static resource. |
void |
serveFile(StaplerRequest req,
java.io.InputStream data,
long lastModified,
long expiration,
int contentLength,
java.lang.String fileName)
Serves a static resource. |
void |
serveFile(StaplerRequest request,
java.net.URL res)
Serves a static resource. |
void |
serveFile(StaplerRequest request,
java.net.URL res,
long expiration)
|
Methods inherited from interface javax.servlet.http.HttpServletResponse |
---|
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus |
Methods inherited from interface javax.servlet.ServletResponse |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale |
Method Detail |
---|
void forward(java.lang.Object it, java.lang.String url, StaplerRequest request) throws javax.servlet.ServletException, java.io.IOException
This can be used for example inside an action method to forward a request to a JSP.
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.
javax.servlet.ServletException
java.io.IOException
void forwardToPreviousPage(StaplerRequest request) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
void sendRedirect2(java.lang.String url) throws java.io.IOException
HttpServletResponse.sendRedirect(String)
except that this method
escapes the URL.
java.io.IOException
void serveFile(StaplerRequest request, java.net.URL res) throws javax.servlet.ServletException, java.io.IOException
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.
javax.servlet.ServletException
java.io.IOException
void serveFile(StaplerRequest request, java.net.URL res, long expiration) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
void serveFile(StaplerRequest req, java.io.InputStream data, long lastModified, long expiration, int contentLength, java.lang.String fileName) throws javax.servlet.ServletException, java.io.IOException
This method works like serveFile(StaplerRequest, URL)
but this version
allows the caller to fetch data from anywhere.
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.
javax.servlet.ServletException
java.io.IOException
void serveFile(StaplerRequest req, java.io.InputStream data, long lastModified, int contentLength, java.lang.String fileName) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
serveFile(StaplerRequest, InputStream, long, long, int, String)
void serveExposedBean(StaplerRequest req, java.lang.Object exposedBean, Flavor flavor) throws javax.servlet.ServletException, java.io.IOException
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.
javax.servlet.ServletException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |