Package org.kohsuke.stapler.bind

Class BoundObjectTable

java.lang.Object

org.kohsuke.stapler.bind.BoundObjectTable

All Implemented Interfaces:

StaplerFallback

public class BoundObjectTable
extends Object
implements StaplerFallback

Objects exported and bound by JavaScript proxies. TODO: think about some kind of eviction strategy, beyond the session eviction. Maybe it's not necessary, I don't know.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BoundObjectTable.Table	Per-session table that remembers all the bound instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
BoundObjectTable()

Method Summary

Modifier and Type	Method	Description
Bound	bind(Object o)	Binds an object temporarily and returns its URL.
void	doScript(StaplerRequest2 req, StaplerResponse2 rsp, String var, String methods)	This serves the script content for a bound object.
BoundObjectTable.Table	getStaplerFallback()	Returns the object that is further searched for processing web requests.
BoundObjectTable.Table	getTable()	Explicit call to create the table if one doesn't exist yet.
static boolean	isValidJavaIdentifier(String name)
static boolean	isValidJavaScriptIdentifier(String variableName)
void	releaseMe()	Called from within the request handling of a bound object, to release the object explicitly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

Constructor Details

BoundObjectTable

public BoundObjectTable()

Method Details

isValidJavaScriptIdentifier

public static boolean isValidJavaScriptIdentifier(String variableName)

isValidJavaIdentifier

public static boolean isValidJavaIdentifier(String name)

doScript

public void doScript(StaplerRequest2 req,
 StaplerResponse2 rsp,
 @QueryParameter
 String var,
 @QueryParameter
 String methods)
              throws IOException

This serves the script content for a bound object. Support CSP-compatible st:bind and similar methods of making objects accessible to JS.

Parameters:

req - The request

rsp - The response

var - the variable name to assign the Stapler proxy to

methods - the list of methods (needed for WithWellKnownURL)

Throws:

IOException - If an I/O error occurs

getStaplerFallback

public BoundObjectTable.Table getStaplerFallback()

Description copied from interface: StaplerFallback

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

Specified by:

getStaplerFallback in interface StaplerFallback

Returns:

If null or this is returned, stapler behaves as if the object didn't implement this interface (which means the request processing fails with 404.)

bind

public Bound bind(Object o)

Binds an object temporarily and returns its URL.

releaseMe

public void releaseMe()

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

getTable

public BoundObjectTable.Table getTable()

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