Package org.kohsuke.stapler
Stapler
URL
→ Object
mapping framework. The main entry points are Stapler
,
StaplerRequest
, and StaplerResponse
.-
Interface Summary Interface Description Ancestor Information about ancestor of the "it" node.DataBoundResolvable 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.DispatchersFilter Registered insideWebApp.setDispatchersFilter(DispatchersFilter)
and then used after the creation of the dispatchers for aMetaClass
in order to add / remove / edit the dispatchers that are created.DispatchValidator Validates dispatch requests.FunctionList.Filter HttpDeletable Marks the object that can handle HTTP DELETE.HttpResponse Object that represents the HTTP response, which is defined as a capability to produce the response.HttpResponses.ErrorCustomizer JsonInErrorMessageSanitizer Customize / sanitize the JSON before putting it in the stack trace / error messages.ScriptExecutor<S> Execution strategy for handling views written in other scripting languages.StaplerFallback 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()
.StaplerOverridable A web-bound object can implement this interface to allow designated objects to selectively override URL mappings.StaplerProxy 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.StaplerRequest Defines additional parameters/operations made available by Stapler.StaplerResponse Defines additional operations made available by Stapler. -
Class Summary Class Description AbstractTearOff<CLT,S,E extends Exception> Partial default implementation of tear-off class, for convenience of derived classes.AcceptHeader Represents theAccept
HTTP header and help server choose the right media type to serve.AcceptHeader.Atom Media range plus parameters and extensionsAcceptHeader.StaplerConverterImpl AncestorInPath.HandlerImpl AnnotationHandler<T extends Annotation> Handles stapler parameter annotations by determining what values to inject for a method call.AttributeKey<T> Type-safe attribute accessor.BindInterceptor Intercepts (and receives callbacks) about the JSON → object binding process.CachingScriptLoader<S,E extends Exception> Convenient base class for caching loaded scripts.CaptureParameterNameTransformation Groovy AST transformation that capture necessary parameter names.ClassDescriptor Reflection information of aClass
.CrumbIssuer Generates a nonce value that allows us to protect against cross-site request forgery (CSRF) attacks.DiagnosticThreadNameFilter Filter
that sets the thread name to reflect the current request being processed.Dispatcher Controls the dispatching of incoming HTTP requests.EvaluationTrace Remembers theStapler.invoke(RequestImpl, ResponseImpl, Object)
evaluation traces.EvaluationTrace.ApplicationTracer Facet Aspect of stapler that brings in an optional language binding.ForwardingFunction Function
that forwards calls to another.Function Abstracts the difference between normal instance methods and static duck-typed methods.Function.InstanceFunction Normal instance methods.FunctionList Immutable list ofFunction
s.Header.HandlerImpl HttpResponseRenderer Pluggable interface that takes the return value from request handling methods and convert that to HTTP responses.HttpResponseRenderer.Default DefaultHttpResponseRenderer
.HttpResponses Factory forHttpResponse
.JavaScriptMethodContext Function.contextualize(Object)
parameter that indicates the function is called to serve JavaScript method invocation from a proxy.LimitedTo.Processor LocaleDrivenResourceProvider Service provider interface allowing to hook into webapp resource lookup.MetaClass Created one instance each for aKlass
, that retains some useful cache about a class and its views.MetaClassLoader The stapler version of theClassLoader
object, that retains some useful cache about a class loader.MethodHandleFactory Implementation detail in Stapler.QueryParameter.HandlerImpl RawHtmlArgument Argument to expressions that indicates this value is raw HTML and therefore should not be further escaped.ReflectionUtils RequestImpl StaplerRequest
implementation.ResponseImpl StaplerResponse
implementation.SingleLinkedList<T> Single linked list which allows sharing of the suffix.Stapler Maps an HTTP request to a method call / JSP invocation against a model object by evaluating the request URL in a EL-ish way.StaplerResponseWrapper A basic wrapper for a StaplerResponse, e.g.StaticViewFacet TearOffSupport Allows "tear-off" objects to be linked to the parent object.TokenList Tokenized path portion of the URL.TraversalMethodContext Function.contextualize(Object)
parameter that indicates the function is called to traverse an object graph.WebApp Object scoped to the entire webapp.WebMethodContext Function.contextualize(Object)
parameter that indicates the function is called to serve request, such asdoFoo(...)
ordoIndex(...)
-
Exception Summary Exception Description CancelRequestHandlingException 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.ForwardToView HttpResponse
that forwards to aRequestDispatcher
, such as a view.HttpRedirect HttpResponse
that dose HTTP 302 redirect.HttpResponses.HttpResponseException NoStaplerConstructorException ScriptLoadException Deprecated. No longer used.WrongTypeException -
Annotation Types Summary Annotation Type Description AncestorInPath Indicates that this parameter is injected by evaluatingStaplerRequest.findAncestorObject(Class)
with the parameter type.CapturedParameterNames This "hidden" annotation is injected by Groovy compiler to capture parameter names in the class file.DataBoundConstructor Designates the constructor to be created from methods likeStaplerRequest.bindJSON(Class, JSONObject)
andStaplerRequest.bindParameters(Class, String)
.DataBoundSetter Designates a setter method or a field used to databind JSON values into objects in methods likeStaplerRequest.bindJSON(Class, JSONObject)
andStaplerRequest.bindParameters(Class, String)
.Header Indicates that this parameter is bound from HTTP header.InjectedParameter Used on annotations to indicate that it signals a parameter injection in web-bound "doXyz" methods.LimitedTo Declares that methods are only available for requests that have the specified role(s).QueryParameter Indicates that this parameter is injected from HTTP query parameter.WebMethod Indicates that the method is bound to HTTP and used to serve the HTTP request.