Interface Summary Interface Description AncestorInformation about ancestor of the "it" node. DataBoundResolvableFor data-bound class (that has a constructor marked with
DataBoundResolvable.bindResolve(StaplerRequest, JSONObject)allows an instance to replace the object bound from submitted JSON object.
DispatchersFilter DispatchValidatorValidates dispatch requests. FunctionList.Filter HttpDeletableMarks the object that can handle HTTP DELETE. HttpResponseObject that represents the HTTP response, which is defined as a capability to produce the response. HttpResponses.ErrorCustomizer JsonInErrorMessageSanitizerCustomize / sanitize the JSON before putting it in the stack trace / error messages. ScriptExecutor<S>Execution strategy for handling views written in other scripting languages. StaplerFallbackAn object can fall back to another object for a part of its UI processing, by implementing this interface and designating another object from
StaplerOverridableA web-bound object can implement this interface to allow designated objects to selectively override URL mappings. StaplerProxyIf an object delegates all its UI processing to another object, it can implement this interface and return the designated object from the
StaplerRequestDefines additional parameters/operations made available by Stapler. StaplerResponseDefines 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. AcceptHeaderRepresents the
AcceptHTTP header and help server choose the right media type to serve.
AcceptHeader.AtomMedia range plus parameters and extensions AcceptHeader.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. BindInterceptorIntercepts (and receives callbacks) about the JSON → object binding process. CachingScriptLoader<S,E extends Exception>Convenient base class for caching loaded scripts. CaptureParameterNameTransformationGroovy AST transformation that capture necessary parameter names. ClassDescriptorReflection information of a
CrumbIssuerGenerates a nonce value that allows us to protect against cross-site request forgery (CSRF) attacks. DiagnosticThreadNameFilter
Filterthat sets the thread name to reflect the current request being processed.
DispatcherControls the dispatching of incoming HTTP requests. EvaluationTraceRemembers the
Stapler.invoke(RequestImpl, ResponseImpl, Object)evaluation traces.
EvaluationTrace.ApplicationTracer FacetAspect of stapler that brings in an optional language binding. ForwardingFunction
Functionthat forwards calls to another.
FunctionAbstracts the difference between normal instance methods and static duck-typed methods. Function.InstanceFunctionNormal instance methods. FunctionListImmutable list of
Header.HandlerImpl HttpResponseRendererPluggable interface that takes the return value from request handling methods and convert that to HTTP responses. HttpResponseRenderer.DefaultDefault
LimitedTo.Processor LocaleDrivenResourceProviderService provider interface allowing to hook into webapp resource lookup. MetaClassCreated one instance each for a
Klass, that retains some useful cache about a class and its views.
MetaClassLoaderThe stapler version of the
ClassLoaderobject, that retains some useful cache about a class loader.
MethodHandleFactoryImplementation detail in Stapler. QueryParameter.HandlerImpl RawHtmlArgumentArgument to expressions that indicates this value is raw HTML and therefore should not be further escaped. ReflectionUtils RequestImpl
SingleLinkedList<T>Single linked list which allows sharing of the suffix. StaplerMaps an HTTP request to a method call / JSP invocation against a model object by evaluating the request URL in a EL-ish way. StaplerResponseWrapperA basic wrapper for a StaplerResponse, e.g. StaticViewFacet TearOffSupportAllows "tear-off" objects to be linked to the parent object. TokenListTokenized path portion of the URL. TraversalMethodContext
Function.contextualize(Object)parameter that indicates the function is called to traverse an object graph.
WebAppObject scoped to the entire webapp. WebMethodContext
Function.contextualize(Object)parameter that indicates the function is called to serve request, such as
Exception Summary Exception Description CancelRequestHandlingExceptionSignals 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
HttpResponsethat forwards to a
RequestDispatcher, such as a view.
HttpResponsethat dose HTTP 302 redirect.
HttpResponses.HttpResponseException NoStaplerConstructorException ScriptLoadException Deprecated.No longer used. WrongTypeException
Annotation Types Summary Annotation Type Description AncestorInPathIndicates that this parameter is injected by evaluating
StaplerRequest.findAncestorObject(Class)with the parameter type.
CapturedParameterNamesThis "hidden" annotation is injected by Groovy compiler to capture parameter names in the class file. DataBoundConstructor DataBoundSetter HeaderIndicates that this parameter is bound from HTTP header. InjectedParameterUsed on annotations to indicate that it signals a parameter injection in web-bound "doXyz" methods. LimitedToDeclares that methods are only available for requests that have the specified role(s). QueryParameterIndicates that this parameter is injected from HTTP query parameter. WebMethodIndicates that the method is bound to HTTP and used to serve the HTTP request.