A B C D E F G H I J K L M N O P Q R S T U V W X

A

AbstractTearOff<CLT,S,E extends Exception> - Class in org.kohsuke.stapler

Partial default implementation of tear-off class, for convenience of derived classes.

AbstractTearOff(MetaClass, Class<CLT>) - Constructor for class org.kohsuke.stapler.AbstractTearOff

AbstractWebAppMain<T> - Class in org.kohsuke.stapler.framework

Entry point for web applications.

AbstractWebAppMain(Class<T>) - Constructor for class org.kohsuke.stapler.framework.AbstractWebAppMain

accept(Object, Property) - Method in class org.kohsuke.stapler.export.NamedPathPruner

accept(Object, Property) - Method in class org.kohsuke.stapler.export.TreePruner

Called before Hudson writes a new property.

accept(Object, Property) - Method in class org.kohsuke.stapler.export.TreePruner.ByDepth

add(Class<?>) - Method in class org.kohsuke.stapler.export.SchemaGenerator

Adds the schema for the XML representation of the given class.

addExtension(String) - Method in class org.kohsuke.stapler.StaticViewFacet

addHeader(String, String) - Method in class org.kohsuke.stapler.compression.CompressionServletResponse

Ancestor - Interface in org.kohsuke.stapler

Information about ancestor of the "it" node.

AncestorInPath - Annotation Type in org.kohsuke.stapler

Indicates that this parameter is injected by evaluating StaplerRequest.findAncestorObject(Class) with the parameter type.

ancestors - Variable in class org.kohsuke.stapler.RequestImpl

Ancesotr nodes traversed so far.

annotation() - Method in interface org.kohsuke.stapler.export.XSD.Annotated

ANYTYPE - Static variable in class org.kohsuke.stapler.export.XSD.Types

appScoped() - Static method in class org.kohsuke.stapler.AttributeKey

Creates a new ServletContext-scoped AttributeKey.

as(Class<T>) - Method in class org.kohsuke.stapler.config.ConfigurationLoader

Creates a type-safe proxy that reads from the source specified by one of the fromXyz methods.

assembleOriginalRestOfPath() - Method in class org.kohsuke.stapler.TokenList

assembleRestOfPath() - Method in class org.kohsuke.stapler.TokenList

AtomicFileWriter - Class in org.kohsuke.stapler.framework.io

Buffered FileWriter that uses UTF-8.

AtomicFileWriter(File) - Constructor for class org.kohsuke.stapler.framework.io.AtomicFileWriter

AttributeKey<T> - Class in org.kohsuke.stapler

Type-safe attribute accessor.

AttributeKey() - Constructor for class org.kohsuke.stapler.AttributeKey

AttributeKey(String) - Constructor for class org.kohsuke.stapler.AttributeKey

B

base(QName) - Method in interface org.kohsuke.stapler.export.XSD.Restriction

baseClass - Variable in class org.kohsuke.stapler.MetaClass

Base metaclass.

bind(Object) - Method in class org.kohsuke.stapler.bind.BoundObjectTable

Binds an object temporarily and returns its URL.

BindInterceptor - Class in org.kohsuke.stapler

Intercepts (and receives callbacks) about the JSON->object binding process.

BindInterceptor() - Constructor for class org.kohsuke.stapler.BindInterceptor

bindJSON(Class<T>, JSONObject) - Method in class org.kohsuke.stapler.RequestImpl

bindJSON(Type, Class, Object) - Method in class org.kohsuke.stapler.RequestImpl

bindJSON(Object, JSONObject) - Method in class org.kohsuke.stapler.RequestImpl

bindJSON(Class<T>, JSONObject) - Method in interface org.kohsuke.stapler.StaplerRequest

Data-bind from a JSONObject to the given target type, by using introspection or constructor parameters injection.

bindJSON(Type, Class<T>, Object) - Method in interface org.kohsuke.stapler.StaplerRequest

Data-bind from one of the JSON object types (JSONObject, JSONArray, String, Integer, and so on) to the expected type given as an argument.

bindJSON(Object, JSONObject) - Method in interface org.kohsuke.stapler.StaplerRequest

Data-binds from JSONObject to the given object.

bindJSONToList(Class<T>, Object) - Method in class org.kohsuke.stapler.RequestImpl

bindJSONToList(Class<T>, Object) - Method in interface org.kohsuke.stapler.StaplerRequest

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

bindParameters(Object) - Method in class org.kohsuke.stapler.RequestImpl

bindParameters(Object, String) - Method in class org.kohsuke.stapler.RequestImpl

bindParameters(Class<T>, String) - Method in class org.kohsuke.stapler.RequestImpl

bindParameters(Class<T>, String, int) - Method in class org.kohsuke.stapler.RequestImpl

bindParameters(Object) - Method in interface org.kohsuke.stapler.StaplerRequest

Binds form parameters to a bean by using introspection.

bindParameters(Object, String) - Method in interface org.kohsuke.stapler.StaplerRequest

Binds form parameters to a bean by using introspection.

bindParameters(Class<T>, String) - Method in interface org.kohsuke.stapler.StaplerRequest

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

bindParameters(Class<T>, String, int) - Method in interface org.kohsuke.stapler.StaplerRequest

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

bindParametersToList(Class<T>, String) - Method in class org.kohsuke.stapler.RequestImpl

bindParametersToList(Class<T>, String) - Method in interface org.kohsuke.stapler.StaplerRequest

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

bindWeak(Object) - Method in class org.kohsuke.stapler.bind.BoundObjectTable

Binds an object temporarily and returns its URL.

BOOLEAN - Static variable in class org.kohsuke.stapler.export.XSD.Types

Bound - Class in org.kohsuke.stapler.bind

Handles to the object bound via BoundObjectTable.

Bound() - Constructor for class org.kohsuke.stapler.bind.Bound

BoundObjectTable - Class in org.kohsuke.stapler.bind

Objects exported and bound by JavaScript proxies.

BoundObjectTable() - Constructor for class org.kohsuke.stapler.bind.BoundObjectTable

boundObjectTable - Variable in class org.kohsuke.stapler.WebApp

Handles objects that are exported.

BoundObjectTable.Table - Class in org.kohsuke.stapler.bind

Per-session table that remembers all the bound instances.

BoundObjectTable.Table() - Constructor for class org.kohsuke.stapler.bind.BoundObjectTable.Table

buildFallbackDispatchers(MetaClass, List<Dispatcher>) - Method in class org.kohsuke.stapler.Facet

Adds Dispatchers that do catch-all behaviours like "doDispatch" does.

buildViewDispatchers(MetaClass, List<Dispatcher>) - Method in class org.kohsuke.stapler.Facet

Adds Dispatchers that look at one token and binds that to the views associated with the 'it' object.

buildViewDispatchers(MetaClass, List<Dispatcher>) - Method in class org.kohsuke.stapler.StaticViewFacet

ByteBuffer - Class in org.kohsuke.stapler.framework.io

ByteArrayOutputStream re-implementation.

ByteBuffer() - Constructor for class org.kohsuke.stapler.framework.io.ByteBuffer

C

CachingScriptLoader<S,E extends Exception> - Class in org.kohsuke.stapler

Convenient base class for caching loaded scripts.

CachingScriptLoader() - Constructor for class org.kohsuke.stapler.CachingScriptLoader

CapturedParameterNames - Annotation Type in org.kohsuke.stapler

This "hidden" annotation is injected by Groovy compiler to capture parameter names in the class file.

CaptureParameterNameTransformation - Class in org.kohsuke.stapler

Groovy AST transformation that capture necessary parameter names.

CaptureParameterNameTransformation() - Constructor for class org.kohsuke.stapler.CaptureParameterNameTransformation

charset - Variable in class org.kohsuke.stapler.framework.io.LargeText

CharSpool - Class in org.kohsuke.stapler.framework.io

Writer that spools the output and writes to another Writer later.

CharSpool() - Constructor for class org.kohsuke.stapler.framework.io.CharSpool

checkEnvironment() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Performs pre start-up environment check.

checkIfModified(long, StaplerResponse) - Method in class org.kohsuke.stapler.RequestImpl

checkIfModified(long, StaplerResponse, long) - Method in class org.kohsuke.stapler.RequestImpl

checkIfModified(Date, StaplerResponse) - Method in class org.kohsuke.stapler.RequestImpl

checkIfModified(Calendar, StaplerResponse) - Method in class org.kohsuke.stapler.RequestImpl

checkIfModified(long, StaplerResponse) - Method in interface org.kohsuke.stapler.StaplerRequest

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

checkIfModified(Date, StaplerResponse) - Method in interface org.kohsuke.stapler.StaplerRequest

checkIfModified(Calendar, StaplerResponse) - Method in interface org.kohsuke.stapler.StaplerRequest

checkIfModified(long, StaplerResponse, long) - Method in interface org.kohsuke.stapler.StaplerRequest

ClassDescriptor - Class in org.kohsuke.stapler

Reflection information of a Class.

ClassDescriptor(Class, Class...) - Constructor for class org.kohsuke.stapler.ClassDescriptor

classLoader - Variable in class org.kohsuke.stapler.AbstractTearOff

classLoader - Variable in class org.kohsuke.stapler.MetaClass

MetaClassLoader that wraps clazz.getClassLoader().

clazz - Variable in class org.kohsuke.stapler.ClassDescriptor

clazz - Variable in class org.kohsuke.stapler.lang.Klass

clazz - Variable in class org.kohsuke.stapler.MetaClass

Deprecated.

as of 1.177 Use MetaClass.klass. If you really want the Java class representation, use klass.toJavaClass().

cleanUp(T) - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Called during the destructino of the web app to perform any clean up act on the application object.

clearScripts() - Method in class org.kohsuke.stapler.CachingScriptLoader

Discards the cached script.

clearScripts(Class<? extends AbstractTearOff>) - Method in class org.kohsuke.stapler.WebApp

Convenience maintenance method to clear all the cached scripts for the given tearoff type.

close() - Method in class org.kohsuke.stapler.compression.FilterServletOutputStream

close() - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

close() - Method in class org.kohsuke.stapler.framework.io.CharSpool

close() - Method in class org.kohsuke.stapler.framework.io.WriterOutputStream

commit() - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

compareTo(Property) - Method in class org.kohsuke.stapler.export.Property

complexContent() - Method in interface org.kohsuke.stapler.export.XSD.ComplexType

complexType() - Method in interface org.kohsuke.stapler.export.XSD.Schema

CompressionFilter - Class in org.kohsuke.stapler.compression

Pimps up HttpServletResponse so that it understands "Content-Encoding: gzip" and compress the response.

CompressionFilter() - Constructor for class org.kohsuke.stapler.compression.CompressionFilter

CompressionServletResponse - Class in org.kohsuke.stapler.compression

HttpServletResponse that recognizes Content-Encoding: gzip in the response header and acts accoringly.

CompressionServletResponse(HttpServletResponse) - Constructor for class org.kohsuke.stapler.compression.CompressionServletResponse

Configuration - Annotation Type in org.kohsuke.stapler.config

Customizes how the property retrieval is handled.

ConfigurationLoader - Class in org.kohsuke.stapler.config

Provides a type-safe access to the configuration of the application.

ConstructorProcessor - Class in org.kohsuke.stapler.jsr269

ConstructorProcessor() - Constructor for class org.kohsuke.stapler.jsr269.ConstructorProcessor

contentType - Variable in enum org.kohsuke.stapler.export.Flavor

Content-type of this flavor, including charset "UTF-8".

context - Variable in class org.kohsuke.stapler.framework.AbstractWebAppMain

context - Variable in class org.kohsuke.stapler.WebApp

ServletContext for this webapp.

CONTEXT_ROOT - Static variable in exception org.kohsuke.stapler.HttpRedirect

Redirect to the context root

contextDestroyed(ServletContextEvent) - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

contextInitialized(ServletContextEvent) - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

CONVERT_UTILS - Static variable in class org.kohsuke.stapler.Stapler

This is the Converter registry that Stapler uses, primarily for form-to-JSON binding in StaplerRequest.bindJSON(Class, JSONObject) and its family of methods.

countRemainingTokens() - Method in class org.kohsuke.stapler.TokenList

createApplication() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Creates the root application object.

createDataWriter(Object, StaplerResponse) - Method in enum org.kohsuke.stapler.export.Flavor

createDataWriter(Object, Writer) - Method in enum org.kohsuke.stapler.export.Flavor

createDataWriter(Object, Writer, ExportConfig) - Method in enum org.kohsuke.stapler.export.Flavor

createJavaScriptProxy(Object) - Method in class org.kohsuke.stapler.RequestImpl

createJavaScriptProxy(Object) - Method in interface org.kohsuke.stapler.StaplerRequest

Exports the given Java object as a JavaScript proxy and returns a JavaScript expression to create a proxy on the client side.

createPlaceHolderForAsyncLoad() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

If the root application object is loaded asynchronously, override this method to return the place holder object to serve the request in the mean time.

createRequestDispatcher(RequestImpl, Klass<?>, Object, String) - Method in class org.kohsuke.stapler.Facet

Creates a RequestDispatcher that handles the given view, or return null if no such view was found.

createRequestDispatcher(RequestImpl, Class, Object, String) - Method in class org.kohsuke.stapler.Facet

createRequestDispatcher(RequestImpl, Klass<?>, Object, String) - Method in class org.kohsuke.stapler.StaticViewFacet

createWriter(StaplerRequest, StaplerResponse, long) - Method in class org.kohsuke.stapler.framework.io.LargeText

CrumbIssuer - Class in org.kohsuke.stapler

Generates a nonce value that allows us to protect against cross-site request forgery (CSRF) attacks.

CrumbIssuer() - Constructor for class org.kohsuke.stapler.CrumbIssuer

CustomExportedBean - Interface in org.kohsuke.stapler.export

Interface that an exposed bean can implement, to do the equivalent of writeReplace in Java serialization.

D

DataBoundConstructor - Annotation Type in org.kohsuke.stapler

Designates the constructor to be created from methods like StaplerRequest.bindJSON(Class, JSONObject) and StaplerRequest.bindParameters(Class, String).

DataWriter - Interface in org.kohsuke.stapler.export

Receives the event callback on the model data to be exposed.

DEBUG_LOGGING - Static variable in class org.kohsuke.stapler.bind.BoundObjectTable

True to activate debug logging of session fragments.

debugLoader - Static variable in class org.kohsuke.stapler.MetaClassLoader

If non-null, delegate to this classloader.

decode(String) - Static method in class org.kohsuke.stapler.TokenList

DEFAULT - Static variable in class org.kohsuke.stapler.BindInterceptor

Indicates that the conversion should proceed as it normally does, and that the listener isn't replacing the process.

DEFAULT - Static variable in class org.kohsuke.stapler.CrumbIssuer

Default crumb issuer.

defaultEncodingForStaticResources - Variable in class org.kohsuke.stapler.WebApp

MIME type -> encoding map that determines how static contents in the war file is served.

delete(StaplerRequest, StaplerResponse) - Method in interface org.kohsuke.stapler.HttpDeletable

Called when HTTP DELETE method is invoked.

destroy() - Method in class org.kohsuke.stapler.compression.CompressionFilter

DISABLED - Static variable in class org.kohsuke.stapler.compression.CompressionFilter

discover(ClassLoader) - Static method in class org.kohsuke.stapler.Facet

Discovers all the facets in the classloader.

discoverExtensions(Class<T>, ClassLoader...) - Static method in class org.kohsuke.stapler.Facet

dispatch(RequestImpl, ResponseImpl, Object) - Method in class org.kohsuke.stapler.Dispatcher

Trys to handle the given request and returns true if it succeeds.

Dispatcher - Class in org.kohsuke.stapler

Controls the dispatching of incoming HTTP requests.

Dispatcher() - Constructor for class org.kohsuke.stapler.Dispatcher

dispatchers - Variable in class org.kohsuke.stapler.MetaClass

doCrumb() - Method in class org.kohsuke.stapler.CrumbIssuer

Sends the crumb value in plain text, enabling retrieval through XmlHttpRequest.

documentation(String) - Method in interface org.kohsuke.stapler.export.XSD.Annotation

doEnableLogging() - Method in class org.kohsuke.stapler.bind.BoundObjectTable.Table

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.kohsuke.stapler.compression.CompressionFilter

doProgressText(StaplerRequest, StaplerResponse) - Method in class org.kohsuke.stapler.framework.io.LargeText

Implements the progressive text handling.

DOT - Static variable in exception org.kohsuke.stapler.HttpRedirect

Redirect to "."

E

element() - Method in interface org.kohsuke.stapler.export.XSD.ContentModel

element() - Method in interface org.kohsuke.stapler.export.XSD.Schema

encode(String) - Static method in class org.kohsuke.stapler.ResponseImpl

Escapes non-ASCII characters.

endArray() - Method in interface org.kohsuke.stapler.export.DataWriter

endObject() - Method in interface org.kohsuke.stapler.export.DataWriter

enumeration() - Method in interface org.kohsuke.stapler.export.XSD.Restriction

equals(Object) - Method in class org.kohsuke.stapler.lang.Klass

erasure(Type) - Static method in class org.kohsuke.stapler.export.TypeUtil

Returns the runtime representation of the given type.

error(int, String) - Static method in class org.kohsuke.stapler.HttpResponses

error(Throwable) - Static method in class org.kohsuke.stapler.HttpResponses

error(int, Throwable) - Static method in class org.kohsuke.stapler.HttpResponses

ErrorObject - Class in org.kohsuke.stapler.framework.errors

Root class of the stapler error objects.

ErrorObject() - Constructor for class org.kohsuke.stapler.framework.errors.ErrorObject

escape(String) - Static method in class org.kohsuke.stapler.Stapler

Escapes HTML/XML unsafe characters for the PCDATA section.

EvaluationTrace - Class in org.kohsuke.stapler

Remebers the Stapler.invoke(RequestImpl, ResponseImpl, Object) evaluation traces.

EvaluationTrace() - Constructor for class org.kohsuke.stapler.EvaluationTrace

ExportConfig - Class in org.kohsuke.stapler.export

Controls the output behaviour.

ExportConfig() - Constructor for class org.kohsuke.stapler.export.ExportConfig

Exported - Annotation Type in org.kohsuke.stapler.export

Mark the field or the getter method whose value gets exposed to the remote API.

ExportedBean - Annotation Type in org.kohsuke.stapler.export

Indicates that the class has Exported annotations on its properties to indicate which properties are written as values to the remote XML/JSON API.

ExportedBeanAnnotationProcessor - Class in org.kohsuke.stapler.jsr269

ExportedBeanAnnotationProcessor() - Constructor for class org.kohsuke.stapler.jsr269.ExportedBeanAnnotationProcessor

extension() - Method in interface org.kohsuke.stapler.export.XSD.ComplexContent

F

Facet - Class in org.kohsuke.stapler

Aspect of stapler that brings in an optional language binding.

Facet() - Constructor for class org.kohsuke.stapler.Facet

facets - Variable in class org.kohsuke.stapler.WebApp

Activated facets.

fields - Variable in class org.kohsuke.stapler.ClassDescriptor

FilterServletOutputStream - Class in org.kohsuke.stapler.compression

ServletOutputStream that writes to the specified output stream.

FilterServletOutputStream(OutputStream) - Constructor for class org.kohsuke.stapler.compression.FilterServletOutputStream

findAncestor(Class) - Method in class org.kohsuke.stapler.RequestImpl

findAncestor(Object) - Method in class org.kohsuke.stapler.RequestImpl

findAncestor(Class) - Method in interface org.kohsuke.stapler.StaplerRequest

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

findAncestor(Object) - Method in interface org.kohsuke.stapler.StaplerRequest

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

findAncestorObject(Class<T>) - Method in class org.kohsuke.stapler.RequestImpl

findAncestorObject(Class<T>) - Method in interface org.kohsuke.stapler.StaplerRequest

Short for findAncestor(type).getObject(), with proper handling for null de-reference.

findResource(Klass, String) - Method in class org.kohsuke.stapler.StaticViewFacet

Determines if this resource can be served

findScript(String) - Method in class org.kohsuke.stapler.CachingScriptLoader

Locates the view script of the given name.

Flavor - Enum in org.kohsuke.stapler.export

Export flavor.

flush() - Method in class org.kohsuke.stapler.compression.FilterServletOutputStream

flush() - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

flush() - Method in class org.kohsuke.stapler.framework.io.CharSpool

flush() - Method in class org.kohsuke.stapler.framework.io.WriterOutputStream

forbidden() - Static method in class org.kohsuke.stapler.HttpResponses

forward(Object, String, StaplerRequest) - Method in class org.kohsuke.stapler.ResponseImpl

forward(RequestDispatcher, StaplerRequest, HttpServletResponse) - Method in class org.kohsuke.stapler.Stapler

forward(Object, String, StaplerRequest) - Method in interface org.kohsuke.stapler.StaplerResponse

Evaluates the url against the given object and forwards the request to the result.

forwardToPreviousPage() - Static method in class org.kohsuke.stapler.HttpResponses

Redirects the user back to where he came from.

forwardToPreviousPage(StaplerRequest) - Method in class org.kohsuke.stapler.ResponseImpl

forwardToPreviousPage(StaplerRequest) - Method in interface org.kohsuke.stapler.StaplerResponse

Redirects the browser to where it came from (the referer.)

ForwardToView - Exception in org.kohsuke.stapler

HttpResponse that forwards to a RequestDispatcher, such as a view.

ForwardToView(RequestDispatcher) - Constructor for exception org.kohsuke.stapler.ForwardToView

ForwardToView(Object, String) - Constructor for exception org.kohsuke.stapler.ForwardToView

ForwardToView(Class, String) - Constructor for exception org.kohsuke.stapler.ForwardToView

forwardToView(Object, String) - Static method in class org.kohsuke.stapler.HttpResponses

forwardToView(Class, String) - Static method in class org.kohsuke.stapler.HttpResponses

from(File) - Static method in class org.kohsuke.stapler.config.ConfigurationLoader

Loads the configuration from the specified property file.

from(Properties) - Static method in class org.kohsuke.stapler.config.ConfigurationLoader

Loads the configuration from the specified Properties object.

from(Map<String, String>) - Static method in class org.kohsuke.stapler.config.ConfigurationLoader

fromContextPath(String) - Static method in exception org.kohsuke.stapler.HttpRedirect

Deprecated.

Use HttpResponses.redirectViaContextPath(String).

fromEnvironmentVariables() - Static method in class org.kohsuke.stapler.config.ConfigurationLoader

Creates ConfigurationLoader that uses environment variables as the source.

fromSystemProperties() - Static method in class org.kohsuke.stapler.config.ConfigurationLoader

Creates ConfigurationLoader that uses all the system properties as the source.

Function - Class in org.kohsuke.stapler

Abstracts the difference between normal instance methods and static duck-typed methods.

Function() - Constructor for class org.kohsuke.stapler.Function

G

generateResponse(StaplerRequest, StaplerResponse, Object) - Method in exception org.kohsuke.stapler.ForwardToView

generateResponse(StaplerRequest, StaplerResponse, Object) - Method in exception org.kohsuke.stapler.HttpRedirect

generateResponse(StaplerRequest, StaplerResponse, Object) - Method in interface org.kohsuke.stapler.HttpResponse

generateResponse(StaplerRequest, StaplerResponse, Object, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer.Default

generateResponse(StaplerRequest, StaplerResponse, Object, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer

generateSchema(Result) - Method in class org.kohsuke.stapler.export.SchemaGenerator

Generates the complete schema to the specified result.

get(HttpServletRequest) - Method in class org.kohsuke.stapler.AttributeKey

get() - Method in class org.kohsuke.stapler.AttributeKey

get(StaplerRequest) - Static method in class org.kohsuke.stapler.EvaluationTrace

get(Class<T>) - Method in class org.kohsuke.stapler.export.ModelBuilder

get(ClassLoader) - Static method in class org.kohsuke.stapler.MetaClassLoader

get(int) - Method in class org.kohsuke.stapler.TokenList

get(ServletContext) - Static method in class org.kohsuke.stapler.WebApp

Obtains the WebApp associated with the given ServletContext.

getAncestors() - Method in class org.kohsuke.stapler.lang.Klass

getAncestors(C) - Method in class org.kohsuke.stapler.lang.KlassNavigator

Lists up all the ancestor classes, from specific to general, without any duplicate.

getAncestors() - Method in class org.kohsuke.stapler.RequestImpl

getAncestors() - Method in interface org.kohsuke.stapler.StaplerRequest

Returns a list of ancestor objects that lead to the "it" object.

getAnnotation(Class<A>) - Method in class org.kohsuke.stapler.Function

getApp() - Method in class org.kohsuke.stapler.WebApp

Returns the 'app' object, which is the user-specified object that sits at the root of the URL hierarchy and handles the request to '/'.

getApplicationName() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Returns the application name, like "Hudson" or "Torricelli".

getBaseClass(Type, Class) - Static method in class org.kohsuke.stapler.export.TypeUtil

Gets the parameterization of the given base type.

getBindInterceptor() - Method in class org.kohsuke.stapler.RequestImpl

getBindInterceptor() - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the BindInterceptor set for this request.

getBoundObjectTable() - Method in class org.kohsuke.stapler.RequestImpl

getBoundObjectTable() - Method in interface org.kohsuke.stapler.StaplerRequest

Short cut for obtaining BoundObjectTable associated with this webapp.

getClassLoader(ServletContext) - Static method in class org.kohsuke.stapler.Stapler

Deprecated.

Use WebApp.getClassLoader()

getClassLoader() - Method in class org.kohsuke.stapler.Stapler

Deprecated.

Use WebApp.getClassLoader()

getClassLoader() - Method in class org.kohsuke.stapler.WebApp

getCompressedOutputStream(HttpServletRequest) - Method in class org.kohsuke.stapler.ResponseImpl

getCompressedOutputStream(HttpServletRequest) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like ServletResponse.getOutputStream() but tries to send the response with gzip compression if the client supports it.

getCompressedWriter(HttpServletRequest) - Method in class org.kohsuke.stapler.ResponseImpl

getCompressedWriter(HttpServletRequest) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like StaplerResponse.getCompressedOutputStream(HttpServletRequest) but this method is for ServletResponse.getWriter().

getCrumbIssuer() - Method in class org.kohsuke.stapler.WebApp

getCurrent() - Static method in class org.kohsuke.stapler.Stapler

Gets the current Stapler that the calling thread is associated with.

getCurrent() - Static method in class org.kohsuke.stapler.WebApp

Gets the current WebApp that the calling thread is associated with.

getCurrentRequest() - Static method in class org.kohsuke.stapler.Stapler

Gets the current StaplerRequest that the calling thread is associated with.

getCurrentResponse() - Static method in class org.kohsuke.stapler.Stapler

Gets the current StaplerResponse that the calling thread is associated with.

getDefaultHomeDir() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

If no home directory is configured, this method is called to determine the default location, which is "~/.appname".

getDefaultScriptExtension() - Method in class org.kohsuke.stapler.AbstractTearOff

The file extension of this kind of scripts, such as ".jelly" This is called "default" for historical reasons, but for disambiguation between different views and their facets, we don't support views other than their default extension.

getDisplayName() - Method in class org.kohsuke.stapler.Function

Gets the human readable name of this function.

getDynamic(String) - Method in class org.kohsuke.stapler.bind.BoundObjectTable.Table

getFacet(Class<T>) - Method in class org.kohsuke.stapler.WebApp

If the facet of the given type exists, return it.

getFileItem(String) - Method in class org.kohsuke.stapler.RequestImpl

getFileItem(String) - Method in interface org.kohsuke.stapler.StaplerRequest

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

getFullUrl() - Method in interface org.kohsuke.stapler.Ancestor

Gets the complete URL to this ancestor.

getGenericParameterTypes() - Method in class org.kohsuke.stapler.Function

getGenericType() - Method in class org.kohsuke.stapler.export.Property

getHomeDir() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Determines the home directory for the application.

getJavadoc() - Method in class org.kohsuke.stapler.export.Property

Gets the associated javadoc, if any, or null.

getKlass(Object) - Method in class org.kohsuke.stapler.Facet

Maps an instance to a Klass.

getKlass(Object) - Method in class org.kohsuke.stapler.WebApp

getMessage() - Method in class org.kohsuke.stapler.framework.errors.ErrorObject

Gets the error message.

getMessage() - Method in class org.kohsuke.stapler.framework.errors.NoHomeDirError

getMetaClass(Class) - Method in class org.kohsuke.stapler.WebApp

getMetaClass(Klass<?>) - Method in class org.kohsuke.stapler.WebApp

getMetaClass(Object) - Method in class org.kohsuke.stapler.WebApp

Obtains a MetaClass that represents the type of the given object.

getName() - Method in class org.kohsuke.stapler.Function

Gets the method name.

getNext() - Method in interface org.kohsuke.stapler.Ancestor

Gets the next ancestor, or null if none (meaning this is the 'it' object.

getNextToken(int) - Method in interface org.kohsuke.stapler.Ancestor

Of the tokens that constitute Ancestor.getRestOfUrl(), return the n-th token.

getObject() - Method in interface org.kohsuke.stapler.Ancestor

Gets the model object of the application.

getOriginalRequestURI() - Method in class org.kohsuke.stapler.RequestImpl

getOriginalRequestURI() - Method in interface org.kohsuke.stapler.StaplerRequest

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

getOriginalRestOfPath() - Method in class org.kohsuke.stapler.RequestImpl

getOriginalRestOfPath() - Method in interface org.kohsuke.stapler.StaplerRequest

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

getOutputStream() - Method in class org.kohsuke.stapler.compression.CompressionServletResponse

getOutputStream() - Method in class org.kohsuke.stapler.ResponseImpl

getOverrides() - Method in interface org.kohsuke.stapler.StaplerOverridable

Returns a list of overridables.

getParameterAnnotations() - Method in class org.kohsuke.stapler.Function

Gets the annotations on parameters.

getParameterNames() - Method in class org.kohsuke.stapler.Function

Gets the list of parameter names.

getParameterTypes() - Method in class org.kohsuke.stapler.Function

Gets the type of parameters in a single array.

getPrev() - Method in interface org.kohsuke.stapler.Ancestor

Gets the previous ancestor, or null if none (meaning this is the root object.)

getProperties() - Method in class org.kohsuke.stapler.export.Model

Gets all the exported properties.

getProxyScript() - Method in class org.kohsuke.stapler.bind.Bound

Returns a JavaScript expression which evaluates to a JavaScript proxy that talks back to the bound object that this handle represents.

getQualifiedName() - Method in class org.kohsuke.stapler.Function

Gets "className.methodName"

getReferer() - Method in class org.kohsuke.stapler.RequestImpl

getReferer() - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the referer header (like "http://foobar.com/zot") or null.

getRelativePath() - Method in interface org.kohsuke.stapler.Ancestor

Gets the relative path from the current object to this ancestor.

getRequestURIWithQueryString() - Method in class org.kohsuke.stapler.RequestImpl

getRequestURIWithQueryString() - Method in interface org.kohsuke.stapler.StaplerRequest

HttpServletRequest.getRequestURI() plus additional query string part, if it exists.

getRequestURLWithQueryString() - Method in class org.kohsuke.stapler.RequestImpl

getRequestURLWithQueryString() - Method in interface org.kohsuke.stapler.StaplerRequest

HttpServletRequest.getRequestURL() plus additional query string part, if it exists.

getResource(String) - Method in class org.kohsuke.stapler.AbstractTearOff

getResource(String) - Method in class org.kohsuke.stapler.CachingScriptLoader

getResource(String) - Method in class org.kohsuke.stapler.lang.Klass

getResource(C, String) - Method in class org.kohsuke.stapler.lang.KlassNavigator

Loads the resources associated with this class.

getResponseRenderers() - Method in class org.kohsuke.stapler.WebApp

getRestOfPath() - Method in class org.kohsuke.stapler.RequestImpl

getRestOfPath() - Method in interface org.kohsuke.stapler.StaplerRequest

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

getRestOfUrl() - Method in interface org.kohsuke.stapler.Ancestor

Gets the remaining URL after this ancestor.

getReturnType() - Method in class org.kohsuke.stapler.Function

Return type of the method.

getRootPath() - Method in class org.kohsuke.stapler.RequestImpl

getRootPath() - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the part of the request URL from protocol up to the context path.

getServletContext() - Method in class org.kohsuke.stapler.RequestImpl

getServletContext() - Method in interface org.kohsuke.stapler.StaplerRequest

Returns the ServletContext object given to the stapler dispatcher servlet.

getStapler() - Method in class org.kohsuke.stapler.RequestImpl

getStapler() - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the Stapler instance that this belongs to.

getStaplerFallback() - Method in class org.kohsuke.stapler.bind.BoundObjectTable

getStaplerFallback() - Method in interface org.kohsuke.stapler.StaplerFallback

Returns the object that is further searched for processing web requests.

getSubmittedForm() - Method in class org.kohsuke.stapler.RequestImpl

getSubmittedForm() - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the content of the structured form submission.

getSuperClass() - Method in class org.kohsuke.stapler.lang.Klass

getSuperClass(C) - Method in class org.kohsuke.stapler.lang.KlassNavigator

Gets the super class.

getTable() - Method in class org.kohsuke.stapler.bind.BoundObjectTable

Explicit call to create the table if one doesn't exist yet.

getTarget() - Method in class org.kohsuke.stapler.bind.Bound

Gets the bound object.

getTarget() - Method in interface org.kohsuke.stapler.StaplerProxy

Returns the object that is responsible for processing web requests.

getTearOff(Class<T>) - Method in class org.kohsuke.stapler.TearOffSupport

getTemporaryFile() - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

Until the data is committed, this file captures the written content.

getType() - Method in exception org.kohsuke.stapler.export.NotExportableException

Gets the type that didn't have ExportedBean

getType() - Method in class org.kohsuke.stapler.export.Property

getTypeArgument(Type, int) - Static method in class org.kohsuke.stapler.export.TypeUtil

getUrl() - Method in interface org.kohsuke.stapler.Ancestor

Gets the URL to this ancestor.

getURL() - Method in class org.kohsuke.stapler.bind.Bound

The URL where the object is bound to.

getValue(Object) - Method in class org.kohsuke.stapler.export.Property

Gets the value of this property from the bean.

getView(Object, String) - Method in class org.kohsuke.stapler.RequestImpl

getView(Class, String) - Method in class org.kohsuke.stapler.RequestImpl

getView(Klass<?>, String) - Method in class org.kohsuke.stapler.RequestImpl

getView(Klass<?>, Object, String) - Method in class org.kohsuke.stapler.RequestImpl

getView(Object, String) - Method in interface org.kohsuke.stapler.StaplerRequest

Gets the RequestDispatcher that represents a specific view for the given object.

getView(Class, String) - Method in interface org.kohsuke.stapler.StaplerRequest

Convenience method to call StaplerRequest.getView(Klass, String) with Class.

getView(Klass<?>, String) - Method in interface org.kohsuke.stapler.StaplerRequest

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

getViewURL(Class, String) - Static method in class org.kohsuke.stapler.Stapler

Gets the URL (e.g., "/WEB-INF/side-files/fully/qualified/class/name/jspName") from a class and the JSP name.

getVmDefaultValueFor(Class<?>) - Static method in class org.kohsuke.stapler.ReflectionUtils

Given the primitive type, returns the VM default value for that type in a boxed form.

getWebApp() - Method in class org.kohsuke.stapler.AbstractTearOff

getWebApp() - Method in class org.kohsuke.stapler.RequestImpl

getWebApp() - Method in class org.kohsuke.stapler.Stapler

getWebApp() - Method in interface org.kohsuke.stapler.StaplerRequest

Short for getStapler().getWebApp()

getWellKnownUrl() - Method in interface org.kohsuke.stapler.bind.WithWellKnownURL

getWriter() - Method in class org.kohsuke.stapler.compression.CompressionServletResponse

getWriter() - Method in class org.kohsuke.stapler.ResponseImpl

getXmlTypeName(Class<?>) - Method in class org.kohsuke.stapler.export.SchemaGenerator

H

handleHttpResponse(StaplerRequest, StaplerResponse, Object, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer.Default

handleIndexRequest(RequestImpl, ResponseImpl, Object, MetaClass) - Method in class org.kohsuke.stapler.Facet

Attempts to route the HTTP request to the 'index' page of the 'it' object.

handleIndexRequest(RequestImpl, ResponseImpl, Object, MetaClass) - Method in class org.kohsuke.stapler.StaticViewFacet

handleJavaScriptProxyMethodCall(StaplerRequest, StaplerResponse, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer.Default

handleJSON(StaplerResponse, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer.Default

handlePrimitive(StaplerResponse, Object) - Method in class org.kohsuke.stapler.HttpResponseRenderer.Default

has(ServletRequest) - Static method in class org.kohsuke.stapler.compression.CompressionFilter

Is this request already wrapped into CompressionFilter?

hashCode() - Method in class org.kohsuke.stapler.lang.Klass

hasMore() - Method in class org.kohsuke.stapler.TokenList

hasParameter(String) - Method in class org.kohsuke.stapler.RequestImpl

hasParameter(String) - Method in interface org.kohsuke.stapler.StaplerRequest

Short for getParameter(name)!=null

Header - Annotation Type in org.kohsuke.stapler

Indicates that this parameter is bound from HTTP header.

home - Variable in class org.kohsuke.stapler.framework.AbstractWebAppMain

Once the home directory is determined, this value is set to that directory.

home - Variable in class org.kohsuke.stapler.framework.errors.NoHomeDirError

html(String) - Static method in class org.kohsuke.stapler.HttpResponses

Serves the literal HTML.

HttpDeletable - Interface in org.kohsuke.stapler

Marks the object that can handle HTTP DELETE.

HttpRedirect - Exception in org.kohsuke.stapler

HttpResponse that dose HTTP 302 redirect.

HttpRedirect(String) - Constructor for exception org.kohsuke.stapler.HttpRedirect

HttpRedirect(int, String) - Constructor for exception org.kohsuke.stapler.HttpRedirect

HttpResponse - Interface in org.kohsuke.stapler

Object that represents the HTTP response, which is defined as a capability to produce the response.

HttpResponseRenderer - Class in org.kohsuke.stapler

Pluggable interface that takes the return value from request handling methods and convert that to HTTP responses.

HttpResponseRenderer() - Constructor for class org.kohsuke.stapler.HttpResponseRenderer

HttpResponseRenderer.Default - Class in org.kohsuke.stapler

Default HttpResponseRenderer.

HttpResponseRenderer.Default() - Constructor for class org.kohsuke.stapler.HttpResponseRenderer.Default

HttpResponses - Class in org.kohsuke.stapler

Factory for HttpResponse.

HttpResponses() - Constructor for class org.kohsuke.stapler.HttpResponses

HttpResponses.HttpResponseException - Exception in org.kohsuke.stapler

HttpResponses.HttpResponseException() - Constructor for exception org.kohsuke.stapler.HttpResponses.HttpResponseException

HttpResponses.HttpResponseException(String) - Constructor for exception org.kohsuke.stapler.HttpResponses.HttpResponseException

HttpResponses.HttpResponseException(String, Throwable) - Constructor for exception org.kohsuke.stapler.HttpResponses.HttpResponseException

HttpResponses.HttpResponseException(Throwable) - Constructor for exception org.kohsuke.stapler.HttpResponses.HttpResponseException

I

idx - Variable in class org.kohsuke.stapler.TokenList

Index of the next token.

init(FilterConfig) - Method in class org.kohsuke.stapler.compression.CompressionFilter

init(ServletConfig) - Method in class org.kohsuke.stapler.Stapler

inline - Variable in class org.kohsuke.stapler.export.Property

INT - Static variable in class org.kohsuke.stapler.export.XSD.Types

Interceptor - Class in org.kohsuke.stapler.interceptor

Intercepts the domain method call from Stapler.

Interceptor() - Constructor for class org.kohsuke.stapler.interceptor.Interceptor

InterceptorAnnotation - Annotation Type in org.kohsuke.stapler.interceptor

Marks the annotation as an interceptor annotation, which executes before/after the method invocation of domain objects happen as a part of the request processing.

invoke(StaplerRequest, StaplerResponse, Object, Object...) - Method in class org.kohsuke.stapler.Function

Invokes the method.

invoke(StaplerRequest, StaplerResponse, Object, Object[]) - Method in class org.kohsuke.stapler.interceptor.Interceptor

Intercepts the call.

invoke(StaplerRequest, StaplerResponse, Object, Object[]) - Method in class org.kohsuke.stapler.interceptor.RequirePOST.Processor

invoke(StaplerRequest, StaplerResponse, Object, Object[]) - Method in class org.kohsuke.stapler.LimitedTo.Processor

invoke(HttpServletRequest, HttpServletResponse, Object, String) - Method in class org.kohsuke.stapler.Stapler

Performs stapler processing on the given root object and request URL.

IOException2 - Exception in org.kohsuke.stapler.framework.io

IOException with missing constructors.

IOException2() - Constructor for exception org.kohsuke.stapler.framework.io.IOException2

IOException2(String) - Constructor for exception org.kohsuke.stapler.framework.io.IOException2

IOException2(String, Throwable) - Constructor for exception org.kohsuke.stapler.framework.io.IOException2

IOException2(Throwable) - Constructor for exception org.kohsuke.stapler.framework.io.IOException2

isComplete() - Method in class org.kohsuke.stapler.framework.io.LargeText

isJavaScriptProxyCall() - Method in class org.kohsuke.stapler.RequestImpl

isJavaScriptProxyCall() - Method in interface org.kohsuke.stapler.StaplerRequest

Returns true if this request represents a server method call to a JavaScript proxy object.

issueCrumb(StaplerRequest) - Method in class org.kohsuke.stapler.CrumbIssuer

Issues a crumb for the given request.

issueCrumb() - Method in class org.kohsuke.stapler.CrumbIssuer

isTraceEnabled(StaplerRequest) - Static method in class org.kohsuke.stapler.Dispatcher

Checks if tracing is enabled for the given request.

J

java(Class) - Static method in class org.kohsuke.stapler.lang.Klass

Creates Klass from a Java Class.

JAVA - Static variable in class org.kohsuke.stapler.lang.KlassNavigator

JavaScriptMethod - Annotation Type in org.kohsuke.stapler.bind

Indicates that the method is exposed to client-side JavaScript proxies and is callable as a method from them.

K

Klass<C> - Class in org.kohsuke.stapler.lang

Abstraction of class-like object, agnostic to languages.

Klass(C, KlassNavigator<C>) - Constructor for class org.kohsuke.stapler.lang.Klass

klass - Variable in class org.kohsuke.stapler.MetaClass

KlassNavigator<C> - Class in org.kohsuke.stapler.lang

Strategy pattern to provide navigation across class-like objects in other languages of JVM.

KlassNavigator() - Constructor for class org.kohsuke.stapler.lang.KlassNavigator

L

LargeText - Class in org.kohsuke.stapler.framework.io

Represents a large text data.

LargeText(File, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

LargeText(File, boolean, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

LargeText(File, Charset, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

LargeText(File, Charset, boolean, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

LargeText(ByteBuffer, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

LargeText(ByteBuffer, Charset, boolean) - Constructor for class org.kohsuke.stapler.framework.io.LargeText

length() - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

length() - Method in class org.kohsuke.stapler.framework.io.LargeText

length() - Method in class org.kohsuke.stapler.TokenList

LimitedTo - Annotation Type in org.kohsuke.stapler

Declares that methods are only available for requests that have the specified role(s).

LimitedTo.Processor - Class in org.kohsuke.stapler

LimitedTo.Processor() - Constructor for class org.kohsuke.stapler.LimitedTo.Processor

LineEndNormalizingWriter - Class in org.kohsuke.stapler.framework.io

Finds the lone LF and converts that to CR+LF.

LineEndNormalizingWriter(Writer) - Constructor for class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

loadConstructorParamNames() - Method in class org.kohsuke.stapler.ClassDescriptor

Determines the constructor parameter names.

loader - Variable in class org.kohsuke.stapler.MetaClassLoader

loadParameterNames(Method) - Static method in class org.kohsuke.stapler.ClassDescriptor

Loads the list of parameter names of the given method, by using a stapler-specific way of getting it.

loadParameterNames(Constructor<?>) - Static method in class org.kohsuke.stapler.ClassDescriptor

Loads the list of parameter names of the given method, by using a stapler-specific way of getting it.

loadScript(String) - Method in class org.kohsuke.stapler.AbstractTearOff

loadScript(String) - Method in class org.kohsuke.stapler.CachingScriptLoader

Cache-less version of the CachingScriptLoader.findScript(String) that provides the actual logic.

loadTearOff(Class<T>) - Method in class org.kohsuke.stapler.TearOffSupport

LOGGER - Static variable in class org.kohsuke.stapler.Facet

LONG - Static variable in class org.kohsuke.stapler.export.XSD.Types

lookupConverter(Class) - Static method in class org.kohsuke.stapler.Stapler

M

markAsComplete() - Method in class org.kohsuke.stapler.framework.io.LargeText

maxOccurs(String) - Method in interface org.kohsuke.stapler.export.XSD.Element

MetaClass - Class in org.kohsuke.stapler

Created one instance each for a Klass, that retains some useful cache about a class and its views.

MetaClassLoader - Class in org.kohsuke.stapler

The stapler version of the ClassLoader object, that retains some useful cache about a class loader.

MetaClassLoader(ClassLoader) - Constructor for class org.kohsuke.stapler.MetaClassLoader

methods - Variable in class org.kohsuke.stapler.ClassDescriptor

mimeTypes - Variable in class org.kohsuke.stapler.WebApp

MIME type mapping from extensions (like "txt" or "jpg") to MIME types ("foo/bar").

minOccurs(int) - Method in interface org.kohsuke.stapler.export.XSD.Element

Model<T> - Class in org.kohsuke.stapler.export

Writes all the property of one ExportedBean to DataWriter.

ModelBuilder - Class in org.kohsuke.stapler.export

Creates and maintains Models, that are used to write out the value representation of exposed beans.

ModelBuilder() - Constructor for class org.kohsuke.stapler.export.ModelBuilder

N

name - Variable in class org.kohsuke.stapler.AttributeKey

name(String) - Method in interface org.kohsuke.stapler.export.DataWriter

name - Variable in class org.kohsuke.stapler.export.Property

Name of the property.

name(String) - Method in interface org.kohsuke.stapler.export.XSD.ComplexType

name(String) - Method in interface org.kohsuke.stapler.export.XSD.Element

name(String) - Method in interface org.kohsuke.stapler.export.XSD.SimpleType

NamedPathPruner - Class in org.kohsuke.stapler.export

Tree pruner which operates according to a textual description of what tree leaves should be included.

NamedPathPruner(String) - Constructor for class org.kohsuke.stapler.export.NamedPathPruner

Constructs a pruner by parsing a textual specification.

navigator - Variable in class org.kohsuke.stapler.lang.Klass

newInputStream() - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

Creates an InputStream that reads from the underlying buffer.

next() - Method in class org.kohsuke.stapler.TokenList

nextAsInt() - Method in class org.kohsuke.stapler.TokenList

NO_CACHE - Static variable in class org.kohsuke.stapler.MetaClass

Don't cache anything in memory, so that any change will take effect instantly.

NoHomeDirError - Class in org.kohsuke.stapler.framework.errors

Model object used to display the error top page if we couldn't create the home directory.

NoHomeDirError(File) - Constructor for class org.kohsuke.stapler.framework.errors.NoHomeDirError

NOOP - Static variable in class org.kohsuke.stapler.BindInterceptor

Default BindInterceptor that does nothing.

NoStaplerConstructorException - Exception in org.kohsuke.stapler

NoStaplerConstructorException(String) - Constructor for exception org.kohsuke.stapler.NoStaplerConstructorException

NoStaplerConstructorException(String, Throwable) - Constructor for exception org.kohsuke.stapler.NoStaplerConstructorException

NoStaplerConstructorException(Throwable) - Constructor for exception org.kohsuke.stapler.NoStaplerConstructorException

NotExportableException - Exception in org.kohsuke.stapler.export

Signals an error that the class didn't have ExportedBean.

NotExportableException(Class) - Constructor for exception org.kohsuke.stapler.export.NotExportableException

NotExportableException(String, Class) - Constructor for exception org.kohsuke.stapler.export.NotExportableException

NotExportableException(String, Throwable, Class) - Constructor for exception org.kohsuke.stapler.export.NotExportableException

NotExportableException(Throwable, Class) - Constructor for exception org.kohsuke.stapler.export.NotExportableException

notFound() - Static method in class org.kohsuke.stapler.HttpResponses

O

ok() - Static method in class org.kohsuke.stapler.HttpResponses

onConvert(Type, Class, Object) - Method in class org.kohsuke.stapler.BindInterceptor

Called for each object conversion.

optional() - Method in exception org.kohsuke.stapler.ForwardToView

Make this forwarding optional.

org.kohsuke.stapler - package org.kohsuke.stapler

Stapler URL->Object mapping framework.

org.kohsuke.stapler.bind - package org.kohsuke.stapler.bind

Subsystem for exposing arbitrary objects on per-session basis to the URL space.

org.kohsuke.stapler.compression - package org.kohsuke.stapler.compression

org.kohsuke.stapler.config - package org.kohsuke.stapler.config

org.kohsuke.stapler.export - package org.kohsuke.stapler.export

Mechanism for writing out a graph of model objects in a machine readable format.

org.kohsuke.stapler.framework - package org.kohsuke.stapler.framework

org.kohsuke.stapler.framework.errors - package org.kohsuke.stapler.framework.errors

org.kohsuke.stapler.framework.io - package org.kohsuke.stapler.framework.io

org.kohsuke.stapler.interceptor - package org.kohsuke.stapler.interceptor

org.kohsuke.stapler.jsr269 - package org.kohsuke.stapler.jsr269

org.kohsuke.stapler.lang - package org.kohsuke.stapler.lang

owner - Variable in class org.kohsuke.stapler.AbstractTearOff

P

parent - Variable in class org.kohsuke.stapler.export.Property

Model to which this property belongs to.

parent - Variable in class org.kohsuke.stapler.MetaClassLoader

parseScript(URL) - Method in class org.kohsuke.stapler.AbstractTearOff

Compiles a script into the compiled form.

peek() - Method in class org.kohsuke.stapler.TokenList

plainText(String) - Static method in class org.kohsuke.stapler.HttpResponses

Serves the plain text.

PREFIX - Static variable in class org.kohsuke.stapler.bind.BoundObjectTable

prettyPrint - Variable in class org.kohsuke.stapler.export.ExportConfig

If true, output will be indented to make it easier for humans to understand.

prev() - Method in class org.kohsuke.stapler.TokenList

printHtml(PrintWriter) - Method in class org.kohsuke.stapler.EvaluationTrace

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.kohsuke.stapler.jsr269.ConstructorProcessor

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.kohsuke.stapler.jsr269.ExportedBeanAnnotationProcessor

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.kohsuke.stapler.jsr269.QueryParameterAnnotationProcessor

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.kohsuke.stapler.jsr269.WebMethodAnnotationProcessor

Property - Class in org.kohsuke.stapler.export

Exposes one exposed property of ExportedBean to DataWriter.

Q

QueryParameter - Annotation Type in org.kohsuke.stapler

Indicates that this parameter is injected from HTTP query parameter.

QueryParameterAnnotationProcessor - Class in org.kohsuke.stapler.jsr269

QueryParameterAnnotationProcessor() - Constructor for class org.kohsuke.stapler.jsr269.QueryParameterAnnotationProcessor

R

rawTokens - Variable in class org.kohsuke.stapler.TokenList

readAll() - Method in class org.kohsuke.stapler.framework.io.LargeText

Returns Reader for reading the raw bytes.

redirectTo(String) - Static method in class org.kohsuke.stapler.HttpResponses

redirectTo(int, String) - Static method in class org.kohsuke.stapler.HttpResponses

redirectToContextRoot() - Static method in class org.kohsuke.stapler.HttpResponses

Redirect to the context root

redirectToDot() - Static method in class org.kohsuke.stapler.HttpResponses

Redirect to "."

redirectViaContextPath(String) - Static method in class org.kohsuke.stapler.HttpResponses

redirectViaContextPath(int, String) - Static method in class org.kohsuke.stapler.HttpResponses

ReflectionUtils - Class in org.kohsuke.stapler

ReflectionUtils() - Constructor for class org.kohsuke.stapler.ReflectionUtils

release() - Method in class org.kohsuke.stapler.bind.Bound

Explicitly unbind this object.

releaseMe() - Method in class org.kohsuke.stapler.bind.BoundObjectTable

Called from within the request handling of a bound object, to release the object explicitly.

remove(HttpServletRequest) - Method in class org.kohsuke.stapler.AttributeKey

remove() - Method in class org.kohsuke.stapler.AttributeKey

RequestImpl - Class in org.kohsuke.stapler

StaplerRequest implementation.

RequestImpl(Stapler, HttpServletRequest, List<AncestorImpl>, TokenList) - Constructor for class org.kohsuke.stapler.RequestImpl

requestScoped() - Static method in class org.kohsuke.stapler.AttributeKey

Creates a new request-scoped AttributeKey.

RequirePOST - Annotation Type in org.kohsuke.stapler.interceptor

Requires the request to be a POST.

RequirePOST.Processor - Class in org.kohsuke.stapler.interceptor

RequirePOST.Processor() - Constructor for class org.kohsuke.stapler.interceptor.RequirePOST.Processor

resolveScript(String) - Method in class org.kohsuke.stapler.AbstractTearOff

Loads the script just from the target class without considering inherited scripts from its base types.

ResponseImpl - Class in org.kohsuke.stapler

StaplerResponse implementation.

ResponseImpl(Stapler, HttpServletResponse) - Constructor for class org.kohsuke.stapler.ResponseImpl

restriction() - Method in interface org.kohsuke.stapler.export.XSD.SimpleType

returnNull() - Static method in class org.kohsuke.stapler.Function

reverseProxyTo(URL, StaplerRequest) - Method in class org.kohsuke.stapler.ResponseImpl

reverseProxyTo(URL, StaplerRequest) - Method in interface org.kohsuke.stapler.StaplerResponse

Performs the reverse proxy to the given URL.

rootType - Variable in class org.kohsuke.stapler.framework.AbstractWebAppMain

S

SchemaGenerator - Class in org.kohsuke.stapler.export

Generates XML Schema that describes the XML representation of exported beans.

SchemaGenerator(Model<?>) - Constructor for class org.kohsuke.stapler.export.SchemaGenerator

ScriptLoadException - Exception in org.kohsuke.stapler

Indicates a failure to load a script.

ScriptLoadException(String, Throwable) - Constructor for exception org.kohsuke.stapler.ScriptLoadException

ScriptLoadException(Throwable) - Constructor for exception org.kohsuke.stapler.ScriptLoadException

sendRedirect(String) - Method in class org.kohsuke.stapler.ResponseImpl

sendRedirect(int, String) - Method in class org.kohsuke.stapler.ResponseImpl

sendRedirect(int, String) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like StaplerResponse.sendRedirect2(String) but allows the caller to specify the HTTP status code.

sendRedirect2(String) - Method in class org.kohsuke.stapler.ResponseImpl

sendRedirect2(String) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like HttpServletResponse.sendRedirect(String) except that this method escapes the URL.

sequence() - Method in interface org.kohsuke.stapler.export.XSD.ComplexType

sequence() - Method in interface org.kohsuke.stapler.export.XSD.Restriction

serveExposedBean(StaplerRequest, Object, Flavor) - Method in class org.kohsuke.stapler.ResponseImpl

serveExposedBean(StaplerRequest, Object, Flavor) - Method in interface org.kohsuke.stapler.StaplerResponse

Serves the exposed bean in the specified flavor.

serveFile(StaplerRequest, URL, long) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, URL) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, InputStream, long, long, long, String) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, InputStream, long, long, int, String) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, InputStream, long, long, String) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, InputStream, long, int, String) - Method in class org.kohsuke.stapler.ResponseImpl

serveFile(StaplerRequest, URL) - Method in interface org.kohsuke.stapler.StaplerResponse

Serves a static resource.

serveFile(StaplerRequest, URL, long) - Method in interface org.kohsuke.stapler.StaplerResponse

serveFile(StaplerRequest, InputStream, long, long, long, String) - Method in interface org.kohsuke.stapler.StaplerResponse

Serves a static resource.

serveFile(StaplerRequest, InputStream, long, long, int, String) - Method in interface org.kohsuke.stapler.StaplerResponse

serveFile(StaplerRequest, InputStream, long, long, String) - Method in interface org.kohsuke.stapler.StaplerResponse

Serves a static resource.

serveFile(StaplerRequest, InputStream, long, int, String) - Method in interface org.kohsuke.stapler.StaplerResponse

serveLocalizedFile(StaplerRequest, URL) - Method in class org.kohsuke.stapler.ResponseImpl

serveLocalizedFile(StaplerRequest, URL, long) - Method in class org.kohsuke.stapler.ResponseImpl

serveLocalizedFile(StaplerRequest, URL) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like StaplerResponse.serveFile(StaplerRequest, URL) but chooses the locale specific version of the resource if it's available.

serveLocalizedFile(StaplerRequest, URL, long) - Method in interface org.kohsuke.stapler.StaplerResponse

Works like StaplerResponse.serveFile(StaplerRequest, URL, long) but chooses the locale specific version of the resource if it's available.

service(HttpServletRequest, HttpServletResponse) - Method in class org.kohsuke.stapler.Stapler

sessionScoped() - Static method in class org.kohsuke.stapler.AttributeKey

Creates a new session-scoped AttributeKey.

set(HttpServletRequest, T) - Method in class org.kohsuke.stapler.AttributeKey

set(T) - Method in class org.kohsuke.stapler.AttributeKey

setApp(Object) - Method in class org.kohsuke.stapler.WebApp

setApplicationObject() - Method in class org.kohsuke.stapler.framework.AbstractWebAppMain

Sets the root application object.

setBindListener(BindInterceptor) - Method in class org.kohsuke.stapler.RequestImpl

setBindListener(BindInterceptor) - Method in interface org.kohsuke.stapler.StaplerRequest

setClassLoader(ServletContext, ClassLoader) - Static method in class org.kohsuke.stapler.Stapler

Deprecated.

Use WebApp.setClassLoader(ClassLoader)

setClassLoader(ClassLoader) - Method in class org.kohsuke.stapler.WebApp

Sets the classloader used by StaplerRequest.bindJSON(Class, JSONObject) and its sibling methods.

setContentType(StaplerResponse) - Method in class org.kohsuke.stapler.framework.io.LargeText

setCrumbIssuer(CrumbIssuer) - Method in class org.kohsuke.stapler.WebApp

setHeader(String, String) - Method in class org.kohsuke.stapler.compression.CompressionServletResponse

setRoot(ServletContextEvent, Object) - Static method in class org.kohsuke.stapler.Stapler

Sets the specified object as the root of the web application.

setTarget(Function) - Method in class org.kohsuke.stapler.interceptor.Interceptor

Called by Stapler to set up the target of the interceptor.

setTarget(Function) - Method in class org.kohsuke.stapler.LimitedTo.Processor

setTearOff(Class<T>, T) - Method in class org.kohsuke.stapler.TearOffSupport

simpleType() - Method in interface org.kohsuke.stapler.export.XSD.Schema

stapler - Variable in class org.kohsuke.stapler.RequestImpl

Stapler - Class in org.kohsuke.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.

Stapler() - Constructor for class org.kohsuke.stapler.Stapler

StaplerFallback - Interface in org.kohsuke.stapler

An object can fall back to another object for a part of its UI processing, by implementing this interface and designating another object from StaplerFallback.getStaplerFallback().

StaplerOverridable - Interface in org.kohsuke.stapler

A web-bound object can implement this interface to allow designated objects to selectively override URL mappings.

StaplerProxy - Interface in org.kohsuke.stapler

If an object delegates all its UI processing to another object, it can implement this interface and return the designated object from the StaplerProxy.getTarget() method.

StaplerRequest - Interface in org.kohsuke.stapler

Defines additional parameters/operations made available by Stapler.

StaplerResponse - Interface in org.kohsuke.stapler

Defines additional operations made available by Stapler.

startArray() - Method in interface org.kohsuke.stapler.export.DataWriter

startObject() - Method in interface org.kohsuke.stapler.export.DataWriter

staticResource(URL) - Static method in class org.kohsuke.stapler.HttpResponses

Serves a static resource specified by the URL.

staticResource(URL, long) - Static method in class org.kohsuke.stapler.HttpResponses

Serves a static resource specified by the URL.

StaticViewFacet - Class in org.kohsuke.stapler

StaticViewFacet(String...) - Constructor for class org.kohsuke.stapler.StaticViewFacet

StaticViewFacet(Collection<String>) - Constructor for class org.kohsuke.stapler.StaticViewFacet

status(int) - Static method in class org.kohsuke.stapler.HttpResponses

STRING - Static variable in class org.kohsuke.stapler.export.XSD.Types

superModel - Variable in class org.kohsuke.stapler.export.Model

Model for the super class.

T

target - Variable in class org.kohsuke.stapler.interceptor.Interceptor

TearOffSupport - Class in org.kohsuke.stapler

Allows "tear-off" objects to be linked to the parent object.

TearOffSupport() - Constructor for class org.kohsuke.stapler.TearOffSupport

toExportedObject() - Method in interface org.kohsuke.stapler.export.CustomExportedBean

The returned object will be introspected and written as JSON/XML.

toJavaClass() - Method in class org.kohsuke.stapler.lang.Klass

toJavaClass(C) - Method in class org.kohsuke.stapler.lang.KlassNavigator

For backward compatibility, map the given class to the closest Java equivalent.

TokenList - Class in org.kohsuke.stapler

Tokenized strings.

tokens - Variable in class org.kohsuke.stapler.RequestImpl

Tokenized URLs and consumed tokens.

tokens - Variable in class org.kohsuke.stapler.TokenList

toString() - Method in class org.kohsuke.stapler.Dispatcher

Diagnostic string that explains this dispatch rule.

toString() - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

toString() - Method in class org.kohsuke.stapler.lang.Klass

toString() - Method in class org.kohsuke.stapler.TokenList

TRACE - Static variable in class org.kohsuke.stapler.Dispatcher

This flag will activate the evaluation trace.

trace(StaplerRequest, StaplerResponse, String, Object...) - Static method in class org.kohsuke.stapler.Dispatcher

trace(StaplerRequest, StaplerResponse, String) - Static method in class org.kohsuke.stapler.Dispatcher

trace(StaplerResponse, String) - Method in class org.kohsuke.stapler.EvaluationTrace

TRACE_PER_REQUEST - Static variable in class org.kohsuke.stapler.Dispatcher

This flag will activate the per-request evaluation trace for requests that have X-Stapler-Trace set to "true".

traceable() - Static method in class org.kohsuke.stapler.Dispatcher

traceEval(StaplerRequest, StaplerResponse, Object) - Static method in class org.kohsuke.stapler.Dispatcher

traceEval(StaplerRequest, StaplerResponse, Object, String, String) - Static method in class org.kohsuke.stapler.Dispatcher

traceEval(StaplerRequest, StaplerResponse, Object, String) - Static method in class org.kohsuke.stapler.Dispatcher

TreePruner - Class in org.kohsuke.stapler.export

Controls the portion of the object graph to be written to DataWriter.

TreePruner() - Constructor for class org.kohsuke.stapler.export.TreePruner

TreePruner.ByDepth - Class in org.kohsuke.stapler.export

TreePruner.ByDepth(int) - Constructor for class org.kohsuke.stapler.export.TreePruner.ByDepth

type - Variable in class org.kohsuke.stapler.export.Model

The class being modeled.

type(QName) - Method in interface org.kohsuke.stapler.export.XSD.Element

TypeUtil - Class in org.kohsuke.stapler.export

Type arithmetic code.

TypeUtil() - Constructor for class org.kohsuke.stapler.export.TypeUtil

U

UNSPECIFIED - Static variable in annotation type org.kohsuke.stapler.config.Configuration

URI - Static variable in interface org.kohsuke.stapler.export.XSD

V

validateCrumb(StaplerRequest, String) - Method in class org.kohsuke.stapler.CrumbIssuer

Validates a crumb that was submitted along with the request.

value(String) - Method in interface org.kohsuke.stapler.export.DataWriter

value(String) - Method in interface org.kohsuke.stapler.export.XSD.Enumeration

valueNull() - Method in interface org.kohsuke.stapler.export.DataWriter

valueOf(String) - Static method in enum org.kohsuke.stapler.export.Flavor

Returns the enum constant of this type with the specified name.

valuePrimitive(Object) - Method in interface org.kohsuke.stapler.export.DataWriter

values() - Static method in enum org.kohsuke.stapler.export.Flavor

Returns an array containing the constants of this enum type, in the order they are declared.

visibility - Variable in class org.kohsuke.stapler.export.Property

Visibility depth level of this property.

visit(ASTNode[], SourceUnit) - Method in class org.kohsuke.stapler.CaptureParameterNameTransformation

W

webApp - Variable in class org.kohsuke.stapler.MetaClass

WebApp that owns this meta class.

WebApp - Class in org.kohsuke.stapler

Object scoped to the entire webapp.

WebApp(ServletContext) - Constructor for class org.kohsuke.stapler.WebApp

WebMethod - Annotation Type in org.kohsuke.stapler

Indicates that the method is bound to HTTP and used to serve the HTTP request.

WebMethodAnnotationProcessor - Class in org.kohsuke.stapler.jsr269

WebMethodAnnotationProcessor() - Constructor for class org.kohsuke.stapler.jsr269.WebMethodAnnotationProcessor

with(String, Object) - Method in exception org.kohsuke.stapler.ForwardToView

Forwards to the view with specified attributes exposed as a variable binding.

with(Map<String, ?>) - Method in exception org.kohsuke.stapler.ForwardToView

WithWellKnownURL - Interface in org.kohsuke.stapler.bind

Marker interface for objects that have known URLs.

wrappers - Variable in class org.kohsuke.stapler.WebApp

Duck-type wrappers for the given class.

write(int) - Method in class org.kohsuke.stapler.compression.FilterServletOutputStream

write(byte[]) - Method in class org.kohsuke.stapler.compression.FilterServletOutputStream

write(byte[], int, int) - Method in class org.kohsuke.stapler.compression.FilterServletOutputStream

write(int) - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

write(String, int, int) - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

write(char[], int, int) - Method in class org.kohsuke.stapler.framework.io.AtomicFileWriter

write(byte[], int, int) - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

write(int) - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

write(char[], int, int) - Method in class org.kohsuke.stapler.framework.io.CharSpool

write(int) - Method in class org.kohsuke.stapler.framework.io.CharSpool

write(char[]) - Method in class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

write(String) - Method in class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

write(int) - Method in class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

write(char[], int, int) - Method in class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

write(String, int, int) - Method in class org.kohsuke.stapler.framework.io.LineEndNormalizingWriter

write(int) - Method in class org.kohsuke.stapler.framework.io.WriterOutputStream

write(byte[], int, int) - Method in class org.kohsuke.stapler.framework.io.WriterOutputStream

writeLogTo(long, Writer) - Method in class org.kohsuke.stapler.framework.io.LargeText

writeLogTo(long, OutputStream) - Method in class org.kohsuke.stapler.framework.io.LargeText

Writes the tail portion of the file to the OutputStream.

WriterOutputStream - Class in org.kohsuke.stapler.framework.io

OutputStream that writes to Writer by assuming the platform default encoding.

WriterOutputStream(Writer, Charset) - Constructor for class org.kohsuke.stapler.framework.io.WriterOutputStream

WriterOutputStream(Writer) - Constructor for class org.kohsuke.stapler.framework.io.WriterOutputStream

writeTo(T, DataWriter) - Method in class org.kohsuke.stapler.export.Model

Writes the property values of the given object to the writer.

writeTo(T, TreePruner, DataWriter) - Method in class org.kohsuke.stapler.export.Model

Writes the property values of the given object to the writer.

writeTo(T, int, DataWriter) - Method in class org.kohsuke.stapler.export.Model

Deprecated.

as of 1.139

writeTo(Object, TreePruner, DataWriter) - Method in class org.kohsuke.stapler.export.Property

Writes one property of the given object to DataWriter.

writeTo(Object, int, DataWriter) - Method in class org.kohsuke.stapler.export.Property

Deprecated.

as of 1.139

writeTo(OutputStream) - Method in class org.kohsuke.stapler.framework.io.ByteBuffer

Writes the contents of this buffer to another OutputStream.

writeTo(Writer) - Method in class org.kohsuke.stapler.framework.io.CharSpool

X

XSD - Interface in org.kohsuke.stapler.export

TXW interfaces to generate schema.

XSD.Annotated - Interface in org.kohsuke.stapler.export

XSD.Annotation - Interface in org.kohsuke.stapler.export

XSD.ComplexContent - Interface in org.kohsuke.stapler.export

XSD.ComplexType - Interface in org.kohsuke.stapler.export

XSD.ContentModel - Interface in org.kohsuke.stapler.export

XSD.Element - Interface in org.kohsuke.stapler.export

XSD.Enumeration - Interface in org.kohsuke.stapler.export

XSD.Restriction - Interface in org.kohsuke.stapler.export

XSD.Schema - Interface in org.kohsuke.stapler.export

XSD.SimpleType - Interface in org.kohsuke.stapler.export

XSD.Types - Class in org.kohsuke.stapler.export

XSD.Types() - Constructor for class org.kohsuke.stapler.export.XSD.Types

A B C D E F G H I J K L M N O P Q R S T U V W X