Defines additional parameters/operations made available by Stapler.

Gets the Stapler instance that this belongs to.

Returns the additional URL portion that wasn't used by the stapler, excluding the query string.

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.

Returns the same thing as getRestOfPath() but in the pre-decoded form, so all "%HH"s as present in the request URL is intact.

Returns the javax.servlet.ServletContext object given to the stapler dispatcher servlet.

Gets the javax.servlet.RequestDispatcher that represents a specific view for the given object. This support both JSP and Jelly.

Gets the javax.servlet.RequestDispatcher that represents a specific view for the given class.

Unlike getView(java.lang.Object,java.lang.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.

Gets the part of the request URL from protocol up to the context path. So typically it's something like http://foobar:8080/something

Gets the referer header (like "http://foobar.com/zot") or null. This is just a convenience method.

Returns a list of ancestor objects that lead to the "it" object. The returned list contains 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:

1. the root object
2. root.getFoo() object
3. root.getFoo().getBar("zot") object (the "it" object)

Finds the nearest ancestor that has the object of the given type, or null if not found.

Short for findAncestor(type).getObject(), with proper handling for null de-reference. This version is also type safe.

Finds the nearest ancestor whose Ancestor.getObject() matches the given object.

Short for getParameter(name)!=nulll

Gets the request URI of the original request, so that you can access the value even from JSP.

Checks "If-Modified-Since" header and returns false if the resource needs to be served.

This method can behave in three ways.

1. If timestampOfResource is 0 or negative, this method just returns false.
2. If "If-Modified-Since" header is sent and if it's bigger than timestampOfResource, then this method sets javax.servlet.http.HttpServletResponse.SC_NOT_MODIFIED as the response code and returns true.
3. Otherwise, "Last-Modified" header is added with timestampOfResource value, and this method returns false.

This method sends out the "Expires" header to force browser to re-validate all the time.

Binds form parameters to a bean by using introspection. For example, if there's a parameter called 'foo' that has value 'abc', then bean.setFoo('abc') will be invoked. This will be repeated for all parameters. Parameters that do not have corresponding setters will be simply ignored.

Values are converted into the right type. See org.apache.commons.beanutils.ConvertUtils.convert(java.lang.String,java.lang.Class).

Binds form parameters to a bean by using introspection. This method works like bindParameters(java.lang.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").

Binds collection form parameters to beans by using introspection or constructor parameters injection.

This method works like bindParameters(java.lang.Object,java.lang.String) and bindParameters(java.lang.Class,java.lang.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".)

Instanciates a new object by injecting constructor parameters from the form parameters.

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")).

Works like bindParameters(java.lang.Class,java.lang.String) but uses n-th value of all the parameters.

This is useful for creating multiple instances from repeated form fields.

Data-bind from a net.sf.json.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 {
   @DataBoundConstructor
   public Foo(Integer x, String y, boolean z, Bar bar) { ... }
 }

 class Bar {
   @DataBoundConstructor
   public Bar(int x, int y) {}
 }
 

... and if JSONObject looks like

{ y:"text", z:true, bar:{x:1,y:2}}

then, this method returns

new Foo(null,"text",true,new Bar(1,2))

Sub-typing

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.

Data-binds from net.sf.json.JSONObject to the given object.

This method is bit like bindJSON(java.lang.Class,net.sf.json.JSONObject), except that this method populates an existing object, instead of creating a new instance.

This method is also bit like bindParameters(java.lang.Object,java.lang.String), in that it populates an existing object from a form submission, except that this method obtains data from net.sf.json.JSONObject thus more structured, whereas bindParameters(java.lang.Object,java.lang.String) uses the map structure of the form submission.

Data-bind from either net.sf.json.JSONObject or net.sf.json.JSONArray to a list, by using bindJSON(java.lang.Class,net.sf.json.JSONObject) as the lower-level mechanism.

If the source is net.sf.json.JSONObject, the returned list will contain a single item. If it is net.sf.json.JSONArray, each item will be bound. If it is null, then the list will be empty.

Gets the content of the structured form submission.

Obtains a commons-fileupload object that represents an uploaded file.