public interface StaplerRequest
extends javax.servlet.http.HttpServletRequest
Stapler.getCurrentRequest()
Modifier and Type | Method and Description |
---|---|
<T> T |
bindJSON(java.lang.Class<T> type,
net.sf.json.JSONObject src)
Data-bind from a
JSONObject to the given target type,
by using introspection or constructor parameters injection. |
void |
bindJSON(java.lang.Object bean,
net.sf.json.JSONObject src)
Data-binds from
JSONObject to the given object. |
<T> T |
bindJSON(java.lang.reflect.Type genericType,
java.lang.Class<T> erasure,
java.lang.Object json)
Data-bind from one of the JSON object types (
JSONObject , JSONArray ,
String , Integer , and so on) to the expected type given as an argument. |
<T> java.util.List<T> |
bindJSONToList(java.lang.Class<T> type,
java.lang.Object src)
Data-bind from either
JSONObject or JSONArray to a list,
by using bindJSON(Class, JSONObject) as the lower-level mechanism. |
<T> T |
bindParameters(java.lang.Class<T> type,
java.lang.String prefix)
Instanciates a new object by injecting constructor parameters from the form parameters.
|
<T> T |
bindParameters(java.lang.Class<T> type,
java.lang.String prefix,
int index)
Works like
bindParameters(Class, String) but uses n-th value
of all the parameters. |
void |
bindParameters(java.lang.Object bean)
Binds form parameters to a bean by using introspection.
|
void |
bindParameters(java.lang.Object bean,
java.lang.String prefix)
Binds form parameters to a bean by using introspection.
|
<T> java.util.List<T> |
bindParametersToList(java.lang.Class<T> type,
java.lang.String prefix)
Binds collection form parameters to beans by using introspection or
constructor parameters injection.
|
boolean |
checkIfModified(java.util.Calendar timestampOfResource,
StaplerResponse rsp) |
boolean |
checkIfModified(java.util.Date timestampOfResource,
StaplerResponse rsp) |
boolean |
checkIfModified(long timestampOfResource,
StaplerResponse rsp)
Checks "If-Modified-Since" header and returns false
if the resource needs to be served.
|
boolean |
checkIfModified(long timestampOfResource,
StaplerResponse rsp,
long expiration) |
java.lang.String |
createJavaScriptProxy(java.lang.Object toBeExported)
Exports the given Java object as a JavaScript proxy and returns a JavaScript expression to create
a proxy on the client side.
|
Ancestor |
findAncestor(java.lang.Class type)
Finds the nearest ancestor that has the object of the given type, or null if not found.
|
Ancestor |
findAncestor(java.lang.Object o)
Finds the nearest ancestor whose
Ancestor.getObject() matches the given object. |
<T> T |
findAncestorObject(java.lang.Class<T> type)
Short for
findAncestor(type).getObject() , with proper handling for null de-reference. |
java.util.List<Ancestor> |
getAncestors()
Returns a list of ancestor objects that lead to the "it" object.
|
BindInterceptor |
getBindInterceptor()
Gets the
BindInterceptor set for this request. |
BoundObjectTable |
getBoundObjectTable()
Short cut for obtaining
BoundObjectTable associated with this webapp. |
org.apache.commons.fileupload.FileItem |
getFileItem(java.lang.String name)
Obtains a commons-fileupload object that represents an uploaded file.
|
java.lang.String |
getOriginalRequestURI()
Gets the
request URI
of the original request, so that you can access the value even from
JSP. |
java.lang.String |
getOriginalRestOfPath()
Returns the same thing as
getRestOfPath() but in the pre-decoded form,
so all "%HH"s as present in the request URL is intact. |
java.lang.String |
getReferer()
Gets the referer header (like "http://foobar.com/zot") or null.
|
java.lang.String |
getRestOfPath()
Returns the additional URL portion that wasn't used by the stapler,
excluding the query string.
|
java.lang.String |
getRootPath()
Gets the part of the request URL from protocol up to the context path.
|
javax.servlet.ServletContext |
getServletContext()
Returns the
ServletContext object given to the stapler
dispatcher servlet. |
Stapler |
getStapler()
Gets the
Stapler instance that this belongs to. |
net.sf.json.JSONObject |
getSubmittedForm()
Gets the content of the structured form submission.
|
javax.servlet.RequestDispatcher |
getView(java.lang.Class clazz,
java.lang.String viewName)
Convenience method to call
getView(Klass, String) with Class . |
javax.servlet.RequestDispatcher |
getView(Klass<?> clazz,
java.lang.String viewName)
Gets the
RequestDispatcher that represents a specific view
for the given class. |
javax.servlet.RequestDispatcher |
getView(java.lang.Object it,
java.lang.String viewName)
Gets the
RequestDispatcher that represents a specific view
for the given object. |
WebApp |
getWebApp()
Short for
getStapler().getWebApp() |
boolean |
hasParameter(java.lang.String name)
Short for
getParameter(name)!=null |
boolean |
isJavaScriptProxyCall()
Returns true if this request represents a server method call to a JavaScript proxy object.
|
BindInterceptor |
setBindListener(BindInterceptor bindListener) |
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
WebApp getWebApp()
getStapler().getWebApp()
java.lang.String getRestOfPath()
For example, if the requested URL is "foo/bar/zot/abc?def=ghi" and "foo/bar" portion matched bar.jsp, this method returns "/zot/abc".
If this method is invoked from getters or StaplerProxy.getTarget()
during the object traversal, this method returns the path portion
that is not yet processed.
java.lang.String getOriginalRestOfPath()
getRestOfPath()
but in the pre-decoded form,
so all "%HH"s as present in the request URL is intact.javax.servlet.ServletContext getServletContext()
ServletContext
object given to the stapler
dispatcher servlet.javax.servlet.RequestDispatcher getView(java.lang.Object it, java.lang.String viewName) throws java.io.IOException
RequestDispatcher
that represents a specific view
for the given object.
This support both JSP and Jelly.viewName
- If this name is relative name like "foo.jsp" or "bar/zot.jelly",
then the corresponding "side file" is searched by this name.
For Jelly, this also accepts absolute path name that starts with '/', such as "/foo/bar/zot.jelly". In this case, it.getClass().getClassLoader() is searched for this script.
java.io.IOException
javax.servlet.RequestDispatcher getView(java.lang.Class clazz, java.lang.String viewName) throws java.io.IOException
getView(Klass, String)
with Class
.java.io.IOException
javax.servlet.RequestDispatcher getView(Klass<?> clazz, java.lang.String viewName) throws java.io.IOException
RequestDispatcher
that represents a specific view
for the given class.
Unlike getView(Object, String)
, calling this request dispatcher
doesn't set the "it" variable, so
getView(it.getClass(),viewName)
and getView(it,viewName)
aren't the same thing.
java.io.IOException
java.lang.String getRootPath()
java.lang.String getReferer()
java.util.List<Ancestor> getAncestors()
Ancestor
objects sorted in the
order from root to the "it" object.
For example, if the URL was "foo/bar/zot" and the "it" object
was determined as root.getFoo().getBar("zot")
,
then this list will contain the following 3 objects in this order:
Ancestor
s. Can be empty, but always non-null.Ancestor findAncestor(java.lang.Class type)
<T> T findAncestorObject(java.lang.Class<T> type)
findAncestor(type).getObject()
, with proper handling for null de-reference.
This version is also type safe.Ancestor findAncestor(java.lang.Object o)
Ancestor.getObject()
matches the given object.boolean hasParameter(java.lang.String name)
getParameter(name)!=null
java.lang.String getOriginalRequestURI()
request URI
of the original request, so that you can access the value even from
JSP.boolean checkIfModified(long timestampOfResource, StaplerResponse rsp)
This method can behave in three ways.
HttpServletResponse.SC_NOT_MODIFIED
as the response code
and returns true.
This method sends out the "Expires" header to force browser to re-validate all the time.
timestampOfResource
- The time stamp of the resource.rsp
- This object is updated accordingly to simplify processing.HttpServletResponse.SC_NOT_MODIFIED
.boolean checkIfModified(java.util.Date timestampOfResource, StaplerResponse rsp)
boolean checkIfModified(java.util.Calendar timestampOfResource, StaplerResponse rsp)
boolean checkIfModified(long timestampOfResource, StaplerResponse rsp, long expiration)
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.checkIfModified(long, StaplerResponse)
void bindParameters(java.lang.Object bean)
Values are converted into the right type. See ConvertUtils.convert(String, Class)
.
bean
- The object which will be filled out.BeanUtils.setProperty(Object, String, Object)
void bindParameters(java.lang.Object bean, java.lang.String prefix)
bindParameters(Object)
, but it performs a
pre-processing on property names. Namely, only property names that start
with the given prefix will be used for binding, and only the portion of the
property name after the prefix is used.
So for example, if the prefix is "foo.", then property name "foo.bar" with value
"zot" will invoke bean.setBar("zot").<T> java.util.List<T> bindParametersToList(java.lang.Class<T> type, java.lang.String prefix)
This method works like bindParameters(Object,String)
and
bindParameters(Class, String)
, but it assumes
that form parameters have multiple-values, and use individual values to
fill in multiple beans.
For example, if getParameterValues("foo")=={"abc","def"} and getParameterValues("bar")=={"5","3"}, then this method will return two objects (the first with "abc" and "5", the second with "def" and "3".)
type
- Type of the bean to be created. This class must have the default no-arg
constructor.prefix
- See bindParameters(Object, String)
for details.<T> T bindParameters(java.lang.Class<T> type, java.lang.String prefix)
The given class must have a constructor annotated with '@stapler-constructor', and must be processed by the maven-stapler-plugin, so that the parameter names of the constructor is available at runtime.
The prefix is used to control the form parameter name. For example,
if the prefix is "foo." and if the constructor is define as
Foo(String a, String b)
, then the constructor will be invoked
as new Foo(getParameter("foo.a"),getParameter("foo.b"))
.
<T> T bindParameters(java.lang.Class<T> type, java.lang.String prefix, int index)
bindParameters(Class, String)
but uses n-th value
of all the parameters.
This is useful for creating multiple instances from repeated form fields.
<T> T bindJSON(java.lang.Class<T> type, net.sf.json.JSONObject src)
JSONObject
to the given target type,
by using introspection or constructor parameters injection.
For example, if you have a constructor that looks like the following:
class Foo { @... and if JSONObject looks likeDataBoundConstructor
public Foo(Integer x, String y, boolean z, Bar bar) { ... } } class Bar { @DataBoundConstructor
public Bar(int x, int y) {} }
{ y:"text", z:true, bar:{x:1,y:2}}then, this method returns
new Foo(null,"text",true,new Bar(1,2))
In the above example, a new instance of Bar was created, but you can also create a subtype of Bar by having the 'stapler-class' property in JSON like this:
class BarEx extends Bar {
@DataBoundConstructor
public BarEx(int a, int b, int c) {}
}
{ y:"text", z:true, bar: { stapler-class:"p.k.g.BarEx", a:1, b:2, c:3 } }
The type that shows up in the constructor (Bar in this case) can be an interface or an abstract class.
<T> T bindJSON(java.lang.reflect.Type genericType, java.lang.Class<T> erasure, java.lang.Object json)
JSONObject
, JSONArray
,
String
, Integer
, and so on) to the expected type given as an argument.genericType
- The generic type of the 'erasure' parameter.erasure
- The expected type to convert the JSON argument to.json
- One of the JSON value type.void bindJSON(java.lang.Object bean, net.sf.json.JSONObject src)
JSONObject
to the given object.
This method is bit like bindJSON(Class, JSONObject)
, except that this method
populates an existing object, instead of creating a new instance.
This method is also bit like bindParameters(Object, String)
, in that it
populates an existing object from a form submission, except that this method
obtains data from JSONObject
thus more structured, whereas bindParameters(Object, String)
uses the map structure of the form submission.
<T> java.util.List<T> bindJSONToList(java.lang.Class<T> type, java.lang.Object src)
JSONObject
or JSONArray
to a list,
by using bindJSON(Class, JSONObject)
as the lower-level mechanism.
If the source is JSONObject
, the returned list will contain
a single item. If it is JSONArray
, each item will be bound.
If it is null, then the list will be empty.
BindInterceptor getBindInterceptor()
BindInterceptor
set for this request.BindInterceptor setBindListener(BindInterceptor bindListener)
net.sf.json.JSONObject getSubmittedForm() throws javax.servlet.ServletException
javax.servlet.ServletException
org.apache.commons.fileupload.FileItem getFileItem(java.lang.String name) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
boolean isJavaScriptProxyCall()
BoundObjectTable getBoundObjectTable()
BoundObjectTable
associated with this webapp.java.lang.String createJavaScriptProxy(java.lang.Object toBeExported)
getBoundObjectTable().bind(toBeExported).getProxyScript()
Copyright © 2012. All Rights Reserved.