Package org.kohsuke.stapler
package org.kohsuke.stapler
Stapler
URL → Object mapping framework. The main entry points are Stapler,
StaplerRequest, and StaplerResponse.-
ClassDescriptionAbstractTearOff<CLT,
S, E extends Exception> Partial default implementation of tear-off class, for convenience of derived classes.Represents theAcceptHTTP header and help server choose the right media type to serve.Media range plus parameters and extensionsInformation about ancestor of the "it" node.Indicates that this parameter is injected by evaluatingStaplerRequest.findAncestorObject(Class)with the parameter type.AnnotationHandler<T extends Annotation>Handles stapler parameter annotations by determining what values to inject for a method call.AttributeKey<T>Type-safe attribute accessor.Intercepts (and receives callbacks) about the JSON → object binding process.CachingScriptLoader<S,E extends Exception> Convenient base class for caching loaded scripts.Signals that the request dispatching to the current method is cancelled, and that Stapler should resume the search for the next request dispatcher and dispatch the request accordingly.This "hidden" annotation is injected by Groovy compiler to capture parameter names in the class file.Groovy AST transformation that capture necessary parameter names.Reflection information of aClass.Generates a nonce value that allows us to protect against cross-site request forgery (CSRF) attacks.Designates the constructor to be created from methods likeStaplerRequest.bindJSON(Class, JSONObject)andStaplerRequest.bindParameters(Class, String).For data-bound class (that has a constructor marked withDataBoundConstructor, theDataBoundResolvable.bindResolve(StaplerRequest, JSONObject)allows an instance to replace the object bound from submitted JSON object.Designates a setter method or a field used to databind JSON values into objects in methods likeStaplerRequest.bindJSON(Class, JSONObject)andStaplerRequest.bindParameters(Class, String).Filterthat sets the thread name to reflect the current request being processed.Controls the dispatching of incoming HTTP requests.Registered insideWebApp.setDispatchersFilter(DispatchersFilter)and then used after the creation of the dispatchers for aMetaClassin order to add / remove / edit the dispatchers that are created.Validates dispatch requests.Remembers theStapler.invoke(RequestImpl, ResponseImpl, Object)evaluation traces.Aspect of stapler that brings in an optional language binding.Functionthat forwards calls to another.HttpResponsethat forwards to aRequestDispatcher, such as a view.Abstracts the difference between normal instance methods and static duck-typed methods.Normal instance methods.Immutable list ofFunctions.Indicates that this parameter is bound from HTTP header.Marks the object that can handle HTTP DELETE.Dispatcherthat processesHttpDeletableHttpResponsethat dose HTTP 302 redirect.Object that represents the HTTP response, which is defined as a capability to produce the response.Pluggable interface that takes the return value from request handling methods and convert that to HTTP responses.DefaultHttpResponseRenderer.Factory forHttpResponse.Used on annotations to indicate that it signals a parameter injection in web-bound "doXyz" methods.Function.contextualize(Object)parameter that indicates the function is called to serve JavaScript method invocation from a proxy.Customize / sanitize the JSON before putting it in the stack trace / error messages.Declares that methods are only available for requests that have the specified role(s).Service provider interface allowing to hook into webapp resource lookup.Created one instance each for aKlass, that retains some useful cache about a class and its views.The stapler version of theClassLoaderobject, that retains some useful cache about a class loader.Implementation detail in Stapler.Indicates that this parameter is injected from HTTP query parameter.Argument to expressions that indicates this value is raw HTML and therefore should not be further escaped.StaplerRequestimplementation.StaplerResponseimplementation.Execution strategy for handling views written in other scripting languages.Deprecated.No longer used.Single linked list which allows sharing of the suffix.Maps an HTTP request to a method call / JSP invocation against a model object by evaluating the request URL in a EL-ish way.An object can fall back to another object for a part of its UI processing, by implementing this interface and designating another object fromStaplerFallback.getStaplerFallback().A web-bound object can implement this interface to allow designated objects to selectively override URL mappings.If an object delegates all its UI processing to another object, it can implement this interface and return the designated object from theStaplerProxy.getTarget()method.Defines additional parameters/operations made available by Stapler.Return value ofStaplerRequest.createJavaScriptProxyParameters(Object)Defines additional operations made available by Stapler.A basic wrapper for a StaplerResponse, e.g.Allows "tear-off" objects to be linked to the parent object.Tokenized path portion of the URL.Function.contextualize(Object)parameter that indicates the function is called to traverse an object graph.Handles an exception caught byUncaughtExceptionFilter.Object scoped to the entire webapp.Indicates that the method is bound to HTTP and used to serve the HTTP request.Function.contextualize(Object)parameter that indicates the function is called to serve request, such asdoFoo(...)ordoIndex(...)