* Stapler will invoke the designated constructor by using arguments from the corresponding - * {@link JSONObject} (in case of {@link StaplerRequest#bindJSON(Class, JSONObject)}) or request parameters - * (in case of {@link StaplerRequest#bindParameters(Class, String)}). + * {@link JSONObject} (in case of {@link StaplerRequest2#bindJSON(Class, JSONObject)}) or request parameters + * (in case of {@link StaplerRequest2#bindParameters(Class, String)}). * *
* The matching is done by using the constructor parameter name. Since this information is not available diff --git a/core/src/main/java/org/kohsuke/stapler/DataBoundResolvable.java b/core/src/main/java/org/kohsuke/stapler/DataBoundResolvable.java index b0723709e..a86821644 100644 --- a/core/src/main/java/org/kohsuke/stapler/DataBoundResolvable.java +++ b/core/src/main/java/org/kohsuke/stapler/DataBoundResolvable.java @@ -4,12 +4,12 @@ /** * For data-bound class (that has a constructor marked with {@link DataBoundConstructor}, the - * {@link #bindResolve(StaplerRequest, JSONObject)} allows an instance to replace the object + * {@link #bindResolve(StaplerRequest2, JSONObject)} allows an instance to replace the object * bound from submitted JSON object. * *
* This method is automatically invoked by Stapler during databinding method like - * {@link StaplerRequest#bindJSON(Class, JSONObject)}. + * {@link StaplerRequest2#bindJSON(Class, JSONObject)}. * *
* This method definition is inspired by Java serialization's {@code readResolve()} method. @@ -31,5 +31,5 @@ public interface DataBoundResolvable { * Can be any value, including null. Typically, this method would have to return an * instance of a type compatible to the caller's expectation. */ - Object bindResolve(StaplerRequest request, JSONObject src); + Object bindResolve(StaplerRequest2 request, JSONObject src); } diff --git a/core/src/main/java/org/kohsuke/stapler/DataBoundSetter.java b/core/src/main/java/org/kohsuke/stapler/DataBoundSetter.java index 7ed4c5930..7d0d2de03 100644 --- a/core/src/main/java/org/kohsuke/stapler/DataBoundSetter.java +++ b/core/src/main/java/org/kohsuke/stapler/DataBoundSetter.java @@ -11,8 +11,8 @@ /** * Designates a setter method or a field used to databind JSON values into objects in methods like - * {@link StaplerRequest#bindJSON(Class, JSONObject)} and - * {@link StaplerRequest#bindParameters(Class, String)}. + * {@link StaplerRequest2#bindJSON(Class, JSONObject)} and + * {@link StaplerRequest2#bindParameters(Class, String)}. * *
* Stapler will first invoke {@link DataBoundConstructor}-annotated constructor, and if there's any
diff --git a/core/src/main/java/org/kohsuke/stapler/DiagnosticThreadNameFilter.java b/core/src/main/java/org/kohsuke/stapler/DiagnosticThreadNameFilter.java
index 7cef9f850..1b72836b1 100644
--- a/core/src/main/java/org/kohsuke/stapler/DiagnosticThreadNameFilter.java
+++ b/core/src/main/java/org/kohsuke/stapler/DiagnosticThreadNameFilter.java
@@ -1,20 +1,20 @@
package org.kohsuke.stapler;
+import jakarta.servlet.Filter;
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.FilterConfig;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
import java.io.IOException;
-import javax.servlet.Filter;
-import javax.servlet.FilterChain;
-import javax.servlet.FilterConfig;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.HttpServletRequest;
/**
* {@link Filter} that sets the thread name to reflect the current request being processed.
*
* @author Kohsuke Kawaguchi
*/
-public class DiagnosticThreadNameFilter implements Filter {
+public class DiagnosticThreadNameFilter implements CompatibleFilter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {}
diff --git a/core/src/main/java/org/kohsuke/stapler/DirectoryishDispatcher.java b/core/src/main/java/org/kohsuke/stapler/DirectoryishDispatcher.java
index 9970c7088..3e7cd5404 100644
--- a/core/src/main/java/org/kohsuke/stapler/DirectoryishDispatcher.java
+++ b/core/src/main/java/org/kohsuke/stapler/DirectoryishDispatcher.java
@@ -1,10 +1,10 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ServletException;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.util.logging.Level;
import java.util.logging.Logger;
-import javax.servlet.ServletException;
/**
* {@link Dispatcher} that tells browsers to append '/' to the request path and try again.
diff --git a/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java b/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java
index e21a84060..e5237cf76 100644
--- a/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java
+++ b/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java
@@ -48,7 +48,7 @@ public interface DispatchValidator {
* @return true if the request should be dispatched, false if not, or null if unknown or neutral
*/
@CheckForNull
- Boolean isDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp);
+ Boolean isDispatchAllowed(@NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp);
/**
* Checks if the given request and response should be allowed to dispatch a view on an optionally present node
@@ -61,24 +61,24 @@ public interface DispatchValidator {
* @return true if the view should be allowed to dispatch, false if it should not, or null if unknown
*/
default @CheckForNull Boolean isDispatchAllowed(
- @NonNull StaplerRequest req,
- @NonNull StaplerResponse rsp,
+ @NonNull StaplerRequest2 req,
+ @NonNull StaplerResponse2 rsp,
@NonNull String viewName,
@CheckForNull Object node) {
return isDispatchAllowed(req, rsp);
}
/**
- * Allows the given request to be dispatched. Further calls to {@link #isDispatchAllowed(StaplerRequest, StaplerResponse)}
+ * Allows the given request to be dispatched. Further calls to {@link #isDispatchAllowed(StaplerRequest2, StaplerResponse2)}
* should return true for the same request.
*/
- void allowDispatch(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp);
+ void allowDispatch(@NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp);
/**
* Throws a {@link CancelRequestHandlingException} if the given request is not
- * {@linkplain #isDispatchAllowed(StaplerRequest, StaplerResponse) allowed}.
+ * {@linkplain #isDispatchAllowed(StaplerRequest2, StaplerResponse2) allowed}.
*/
- default void requireDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp)
+ default void requireDispatchAllowed(@NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp)
throws CancelRequestHandlingException {
Boolean allowed = isDispatchAllowed(req, rsp);
if (allowed == null || !allowed) {
@@ -91,12 +91,12 @@ default void requireDispatchAllowed(@NonNull StaplerRequest req, @NonNull Staple
*/
DispatchValidator DEFAULT = new DispatchValidator() {
@Override
- public Boolean isDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp) {
+ public Boolean isDispatchAllowed(@NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp) {
return true;
}
@Override
- public void allowDispatch(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp) {
+ public void allowDispatch(@NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp) {
// no-op
}
};
diff --git a/core/src/main/java/org/kohsuke/stapler/Dispatcher.java b/core/src/main/java/org/kohsuke/stapler/Dispatcher.java
index 17e52b5ee..6b5fd1f63 100644
--- a/core/src/main/java/org/kohsuke/stapler/Dispatcher.java
+++ b/core/src/main/java/org/kohsuke/stapler/Dispatcher.java
@@ -24,6 +24,7 @@
package org.kohsuke.stapler;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import jakarta.servlet.ServletException;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
@@ -31,7 +32,6 @@
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
-import javax.servlet.ServletException;
/**
* Controls the dispatching of incoming HTTP requests.
@@ -63,7 +63,7 @@ public static boolean traceable() {
return TRACE || TRACE_PER_REQUEST || LOGGER.isLoggable(Level.FINE);
}
- public static void traceEval(StaplerRequest req, StaplerResponse rsp, Object node) {
+ public static void traceEval(StaplerRequest2 req, StaplerResponse2 rsp, Object node) {
trace(
req,
rsp,
@@ -75,14 +75,14 @@ public static void traceEval(StaplerRequest req, StaplerResponse rsp, Object nod
}
public static void anonymizedTraceEval(
- StaplerRequest req, StaplerResponse rsp, Object node, String format, String... args) {
+ StaplerRequest2 req, StaplerResponse2 rsp, Object node, String format, String... args) {
List
+ * For example, if the requested URL is "foo/bar/zot/abc?def=ghi" and
+ * "foo/bar" portion matched {@code bar.jsp}, this method returns
+ * "/zot/abc".
+ *
+ *
+ * If this method is invoked from getters or {@link StaplerProxy#getTarget()}
+ * during the object traversal, this method returns the path portion
+ * that is not yet processed.
+ *
+ * @return
+ * can be empty string, but never null.
+ */
+ String getRestOfPath();
+
+ /**
+ * Returns the same thing as {@link #getRestOfPath()} but in the pre-decoded form,
+ * so all "%HH"s as present in the request URL is intact.
+ */
+ String getOriginalRestOfPath();
+
+ /**
+ * Returns the {@link ServletContext} object given to the stapler
+ * dispatcher servlet.
+ */
+ @Override
+ ServletContext getServletContext();
+
+ /**
+ * {@link #getRequestURI()} plus additional query string part, if it exists.
+ */
+ String getRequestURIWithQueryString();
+
+ /**
+ * {@link #getRequestURL()} plus additional query string part, if it exists.
+ */
+ StringBuffer getRequestURLWithQueryString();
+
+ /**
+ * Gets the {@link RequestDispatcher} that represents a specific view
+ * for the given object.
+ *
+ * This support both JSP and Jelly.
+ *
+ * @param 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,
+ * {@code it.getClass().getClassLoader()} is searched for this script.
+ *
+ * @return null
+ * if neither JSP nor Jelly is not found by the given name.
+ */
+ RequestDispatcher getView(Object it, String viewName) throws IOException;
+
+ /**
+ * Convenience method to call {@link #getView(Klass, String)} with {@link Class}.
+ */
+ RequestDispatcher getView(Class clazz, String viewName) throws IOException;
+
+ /**
+ * Gets the {@link RequestDispatcher} that represents a specific view
+ * for the given class.
+ *
+ *
+ * Unlike {@link #getView(Object, String)}, calling this request dispatcher
+ * doesn't set the "it" variable, so
+ * {@code getView(it.getClass(),viewName)} and {@code getView(it,viewName)}
+ * aren't the same thing.
+ */
+ RequestDispatcher getView(Klass clazz, String viewName) throws IOException;
+
+ /**
+ * Gets the part of the request URL from protocol up to the context path.
+ * So typically it's something like {@code http://foobar:8080/something}
+ */
+ String getRootPath();
+
+ /**
+ * Gets the referer header (like "http://foobar.com/zot") or null.
+ *
+ * This is just a convenience method.
+ */
+ String getReferer();
+
+ /**
+ * Returns a list of ancestor objects that lead to the "it" object.
+ * The returned list contains {@link 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
+ *
+ *
+ * @return
+ * list of {@link Ancestor}s. Can be empty, but always non-null.
+ */
+ List
+ * This method can behave in three ways.
+ *
+ *
+ * This method sends out the "Expires" header to force browser
+ * to re-validate all the time.
+ *
+ * @param timestampOfResource
+ * The time stamp of the resource.
+ * @param rsp
+ * This object is updated accordingly to simplify processing.
+ *
+ * @return
+ * false to indicate that the caller has to serve the actual resource.
+ * true to indicate that the caller should just quit processing right there
+ * (and send back {@link HttpServletResponse#SC_NOT_MODIFIED}.
+ */
+ boolean checkIfModified(long timestampOfResource, StaplerResponse2 rsp);
+
+ /**
+ * @see #checkIfModified(long, StaplerResponse2)
+ */
+ boolean checkIfModified(Date timestampOfResource, StaplerResponse2 rsp);
+
+ /**
+ * @see #checkIfModified(long, StaplerResponse2)
+ */
+ boolean checkIfModified(Calendar timestampOfResource, StaplerResponse2 rsp);
+
+ /**
+ * @param 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.
+ *
+ * @see #checkIfModified(long, StaplerResponse2)
+ */
+ boolean checkIfModified(long timestampOfResource, StaplerResponse2 rsp, long expiration);
+
+ /**
+ * Binds form parameters to a bean by using introspection.
+ *
+ * For example, if there's a parameter called 'foo' that has value 'abc',
+ * then {@code 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 {@link ConvertUtils#convert(String, Class)}.
+ *
+ * @see BeanUtils#setProperty(Object, String, Object)
+ *
+ * @param bean
+ * The object which will be filled out.
+ */
+ void bindParameters(Object bean);
+
+ /**
+ * Binds form parameters to a bean by using introspection.
+ *
+ * This method works like {@link #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 {@code bean.setBar("zot")}.
+ *
+ *
+ * @deprecated
+ * Instead of using prefix to group object among form parameter names,
+ * use structured form submission and {@link #bindJSON(Class, JSONObject)}.
+ */
+ @Deprecated
+ void bindParameters(Object bean, String prefix);
+
+ /**
+ * Binds collection form parameters to beans by using introspection or
+ * constructor parameters injection.
+ *
+ *
+ * This method works like {@link #bindParameters(Object,String)} and
+ * {@link #bindParameters(Class, String)}, but it assumes
+ * that form parameters have multiple-values, and use individual values to
+ * fill in multiple beans.
+ *
+ *
+ * For example, if {@code getParameterValues("foo")=={"abc","def"}}
+ * and {@code getParameterValues("bar")=={"5","3"}}, then this method will
+ * return two objects (the first with "abc" and "5", the second with
+ * "def" and "3".)
+ *
+ * @param type
+ * Type of the bean to be created. This class must have the default no-arg
+ * constructor.
+ *
+ * @param prefix
+ * See {@link #bindParameters(Object, String)} for details.
+ *
+ * @return
+ * Can be empty but never null.
+ *
+ *
+ * @deprecated
+ * Instead of using prefix to group object among form parameter names,
+ * use structured form submission and {@link #bindJSON(Class, JSONObject)}.
+ */
+ @Deprecated
+
+ * 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
+ *
+ * This is useful for creating multiple instances from repeated form fields.
+ *
+ *
+ * @deprecated
+ * Instead of using prefix to group object among form parameter names,
+ * use structured form submission and {@link #bindJSON(Class, JSONObject)}.
+ */
+ @Deprecated
+
+ * For example, if you have a constructor that looks like the following:
+ *
+ * Sub-typing: In the above example,
+ * a new instance of {@code Bar} was created,
+ * but you can also create a subtype of Bar by having the '$class' property in
+ * JSON like this:
+ *
+ *
+ * The type that shows up in the constructor ({@code Bar} in this case)
+ * can be an interface or an abstract class.
+ */
+
+ * This method is bit like {@link #bindJSON(Class, JSONObject)}, except that this method
+ * populates an existing object, instead of creating a new instance.
+ *
+ *
+ * This method is also bit like {@link #bindParameters(Object, String)}, in that it
+ * populates an existing object from a form submission, except that this method
+ * obtains data from {@link JSONObject} thus more structured, whereas {@link #bindParameters(Object, String)}
+ * uses the map structure of the form submission.
+ */
+ void bindJSON(Object bean, JSONObject src);
+
+ /**
+ * Data-bind from either {@link JSONObject} or {@link JSONArray} to a list,
+ * by using {@link #bindJSON(Class, JSONObject)} as the lower-level mechanism.
+ *
+ *
+ * If the source is {@link JSONObject}, the returned list will contain
+ * a single item. If it is {@link JSONArray}, each item will be bound.
+ * If it is null, then the list will be empty.
+ */
+
+ * This can be used for example inside an action method
+ * to forward a request to a JSP.
+ *
+ * @param it
+ * the URL is evaluated against this object. Must not be null.
+ * @param url
+ * the relative URL (e.g., "foo" or "foo/bar") to resolve
+ * against the "it" object.
+ * @param request
+ * Request to be forwarded.
+ */
+ void forward(Object it, String url, StaplerRequest2 request) throws ServletException, IOException;
+
+ /**
+ * Redirects the browser to where it came from (the referer.)
+ */
+ void forwardToPreviousPage(StaplerRequest2 request) throws ServletException, IOException;
+
+ /**
+ * Works like {@link #sendRedirect(String)} except that this method
+ * escapes the URL.
+ */
+ void sendRedirect2(@NonNull String url) throws IOException;
+
+ /**
+ * Works like {@link #sendRedirect2(String)} but allows the caller to specify the HTTP status code.
+ */
+ void sendRedirect(int statusCore, @NonNull String url) throws IOException;
+
+ /**
+ * 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.
+ */
+ void serveFile(StaplerRequest2 request, URL res) throws ServletException, IOException;
+
+ void serveFile(StaplerRequest2 request, URL res, long expiration) throws ServletException, IOException;
+
+ /**
+ * Works like {@link #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 {@code foo.html} would be named {@code foo_ja.html}.
+ */
+ void serveLocalizedFile(StaplerRequest2 request, URL res) throws ServletException, IOException;
+
+ /**
+ * Works like {@link #serveFile(StaplerRequest2, URL, long)} but chooses the locale
+ * specific version of the resource if it's available.
+ *
+ * See {@link #serveLocalizedFile(StaplerRequest2, URL)} for more details.
+ */
+ void serveLocalizedFile(StaplerRequest2 request, URL res, long expiration) throws ServletException, IOException;
+
+ /**
+ * Serves a static resource.
+ *
+ *
+ * This method works like {@link #serveFile(StaplerRequest2, URL)} but this version
+ * allows the caller to fetch data from anywhere.
+ *
+ * @param data
+ * {@link InputStream} that contains the data of the static resource.
+ * @param lastModified
+ * The timestamp when the resource was last modified. See {@link URLConnection#getLastModified()}
+ * for the meaning of the value. 0 if unknown, in which case "If-Modified-Since" handling
+ * will not be performed.
+ * @param 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.
+ * @param 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.
+ * @param 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.
+ */
+ void serveFile(
+ StaplerRequest2 req,
+ InputStream data,
+ long lastModified,
+ long expiration,
+ long contentLength,
+ String fileName)
+ throws ServletException, IOException;
+
+ /**
+ * @deprecated use form with long contentLength
+ */
+ @Deprecated
+ void serveFile(
+ StaplerRequest2 req,
+ InputStream data,
+ long lastModified,
+ long expiration,
+ int contentLength,
+ String fileName)
+ throws ServletException, IOException;
+
+ /**
+ * Serves a static resource.
+ *
+ * Expiration date is set to the value that forces browser to do conditional GET
+ * for all resources.
+ *
+ * @see #serveFile(StaplerRequest2, InputStream, long, long, int, String)
+ */
+ void serveFile(StaplerRequest2 req, InputStream data, long lastModified, long contentLength, String fileName)
+ throws ServletException, IOException;
+
+ /**
+ * @deprecated use form with long contentLength
+ */
+ @Deprecated
+ void serveFile(StaplerRequest2 req, InputStream data, long lastModified, int contentLength, String fileName)
+ throws ServletException, IOException;
+
+ /**
+ * 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 {@code jsonp} query parameter.
+ *
+ * The {@code depth} parameter may be used to specify a recursion depth
+ * as in {@link Model#writeTo(Object,int,DataWriter)}.
+ *
+ * As of 1.146, the {@code tree} parameter may be used to control the output
+ * in detail; see {@link NamedPathPruner#NamedPathPruner(String)} for details.
+ *
+ * @deprecated Use {@link #serveExposedBean(StaplerRequest2, Object, ExportConfig)}
+ */
+ @Deprecated
+ void serveExposedBean(StaplerRequest2 req, Object exposedBean, Flavor flavor) throws ServletException, IOException;
+
+ /**
+ * 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 {@code jsonp} query parameter.
+ *
+ * The {@code depth} parameter may be used to specify a recursion depth
+ * as in {@link Model#writeTo(Object,int,DataWriter)}
+ *
+ * As of 1.146, the {@code tree} parameter may be used to control the output
+ * in detail; see {@link NamedPathPruner#NamedPathPruner(String)} for details.
+ *
+ * {@link ExportConfig} is passed by the caller to control serialization behavior
+ * @since 1.251
+ */
+ default void serveExposedBean(StaplerRequest2 req, Object exposedBean, ExportConfig exportConfig)
+ throws ServletException, IOException {
+ serveExposedBean(req, exposedBean, exportConfig.getFlavor());
+ }
+
+ /**
+ * Works like {@link #getOutputStream()} but tries to send the response
+ * with gzip compression if the client supports it.
+ *
+ *
+ * This method is useful for sending out a large text content.
+ *
+ * @param req
+ * Used to determine whether the client supports compression
+ */
+ OutputStream getCompressedOutputStream(HttpServletRequest req) throws IOException;
+
+ /**
+ * Works like {@link #getCompressedOutputStream(HttpServletRequest)} but this
+ * method is for {@link #getWriter()}.
+ */
+ Writer getCompressedWriter(HttpServletRequest req) throws IOException;
+
+ /**
+ * Performs the reverse proxy to the given URL.
+ *
+ * @return
+ * The status code of the response.
+ */
+ int reverseProxyTo(URL url, StaplerRequest2 req) throws IOException;
+
+ /**
+ * 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.
+ *
+ * @param config the config
+ */
+ void setJsonConfig(JsonConfig config);
+
+ /**
+ * The JsonConfig to be used when serializing java beans to JSON previously set by {@link #setJsonConfig(JsonConfig)}.
+ * Will return the default config if nothing has previously been set.
+ *
+ * @return the config
+ */
+ JsonConfig getJsonConfig();
+}
diff --git a/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java b/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java
index da9cd671d..a54f28f7a 100644
--- a/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java
+++ b/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java
@@ -1,6 +1,10 @@
package org.kohsuke.stapler;
import edu.umd.cs.findbugs.annotations.NonNull;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletOutputStream;
+import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
@@ -9,25 +13,21 @@
import java.net.URL;
import java.util.Collection;
import java.util.Locale;
-import javax.servlet.ServletException;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.http.Cookie;
-import javax.servlet.http.HttpServletRequest;
import net.sf.json.JsonConfig;
import org.kohsuke.stapler.export.ExportConfig;
import org.kohsuke.stapler.export.Flavor;
/**
- * A basic wrapper for a StaplerResponse, e.g. in order to override some method.
+ * A basic wrapper for a StaplerResponse2, e.g. in order to override some method.
* This simply delegates all method calls to the wrapped instance.
*
* @since TODO
*/
@SuppressWarnings("deprecation")
-public abstract class StaplerResponseWrapper implements StaplerResponse {
- private final StaplerResponse wrapped;
+public abstract class StaplerResponseWrapper implements StaplerResponse2 {
+ private final StaplerResponse2 wrapped;
- public StaplerResponseWrapper(StaplerResponse wrapped) {
+ public StaplerResponseWrapper(StaplerResponse2 wrapped) {
this.wrapped = wrapped;
}
@@ -35,7 +35,7 @@ public StaplerResponseWrapper(StaplerResponse wrapped) {
* Returns the wrapped instance
*/
@NonNull
- public StaplerResponse getWrapped() {
+ public StaplerResponse2 getWrapped() {
return wrapped;
}
@@ -53,13 +53,13 @@ public PrintWriter getWriter() throws IOException {
/** {@inheritDoc} */
@Override
- public void forward(Object it, String url, StaplerRequest request) throws ServletException, IOException {
+ public void forward(Object it, String url, StaplerRequest2 request) throws ServletException, IOException {
getWrapped().forward(it, url, request);
}
/** {@inheritDoc} */
@Override
- public void forwardToPreviousPage(StaplerRequest request) throws ServletException, IOException {
+ public void forwardToPreviousPage(StaplerRequest2 request) throws ServletException, IOException {
getWrapped().forwardToPreviousPage(request);
}
@@ -83,25 +83,25 @@ public void sendRedirect(int statusCode, String url) throws IOException {
/** {@inheritDoc} */
@Override
- public void serveFile(StaplerRequest req, URL resource, long expiration) throws ServletException, IOException {
+ public void serveFile(StaplerRequest2 req, URL resource, long expiration) throws ServletException, IOException {
getWrapped().serveFile(req, resource, expiration);
}
/** {@inheritDoc} */
@Override
- public void serveFile(StaplerRequest req, URL resource) throws ServletException, IOException {
+ public void serveFile(StaplerRequest2 req, URL resource) throws ServletException, IOException {
getWrapped().serveFile(req, resource);
}
/** {@inheritDoc} */
@Override
- public void serveLocalizedFile(StaplerRequest request, URL res) throws ServletException, IOException {
+ public void serveLocalizedFile(StaplerRequest2 request, URL res) throws ServletException, IOException {
getWrapped().serveLocalizedFile(request, res);
}
/** {@inheritDoc} */
@Override
- public void serveLocalizedFile(StaplerRequest request, URL res, long expiration)
+ public void serveLocalizedFile(StaplerRequest2 request, URL res, long expiration)
throws ServletException, IOException {
getWrapped().serveLocalizedFile(request, res, expiration);
}
@@ -109,7 +109,7 @@ public void serveLocalizedFile(StaplerRequest request, URL res, long expiration)
/** {@inheritDoc} */
@Override
public void serveFile(
- StaplerRequest req,
+ StaplerRequest2 req,
InputStream data,
long lastModified,
long expiration,
@@ -122,7 +122,7 @@ public void serveFile(
/** {@inheritDoc} */
@Override
public void serveFile(
- StaplerRequest req,
+ StaplerRequest2 req,
InputStream data,
long lastModified,
long expiration,
@@ -134,31 +134,31 @@ public void serveFile(
/** {@inheritDoc} */
@Override
- public void serveFile(StaplerRequest req, InputStream data, long lastModified, long contentLength, String fileName)
+ public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, long contentLength, String fileName)
throws ServletException, IOException {
getWrapped().serveFile(req, data, lastModified, contentLength, fileName);
}
/** {@inheritDoc} */
@Override
- public void serveFile(StaplerRequest req, InputStream data, long lastModified, int contentLength, String fileName)
+ public void serveFile(StaplerRequest2 req, InputStream data, long lastModified, int contentLength, String fileName)
throws ServletException, IOException {
getWrapped().serveFile(req, data, lastModified, contentLength, fileName);
}
/**
- * @deprecated Use {@link #serveExposedBean(StaplerRequest, Object, ExportConfig)}
+ * @deprecated Use {@link #serveExposedBean(StaplerRequest2, Object, ExportConfig)}
*/
@Override
@Deprecated
- public void serveExposedBean(StaplerRequest req, Object exposedBean, Flavor flavor)
+ public void serveExposedBean(StaplerRequest2 req, Object exposedBean, Flavor flavor)
throws ServletException, IOException {
getWrapped().serveExposedBean(req, exposedBean, flavor);
}
/** {@inheritDoc} */
@Override
- public void serveExposedBean(StaplerRequest req, Object exposedBean, ExportConfig exportConfig)
+ public void serveExposedBean(StaplerRequest2 req, Object exposedBean, ExportConfig exportConfig)
throws ServletException, IOException {
getWrapped().serveExposedBean(req, exposedBean, exportConfig);
}
@@ -177,7 +177,7 @@ public Writer getCompressedWriter(HttpServletRequest req) throws IOException {
/** {@inheritDoc} */
@Override
- public int reverseProxyTo(URL url, StaplerRequest req) throws IOException {
+ public int reverseProxyTo(URL url, StaplerRequest2 req) throws IOException {
return getWrapped().reverseProxyTo(url, req);
}
diff --git a/core/src/main/java/org/kohsuke/stapler/StaticViewFacet.java b/core/src/main/java/org/kohsuke/stapler/StaticViewFacet.java
index eda84ed2c..e98258713 100644
--- a/core/src/main/java/org/kohsuke/stapler/StaticViewFacet.java
+++ b/core/src/main/java/org/kohsuke/stapler/StaticViewFacet.java
@@ -1,17 +1,17 @@
package org.kohsuke.stapler;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
import org.kohsuke.stapler.lang.Klass;
/**
diff --git a/core/src/main/java/org/kohsuke/stapler/WebApp.java b/core/src/main/java/org/kohsuke/stapler/WebApp.java
index 76381a30b..730a8e573 100644
--- a/core/src/main/java/org/kohsuke/stapler/WebApp.java
+++ b/core/src/main/java/org/kohsuke/stapler/WebApp.java
@@ -23,6 +23,9 @@
package org.kohsuke.stapler;
+import jakarta.servlet.Filter;
+import jakarta.servlet.ServletConfig;
+import jakarta.servlet.ServletContext;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.List;
@@ -31,9 +34,6 @@
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArrayList;
-import javax.servlet.Filter;
-import javax.servlet.ServletConfig;
-import javax.servlet.ServletContext;
import net.sf.json.JSONObject;
import org.kohsuke.stapler.bind.BoundObjectTable;
import org.kohsuke.stapler.event.FilteredDispatchTriggerListener;
@@ -74,10 +74,24 @@ public static WebApp get(ServletContext context) {
return (WebApp) o;
}
+ /**
+ * @deprecated use {@link #get(ServletContext)}
+ */
+ @Deprecated
+ public static WebApp get(javax.servlet.ServletContext context) {
+ return get(context.toJakartaServletContext());
+ }
+
+ /**
+ * @deprecated use {@link #getServletContext}
+ */
+ @Deprecated
+ public final javax.servlet.ServletContext context;
+
/**
* {@link ServletContext} for this webapp.
*/
- public final ServletContext context;
+ private final ServletContext servletContext;
/**
* @deprecated Unused?
@@ -100,7 +114,7 @@ public static WebApp get(ServletContext context) {
/**
* Global {@link BindInterceptor}s.
*
- * These are consulted after {@link StaplerRequest#getBindInterceptor()} is consulted.
+ * These are consulted after {@link StaplerRequest2#getBindInterceptor()} is consulted.
* Global bind interceptors are useful to register webapp-wide conversion logic local to the application.
* @since 1.220
*/
@@ -162,7 +176,8 @@ public static WebApp get(ServletContext context) {
private JsonInErrorMessageSanitizer jsonInErrorMessageSanitizer;
public WebApp(ServletContext context) {
- this.context = context;
+ this.servletContext = context;
+ this.context = context != null ? javax.servlet.ServletContext.fromJakartServletContext(context) : null;
// TODO: allow classloader to be given?
facets.addAll(Facet.discoverExtensions(
Facet.class,
@@ -176,11 +191,15 @@ public WebApp(ServletContext context) {
* sits at the root of the URL hierarchy and handles the request to '/'.
*/
public Object getApp() {
- return context.getAttribute("app");
+ return servletContext.getAttribute("app");
}
public void setApp(Object app) {
- context.setAttribute("app", app);
+ servletContext.setAttribute("app", app);
+ }
+
+ public ServletContext getServletContext() {
+ return servletContext;
}
public CrumbIssuer getCrumbIssuer() {
@@ -219,7 +238,7 @@ public
* On a web-bound {@code doXyz} method, use this annotation on a parameter to get the submitted
@@ -35,7 +35,7 @@
public @interface SubmittedForm {
class Handler extends AnnotationHandler {
@Override
- public Object parse(StaplerRequest request, Annotation a, Class type, String parameterName)
+ public Object parse(StaplerRequest2 request, Annotation a, Class type, String parameterName)
throws ServletException {
return request.getSubmittedForm();
}
diff --git a/core/src/main/java/org/kohsuke/stapler/package-info.java b/core/src/main/java/org/kohsuke/stapler/package-info.java
index 2ccc0942b..58ed54042 100644
--- a/core/src/main/java/org/kohsuke/stapler/package-info.java
+++ b/core/src/main/java/org/kohsuke/stapler/package-info.java
@@ -23,6 +23,6 @@
/**
* Stapler {@code URL} → {@code Object} mapping framework. The main entry points are {@link Stapler},
- * {@link StaplerRequest}, and {@link StaplerResponse}.
+ * {@link StaplerRequest2}, and {@link StaplerResponse2}.
*/
package org.kohsuke.stapler;
diff --git a/core/src/main/java/org/kohsuke/stapler/verb/HttpVerbInterceptor.java b/core/src/main/java/org/kohsuke/stapler/verb/HttpVerbInterceptor.java
index 7dbf6b3ce..cca31a6c7 100644
--- a/core/src/main/java/org/kohsuke/stapler/verb/HttpVerbInterceptor.java
+++ b/core/src/main/java/org/kohsuke/stapler/verb/HttpVerbInterceptor.java
@@ -1,11 +1,11 @@
package org.kohsuke.stapler.verb;
+import jakarta.servlet.ServletException;
import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
-import javax.servlet.ServletException;
import org.kohsuke.stapler.CancelRequestHandlingException;
-import org.kohsuke.stapler.StaplerRequest;
-import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.StaplerRequest2;
+import org.kohsuke.stapler.StaplerResponse2;
import org.kohsuke.stapler.interceptor.Interceptor;
import org.kohsuke.stapler.interceptor.InterceptorAnnotation;
@@ -42,7 +42,7 @@
*/
public class HttpVerbInterceptor extends Interceptor {
@Override
- public Object invoke(StaplerRequest request, StaplerResponse response, Object instance, Object[] arguments)
+ public Object invoke(StaplerRequest2 request, StaplerResponse2 response, Object instance, Object[] arguments)
throws IllegalAccessException, InvocationTargetException, ServletException {
if (matches(request)) {
return target.invoke(request, response, instance, arguments);
@@ -51,7 +51,7 @@ public Object invoke(StaplerRequest request, StaplerResponse response, Object in
}
}
- private boolean matches(StaplerRequest request) {
+ private boolean matches(StaplerRequest2 request) {
String method = request.getMethod();
for (Annotation a : target.getAnnotations()) {
diff --git a/core/src/test/java/org/kohsuke/stapler/AbstractStaplerTestBase.java b/core/src/test/java/org/kohsuke/stapler/AbstractStaplerTestBase.java
index e6da4b47b..2d5beecf5 100644
--- a/core/src/test/java/org/kohsuke/stapler/AbstractStaplerTestBase.java
+++ b/core/src/test/java/org/kohsuke/stapler/AbstractStaplerTestBase.java
@@ -1,10 +1,10 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ServletConfig;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
import java.util.ArrayList;
-import javax.servlet.ServletConfig;
-import javax.servlet.ServletContext;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
import junit.framework.TestCase;
import org.kohsuke.stapler.test.AbstractStaplerTest;
import org.mockito.Mockito;
diff --git a/core/src/test/java/org/kohsuke/stapler/AncestorImplTest.java b/core/src/test/java/org/kohsuke/stapler/AncestorImplTest.java
index dc29e2c5c..a3ce90f4f 100644
--- a/core/src/test/java/org/kohsuke/stapler/AncestorImplTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/AncestorImplTest.java
@@ -15,7 +15,7 @@ class Foo {
}
class Bar {
- public HttpResponse doZot(StaplerRequest req) {
+ public HttpResponse doZot(StaplerRequest2 req) {
assertEquals("testRestOfUrl/bar/zot", req.getAncestors().get(0).getRestOfUrl());
assertEquals("bar/zot", req.getAncestors().get(1).getRestOfUrl());
assertEquals("zot", req.getAncestors().get(2).getRestOfUrl());
diff --git a/core/src/test/java/org/kohsuke/stapler/ClassDescriptorTest.java b/core/src/test/java/org/kohsuke/stapler/ClassDescriptorTest.java
index ef1d31d9b..311c73bae 100644
--- a/core/src/test/java/org/kohsuke/stapler/ClassDescriptorTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/ClassDescriptorTest.java
@@ -5,6 +5,7 @@
import static org.junit.Assert.assertSame;
import static org.junit.Assert.fail;
+import jakarta.servlet.ServletException;
import java.io.IOException;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -12,7 +13,6 @@
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
-import javax.servlet.ServletException;
import org.junit.Test;
/**
@@ -97,7 +97,7 @@ public void inheritedWebMethods() {
new ClassDescriptor(Sub.class)
.methods
.name("doDynamic")
- .signature(StaplerRequest.class, StaplerResponse.class)
+ .signature(StaplerRequest2.class, StaplerResponse2.class)
.size());
}
@@ -117,7 +117,7 @@ private void methodWithManyParams(
private static void methodWithParams_static(String abc, long def, Object ghi) {}
protected abstract static class Super {
- public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {}
+ public void doDynamic(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException, ServletException {}
}
public static class Sub extends Super {}
diff --git a/core/src/test/java/org/kohsuke/stapler/DataBindingTest.java b/core/src/test/java/org/kohsuke/stapler/DataBindingTest.java
index 2f44fa16e..b739eadb8 100644
--- a/core/src/test/java/org/kohsuke/stapler/DataBindingTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/DataBindingTest.java
@@ -81,14 +81,14 @@ public String getContentType() {
mr.getParameterMap().put("b", "string");
RequestImpl req = new RequestImpl(new Stapler(), mr, Collections.emptyList(), null);
new Function.InstanceFunction(
- getClass().getMethod("doFromStaplerMethod", StaplerRequest.class, int.class, Binder.class))
+ getClass().getMethod("doFromStaplerMethod", StaplerRequest2.class, int.class, Binder.class))
.bindAndInvoke(this, req, null);
assertEquals(
42,
new Function.InstanceFunction(getClass().getMethod("doStaticMethod")).bindAndInvoke(this, req, null));
}
- public void doFromStaplerMethod(StaplerRequest req, @QueryParameter int a, Binder b) {
+ public void doFromStaplerMethod(StaplerRequest2 req, @QueryParameter int a, Binder b) {
assertEquals(123, a);
assertSame(req, b.req);
assertEquals("string", b.b);
@@ -99,11 +99,11 @@ public static int doStaticMethod() {
}
public static class Binder {
- StaplerRequest req;
+ StaplerRequest2 req;
String b;
@CapturedParameterNames({"req", "b"})
- public static Binder fromStapler(StaplerRequest req, @QueryParameter String b) {
+ public static Binder fromStapler(StaplerRequest2 req, @QueryParameter String b) {
Binder r = new Binder();
r.req = req;
r.b = b;
diff --git a/core/src/test/java/org/kohsuke/stapler/DispatcherTest.java b/core/src/test/java/org/kohsuke/stapler/DispatcherTest.java
index d115508ba..08b0aa9a7 100644
--- a/core/src/test/java/org/kohsuke/stapler/DispatcherTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/DispatcherTest.java
@@ -1,9 +1,9 @@
package org.kohsuke.stapler;
+import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
-import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.IOUtils;
import org.htmlunit.FailingHttpStatusCodeException;
import org.htmlunit.HttpMethod;
@@ -201,17 +201,17 @@ public void testInheritance() throws Exception {
public abstract class PutInheritance {
@WebMethod(name = "foo")
@PUT
- public abstract HttpResponse doBar(StaplerRequest req) throws IOException;
+ public abstract HttpResponse doBar(StaplerRequest2 req) throws IOException;
@POST
- public HttpResponse doAcme(StaplerRequest req) throws IOException {
+ public HttpResponse doAcme(StaplerRequest2 req) throws IOException {
return HttpResponses.text("POST: " + IOUtils.toString(req.getInputStream(), StandardCharsets.UTF_8));
}
}
public class PutInheritanceImpl extends PutInheritance {
@Override
- public HttpResponse doBar(StaplerRequest req) throws IOException {
+ public HttpResponse doBar(StaplerRequest2 req) throws IOException {
return HttpResponses.text(IOUtils.toString(req.getInputStream(), StandardCharsets.UTF_8) + " World!");
}
}
@@ -324,7 +324,7 @@ public void testRequirePostOnBase() throws Exception {
public void testOverloads() throws Exception {
TextPage p = createWebClient().getPage(new URL(url, "overloaded/x"));
- assertEquals("doX(StaplerRequest)", p.getContent());
+ assertEquals("doX(StaplerRequest2)", p.getContent());
}
public final Object overloaded = new Overloaded();
@@ -335,16 +335,16 @@ public HttpResponse doX() {
return HttpResponses.text("doX()");
}
- public HttpResponse doX(StaplerRequest req) {
- return HttpResponses.text("doX(StaplerRequest)");
+ public HttpResponse doX(StaplerRequest2 req) {
+ return HttpResponses.text("doX(StaplerRequest2)");
}
- public HttpResponse doX(StaplerResponse rsp) {
- return HttpResponses.text("doX(StaplerResponse)");
+ public HttpResponse doX(StaplerResponse2 rsp) {
+ return HttpResponses.text("doX(StaplerResponse2)");
}
- public HttpResponse doX(StaplerRequest req, StaplerResponse rsp) {
- return HttpResponses.text("doX(StaplerRequest, StaplerResponse)");
+ public HttpResponse doX(StaplerRequest2 req, StaplerResponse2 rsp) {
+ return HttpResponses.text("doX(StaplerRequest2, StaplerResponse2)");
}
@WebMethod(name = "x")
@@ -414,7 +414,7 @@ private TestClass getPrivate() {
public final StaplerProxyImpl staplerProxyFail = new StaplerProxyImpl(null);
public class IndexPage {
- public void doIndex(StaplerResponse rsp) {
+ public void doIndex(StaplerResponse2 rsp) {
throw HttpResponses.ok();
}
}
@@ -433,7 +433,7 @@ public Object getTarget() {
return target;
}
- public void doIndex(StaplerResponse rsp) {
+ public void doIndex(StaplerResponse2 rsp) {
if (target != this) {
throw new IllegalStateException("should not be called");
}
diff --git a/core/src/test/java/org/kohsuke/stapler/IndexHtmlDispatcherTest.java b/core/src/test/java/org/kohsuke/stapler/IndexHtmlDispatcherTest.java
index 11138e777..37c787fa5 100644
--- a/core/src/test/java/org/kohsuke/stapler/IndexHtmlDispatcherTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/IndexHtmlDispatcherTest.java
@@ -5,8 +5,8 @@
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
+import jakarta.servlet.ServletContext;
import java.net.MalformedURLException;
-import javax.servlet.ServletContext;
import org.junit.Test;
import org.jvnet.hudson.test.Issue;
diff --git a/core/src/test/java/org/kohsuke/stapler/MockRequest.java b/core/src/test/java/org/kohsuke/stapler/MockRequest.java
index 06dbaffcb..f1bbc8c2d 100644
--- a/core/src/test/java/org/kohsuke/stapler/MockRequest.java
+++ b/core/src/test/java/org/kohsuke/stapler/MockRequest.java
@@ -1,5 +1,19 @@
package org.kohsuke.stapler;
+import jakarta.servlet.AsyncContext;
+import jakarta.servlet.DispatcherType;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletInputStream;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpSession;
+import jakarta.servlet.http.HttpUpgradeHandler;
+import jakarta.servlet.http.Part;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
@@ -9,20 +23,6 @@
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
-import javax.servlet.AsyncContext;
-import javax.servlet.DispatcherType;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.ServletContext;
-import javax.servlet.ServletException;
-import javax.servlet.ServletInputStream;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
-import javax.servlet.http.Cookie;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import javax.servlet.http.HttpSession;
-import javax.servlet.http.HttpUpgradeHandler;
-import javax.servlet.http.Part;
/**
* @author Kohsuke Kawaguchi
diff --git a/core/src/test/java/org/kohsuke/stapler/MockServletContext.java b/core/src/test/java/org/kohsuke/stapler/MockServletContext.java
index c7d6650ea..ceff626fd 100644
--- a/core/src/test/java/org/kohsuke/stapler/MockServletContext.java
+++ b/core/src/test/java/org/kohsuke/stapler/MockServletContext.java
@@ -1,5 +1,16 @@
package org.kohsuke.stapler;
+import jakarta.servlet.Filter;
+import jakarta.servlet.FilterRegistration;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.Servlet;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRegistration;
+import jakarta.servlet.ServletRegistration.Dynamic;
+import jakarta.servlet.SessionCookieConfig;
+import jakarta.servlet.SessionTrackingMode;
+import jakarta.servlet.descriptor.JspConfigDescriptor;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
@@ -7,17 +18,6 @@
import java.util.EventListener;
import java.util.Map;
import java.util.Set;
-import javax.servlet.Filter;
-import javax.servlet.FilterRegistration;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.Servlet;
-import javax.servlet.ServletContext;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRegistration;
-import javax.servlet.ServletRegistration.Dynamic;
-import javax.servlet.SessionCookieConfig;
-import javax.servlet.SessionTrackingMode;
-import javax.servlet.descriptor.JspConfigDescriptor;
/**
* @author Kohsuke Kawaguchi
@@ -190,17 +190,18 @@ public ServletRegistration getServletRegistration(String servletName) {
}
@Override
- public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName, String className) {
+ public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, String className) {
return null;
}
@Override
- public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName, Filter filter) {
+ public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, Filter filter) {
return null;
}
@Override
- public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName, Class filterClass) {
+ public jakarta.servlet.FilterRegistration.Dynamic addFilter(
+ String filterName, Class filterClass) {
// TODO Auto-generated method stub
return null;
}
diff --git a/core/src/test/java/org/kohsuke/stapler/NestedJsonTest.java b/core/src/test/java/org/kohsuke/stapler/NestedJsonTest.java
index 0a0cf39d7..efe11b29d 100644
--- a/core/src/test/java/org/kohsuke/stapler/NestedJsonTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/NestedJsonTest.java
@@ -1,8 +1,8 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ServletException;
import java.util.Collections;
import java.util.List;
-import javax.servlet.ServletException;
import junit.framework.TestCase;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
diff --git a/core/src/test/java/org/kohsuke/stapler/RequestImplTest.java b/core/src/test/java/org/kohsuke/stapler/RequestImplTest.java
index a8062b735..20122dfdf 100644
--- a/core/src/test/java/org/kohsuke/stapler/RequestImplTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/RequestImplTest.java
@@ -25,6 +25,11 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ReadListener;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletInputStream;
+import jakarta.servlet.http.HttpServletRequest;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
@@ -34,11 +39,6 @@
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
-import javax.servlet.ReadListener;
-import javax.servlet.ServletContext;
-import javax.servlet.ServletException;
-import javax.servlet.ServletInputStream;
-import javax.servlet.http.HttpServletRequest;
import net.sf.json.JSONObject;
import org.apache.commons.fileupload2.core.FileItem;
import org.apache.http.entity.ContentType;
diff --git a/core/src/test/java/org/kohsuke/stapler/ResponseImplTest.java b/core/src/test/java/org/kohsuke/stapler/ResponseImplTest.java
index 6a8272d52..622326acc 100644
--- a/core/src/test/java/org/kohsuke/stapler/ResponseImplTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/ResponseImplTest.java
@@ -3,10 +3,10 @@
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
+import jakarta.servlet.ServletOutputStream;
+import jakarta.servlet.WriteListener;
+import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.WriteListener;
-import javax.servlet.http.HttpServletResponse;
import org.kohsuke.stapler.test.AbstractStaplerTest;
/**
diff --git a/core/src/test/java/org/kohsuke/stapler/ServletConfigImpl.java b/core/src/test/java/org/kohsuke/stapler/ServletConfigImpl.java
index 6c1f4b9f2..d951a3226 100644
--- a/core/src/test/java/org/kohsuke/stapler/ServletConfigImpl.java
+++ b/core/src/test/java/org/kohsuke/stapler/ServletConfigImpl.java
@@ -1,8 +1,8 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ServletConfig;
+import jakarta.servlet.ServletContext;
import java.util.Enumeration;
-import javax.servlet.ServletConfig;
-import javax.servlet.ServletContext;
/**
* @author Kohsuke Kawaguchi
diff --git a/core/src/test/java/org/kohsuke/stapler/Stapler2Test.java b/core/src/test/java/org/kohsuke/stapler/Stapler2Test.java
index 3bc8bbd2d..655cb395f 100644
--- a/core/src/test/java/org/kohsuke/stapler/Stapler2Test.java
+++ b/core/src/test/java/org/kohsuke/stapler/Stapler2Test.java
@@ -28,8 +28,8 @@
import static org.junit.Assert.assertThrows;
+import jakarta.servlet.http.HttpServletResponse;
import java.net.URL;
-import javax.servlet.http.HttpServletResponse;
import org.htmlunit.FailingHttpStatusCodeException;
import org.htmlunit.WebClient;
import org.jvnet.hudson.test.For;
diff --git a/core/src/test/java/org/kohsuke/stapler/bind/BoundObjectTableTest.java b/core/src/test/java/org/kohsuke/stapler/bind/BoundObjectTableTest.java
index 9813670cf..9c86b1acd 100644
--- a/core/src/test/java/org/kohsuke/stapler/bind/BoundObjectTableTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/bind/BoundObjectTableTest.java
@@ -4,7 +4,7 @@
import java.net.URL;
import org.htmlunit.TextPage;
import org.kohsuke.stapler.HttpResponse;
-import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.StaplerResponse2;
import org.kohsuke.stapler.test.JettyTestCase;
/**
@@ -32,7 +32,7 @@ public HelloWorld(String message) {
this.message = message;
}
- public void doIndex(StaplerResponse rsp) throws IOException {
+ public void doIndex(StaplerResponse2 rsp) throws IOException {
rsp.setContentType("text/plain;charset=UTF-8");
rsp.getWriter().write(message);
}
diff --git a/core/src/test/java/org/kohsuke/stapler/bind/JavaScriptProxyTest.java b/core/src/test/java/org/kohsuke/stapler/bind/JavaScriptProxyTest.java
index 63d450aac..17815c041 100644
--- a/core/src/test/java/org/kohsuke/stapler/bind/JavaScriptProxyTest.java
+++ b/core/src/test/java/org/kohsuke/stapler/bind/JavaScriptProxyTest.java
@@ -9,8 +9,8 @@
import org.htmlunit.html.HtmlPage;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
-import org.kohsuke.stapler.StaplerRequest;
-import org.kohsuke.stapler.StaplerResponse;
+import org.kohsuke.stapler.StaplerRequest2;
+import org.kohsuke.stapler.StaplerResponse2;
import org.kohsuke.stapler.WebApp;
import org.kohsuke.stapler.test.JettyTestCase;
@@ -72,7 +72,7 @@ public String jsFoo(int x, String y) {
return y + x;
}
- public void doIndex(StaplerRequest req, StaplerResponse rsp) throws IOException {
+ public void doIndex(StaplerRequest2 req, StaplerResponse2 rsp) throws IOException {
rsp.setContentType("text/html");
String crumb = req.getWebApp().getCrumbIssuer().issueCrumb();
PrintWriter w = rsp.getWriter();
@@ -83,7 +83,7 @@ public void doIndex(StaplerRequest req, StaplerResponse rsp) throws IOException
w.println(" {
/**
* Executes the given script on the given node and request, rendering output to the given response.
*/
- void execute(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp, @NonNull S script, @CheckForNull Object it)
+ void execute(
+ @NonNull StaplerRequest2 req, @NonNull StaplerResponse2 rsp, @NonNull S script, @CheckForNull Object it)
throws Exception;
}
diff --git a/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java b/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java
index 803122772..9c63b6562 100644
--- a/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java
+++ b/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java
@@ -27,13 +27,13 @@
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.ServletException;
-import javax.servlet.ServletRequest;
-import javax.servlet.ServletResponse;
/**
* Implements a RequestDispatcher for a given model node and view. Unlike dispatchers created through
@@ -91,8 +91,8 @@ private ScriptRequestDispatcher(
@Override
public void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException {
- StaplerRequest req = (StaplerRequest) request;
- StaplerResponse rsp = (StaplerResponse) response;
+ StaplerRequest2 req = (StaplerRequest2) request;
+ StaplerResponse2 rsp = (StaplerResponse2) response;
DispatchValidator validator = req.getWebApp().getDispatchValidator();
validator.allowDispatch(req, rsp);
try {
diff --git a/core/src/main/java/org/kohsuke/stapler/SelectionInterceptedFunction.java b/core/src/main/java/org/kohsuke/stapler/SelectionInterceptedFunction.java
index c1426796d..d8c1a6517 100644
--- a/core/src/main/java/org/kohsuke/stapler/SelectionInterceptedFunction.java
+++ b/core/src/main/java/org/kohsuke/stapler/SelectionInterceptedFunction.java
@@ -1,7 +1,7 @@
package org.kohsuke.stapler;
+import jakarta.servlet.ServletException;
import java.lang.reflect.InvocationTargetException;
-import javax.servlet.ServletException;
import org.kohsuke.stapler.interceptor.Interceptor;
import org.kohsuke.stapler.interceptor.InterceptorAnnotation;
@@ -21,7 +21,7 @@
}
@Override
- Object bindAndInvoke(Object o, StaplerRequest req, StaplerResponse rsp, Object... headArgs)
+ Object bindAndInvoke(Object o, StaplerRequest2 req, StaplerResponse2 rsp, Object... headArgs)
throws IllegalAccessException, InvocationTargetException, ServletException {
return interceptor.invoke(req, rsp, o, headArgs);
}
@@ -32,7 +32,7 @@ private static final class Adapter extends ForwardingFunction {
}
@Override
- public Object invoke(StaplerRequest req, StaplerResponse rsp, Object o, Object... args)
+ public Object invoke(StaplerRequest2 req, StaplerResponse2 rsp, Object o, Object... args)
throws IllegalAccessException, InvocationTargetException, ServletException {
return next.bindAndInvoke(o, req, rsp, args);
}
diff --git a/core/src/main/java/org/kohsuke/stapler/Stapler.java b/core/src/main/java/org/kohsuke/stapler/Stapler.java
index 68a2530a2..4dbdc8da2 100644
--- a/core/src/main/java/org/kohsuke/stapler/Stapler.java
+++ b/core/src/main/java/org/kohsuke/stapler/Stapler.java
@@ -24,6 +24,15 @@
package org.kohsuke.stapler;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.ServletConfig;
+import jakarta.servlet.ServletContext;
+import jakarta.servlet.ServletContextEvent;
+import jakarta.servlet.ServletContextListener;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
import java.io.DataInputStream;
import java.io.EOFException;
import java.io.File;
@@ -59,15 +68,6 @@
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-import javax.servlet.RequestDispatcher;
-import javax.servlet.ServletConfig;
-import javax.servlet.ServletContext;
-import javax.servlet.ServletContextEvent;
-import javax.servlet.ServletContextListener;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
import net.sf.json.JSONObject;
import org.apache.commons.beanutils.ConversionException;
import org.apache.commons.beanutils.ConvertUtils;
@@ -462,7 +462,7 @@ OpenConnection selectResourceByLocale(URL url, Locale locale) throws IOException
/**
* Serves the specified {@link URLConnection} as a static resource.
*/
- boolean serveStaticResource(HttpServletRequest req, StaplerResponse rsp, OpenConnection con, long expiration)
+ boolean serveStaticResource(HttpServletRequest req, StaplerResponse2 rsp, OpenConnection con, long expiration)
throws IOException {
if (con == null) {
return false;
@@ -484,7 +484,7 @@ boolean serveStaticResource(HttpServletRequest req, StaplerResponse rsp, OpenCon
/**
* Serves the specified {@link URL} as a static resource.
*/
- boolean serveStaticResource(HttpServletRequest req, StaplerResponse rsp, URL url, long expiration)
+ boolean serveStaticResource(HttpServletRequest req, StaplerResponse2 rsp, URL url, long expiration)
throws IOException {
return serveStaticResource(req, rsp, openURL(url), expiration);
}
@@ -561,7 +561,7 @@ private static URLConnection openConnection(URL url) throws IOException {
*/
boolean serveStaticResource(
HttpServletRequest req,
- StaplerResponse rsp,
+ StaplerResponse2 rsp,
InputStream in,
long lastModified,
long expiration,
@@ -1001,7 +1001,7 @@ void invoke(RequestImpl req, ResponseImpl rsp, Object node) throws IOException,
@SuppressFBWarnings(
value = "REQUESTDISPATCHER_FILE_DISCLOSURE",
justification = "Forwarding the request to be handled correctly.")
- public void forward(RequestDispatcher dispatcher, StaplerRequest req, HttpServletResponse rsp)
+ public void forward(RequestDispatcher dispatcher, StaplerRequest2 req, HttpServletResponse rsp)
throws ServletException, IOException {
dispatcher.forward(req, new ResponseImpl(this, rsp));
}
@@ -1045,7 +1045,7 @@ public static void setRoot(ServletContextEvent event, Object rootApp) {
}
/**
- * Sets the classloader used by {@link StaplerRequest#bindJSON(Class, JSONObject)} and its sibling methods.
+ * Sets the classloader used by {@link StaplerRequest2#bindJSON(Class, JSONObject)} and its sibling methods.
*
* @deprecated
* Use {@link WebApp#setClassLoader(ClassLoader)}
@@ -1074,19 +1074,37 @@ public ClassLoader getClassLoader() {
}
/**
- * Gets the current {@link StaplerRequest} that the calling thread is associated with.
+ * Gets the current {@link StaplerRequest2} that the calling thread is associated with.
*/
- public static StaplerRequest getCurrentRequest() {
+ public static StaplerRequest2 getCurrentRequest2() {
return CURRENT_REQUEST.get();
}
/**
- * Gets the current {@link StaplerResponse} that the calling thread is associated with.
+ * @deprecated use {@link #getCurrentRequest2()}
*/
- public static StaplerResponse getCurrentResponse() {
+ @Deprecated
+ public static StaplerRequest getCurrentRequest() {
+ StaplerRequest2 currentRequest = getCurrentRequest2();
+ return currentRequest != null ? StaplerRequest.fromStaplerRequest2(currentRequest) : null;
+ }
+
+ /**
+ * Gets the current {@link StaplerResponse2} that the calling thread is associated with.
+ */
+ public static StaplerResponse2 getCurrentResponse2() {
return CURRENT_RESPONSE.get();
}
+ /**
+ * @deprecated use {@link #getCurrentResponse2()}
+ */
+ @Deprecated
+ public static StaplerResponse getCurrentResponse() {
+ StaplerResponse2 currentResponse = getCurrentResponse2();
+ return currentResponse != null ? StaplerResponse.fromStaplerResponse2(currentResponse) : null;
+ }
+
/**
* Gets the current {@link Stapler} that the calling thread is associated with.
*/
@@ -1166,7 +1184,7 @@ static String canonicalPath(String path) {
/**
* This is the {@link Converter} registry that Stapler uses, primarily
- * for form-to-JSON binding in {@link StaplerRequest#bindJSON(Class, JSONObject)}
+ * for form-to-JSON binding in {@link StaplerRequest2#bindJSON(Class, JSONObject)}
* and its family of methods.
*/
public static final ConvertUtilsBean CONVERT_UTILS = new ConvertUtilsBean();
@@ -1237,7 +1255,7 @@ public FileItem convert(Class type, Object value) {
return null;
}
try {
- return Stapler.getCurrentRequest().getFileItem2(value.toString());
+ return Stapler.getCurrentRequest2().getFileItem2(value.toString());
} catch (ServletException | IOException e) {
throw new ConversionException(e);
}
@@ -1254,7 +1272,7 @@ public org.apache.commons.fileupload.FileItem convert(Class type, Object value)
}
try {
return org.apache.commons.fileupload.FileItem.fromFileUpload2FileItem(
- Stapler.getCurrentRequest().getFileItem2(value.toString()));
+ Stapler.getCurrentRequest2().getFileItem2(value.toString()));
} catch (ServletException | IOException e) {
throw new ConversionException(e);
}
diff --git a/core/src/main/java/org/kohsuke/stapler/StaplerRequest.java b/core/src/main/java/org/kohsuke/stapler/StaplerRequest.java
index 448627d1b..59e79f1a5 100644
--- a/core/src/main/java/org/kohsuke/stapler/StaplerRequest.java
+++ b/core/src/main/java/org/kohsuke/stapler/StaplerRequest.java
@@ -23,17 +23,38 @@
package org.kohsuke.stapler;
+import java.io.BufferedReader;
import java.io.IOException;
+import java.io.UnsupportedEncodingException;
import java.lang.reflect.Type;
+import java.security.Principal;
import java.util.Calendar;
+import java.util.Collection;
import java.util.Date;
+import java.util.Enumeration;
import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Objects;
import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import javax.servlet.AsyncContext;
+import javax.servlet.DispatcherType;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
+import javax.servlet.ServletInputStream;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletMapping;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+import javax.servlet.http.HttpUpgradeHandler;
+import javax.servlet.http.Part;
+import javax.servlet.http.PushBuilder;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.apache.commons.beanutils.BeanUtils;
@@ -48,7 +69,9 @@
*
* @see Stapler#getCurrentRequest()
* @author Kohsuke Kawaguchi
+ * @deprecated use {@link StaplerRequest2}
*/
+@Deprecated
public interface StaplerRequest extends HttpServletRequest {
/**
* Gets the {@link Stapler} instance that this belongs to.
@@ -553,4 +576,1264 @@ public String getUrlNames() {
* {@code makeStaplerProxy}.
*/
RenderOnDemandParameters createJavaScriptProxyParameters(Object toBeExported);
+
+ default StaplerRequest2 toStaplerRequest2() {
+ return new StaplerRequest2() {
+ @Override
+ public Object getAttribute(String name) {
+ return StaplerRequest.this.getAttribute(name);
+ }
+
+ @Override
+ public Enumerationroot.getFoo().getBar("zot"),
+ * then this list will contain the following 3 objects in this order:
+ *
+ *
+ *
+ *
+ *
+ * Foo(String a, String b), then the constructor will be invoked
+ * as new Foo(getParameter("foo.a"),getParameter("foo.b")).
+ *
+ * @deprecated
+ * Instead of using prefix to group object among form parameter names,
+ * use structured form submission and {@link #bindJSON(Class, JSONObject)}.
+ */
+ @Deprecated
+
+ * class Foo {
+ * @{@link DataBoundConstructor}
+ * public Foo(Integer x, String y, boolean z, Bar bar) { ... }
+ * }
+ *
+ * class Bar {
+ * @{@link 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))
+ *
+ *
+ * class BarEx extends Bar {
+ * @{@link DataBoundConstructor}
+ * public BarEx(int a, int b, int c) {}
+ * }
+ *
+ * { y:"text", z:true, bar: { $class:"p.k.g.BarEx", a:1, b:2, c:3 } }
+ *
+ *
+ *