Skip to content

Allow releasing bound objects via HTTP #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
daniel-beck wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Allow releasing bound objects via HTTP #665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0f043f1
Allow releasing bound objects via HTTP
daniel-beck May 8, 2025
f61fcbb
Thanks Spotless
daniel-beck May 8, 2025
7a94861
Add early returns after change from HttpResponseException
daniel-beck May 9, 2025
9650192
Merge branch 'master' into release-bound-http
daniel-beck Sep 10, 2025
397e467
Merge remote-tracking branch 'stapler/master' into release-bound-http
daniel-beck Sep 17, 2025
4b86808
Merge remote-tracking branch 'origin/release-bound-http' into release…
daniel-beck Sep 17, 2025
1a574b8
Merge branch 'master' into release-bound-http
daniel-beck Sep 19, 2025
da77af4
fix merge conflict
daniel-beck Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core/src/main/java/org/kohsuke/stapler/RequestImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public RenderOnDemandParameters createJavaScriptProxyParameters(Object toBeExpor
return new RenderOnDemandParameters(
"makeStaplerProxy",
bound.getURL(),
bound.getReleaseURL(),
getWebApp().getCrumbIssuer().issueCrumb(),
bound.getBoundJavaScriptUrlNames());
}
Expand Down
11 changes: 8 additions & 3 deletions core/src/main/java/org/kohsuke/stapler/StaplerRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,12 +571,15 @@ public interface StaplerRequest extends HttpServletRequest {
final class RenderOnDemandParameters {
public final String proxyMethod;
public final String url;
public final String releaseUrl;
public final String crumb;
public final Set<String> urlNames;

public RenderOnDemandParameters(String proxyMethod, String url, String crumb, Set<String> urlNames) {
public RenderOnDemandParameters(
String proxyMethod, String url, String releaseUrl, String crumb, Set<String> urlNames) {
this.proxyMethod = proxyMethod;
this.url = url;
this.releaseUrl = releaseUrl;
this.crumb = crumb;
this.urlNames = urlNames;
}
Expand Down Expand Up @@ -998,7 +1001,8 @@ public String createJavaScriptProxy(Object toBeExported) {
@Override
public RenderOnDemandParameters createJavaScriptProxyParameters(Object toBeExported) {
StaplerRequest.RenderOnDemandParameters result = from.createJavaScriptProxyParameters(toBeExported);
return new RenderOnDemandParameters(result.proxyMethod, result.url, result.crumb, result.urlNames);
return new RenderOnDemandParameters(
result.proxyMethod, result.url, result.releaseUrl, result.crumb, result.urlNames);
}

@Override
Expand Down Expand Up @@ -1654,7 +1658,8 @@ public String createJavaScriptProxy(Object toBeExported) {
@Override
public RenderOnDemandParameters createJavaScriptProxyParameters(Object toBeExported) {
StaplerRequest2.RenderOnDemandParameters result = from.createJavaScriptProxyParameters(toBeExported);
return new RenderOnDemandParameters(result.proxyMethod, result.crumb, result.url, result.urlNames);
return new RenderOnDemandParameters(
result.proxyMethod, result.crumb, result.url, result.releaseUrl, result.urlNames);
}

@Override
Expand Down
5 changes: 4 additions & 1 deletion core/src/main/java/org/kohsuke/stapler/StaplerRequest2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,12 +533,15 @@ public interface StaplerRequest2 extends HttpServletRequest {
final class RenderOnDemandParameters {
public final String proxyMethod;
public final String url;
public final String releaseUrl;
public final String crumb;
public final Set<String> urlNames;

public RenderOnDemandParameters(String proxyMethod, String url, String crumb, Set<String> urlNames) {
public RenderOnDemandParameters(
String proxyMethod, String url, String releaseUrl, String crumb, Set<String> urlNames) {
this.proxyMethod = proxyMethod;
this.url = url;
this.releaseUrl = releaseUrl;
this.crumb = crumb;
this.urlNames = urlNames;
}
Expand Down
7 changes: 7 additions & 0 deletions core/src/main/java/org/kohsuke/stapler/bind/Bound.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ public abstract class Bound implements HttpResponse {
*/
public abstract String getURL();

/**
* The URL where the object can be released, or {@code null} if not applicable.
*/
public String getReleaseURL() {
return null;
}

/**
* Gets the bound object.
*/
Expand Down
31 changes: 31 additions & 0 deletions core/src/main/java/org/kohsuke/stapler/bind/BoundObjectTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import java.util.logging.Level;
import java.util.logging.Logger;
import org.kohsuke.stapler.Ancestor;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerFallback;
Expand Down Expand Up @@ -71,6 +72,30 @@ public static boolean isValidJavaIdentifier(String name) {
.allMatch(it -> Character.isJavaIdentifierPart(it) && !Character.isIdentifierIgnorable(it) && it < 256);
}

/**
* Explicitly unbind this object via HTTP.
*
* @throws HttpResponses.HttpResponseException expected outcome returning 200 OK
*/
public void doRelease(StaplerRequest2 req, StaplerResponse2 rsp)
Copy link
Member

@jglick jglick May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@POST?

Copy link
Member Author

@daniel-beck daniel-beck May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess, although I expect this would be replaced anyway due to

The current implementation sends one request per proxy, could be collapsed to just one if this approach is deemed preferable.

throws HttpResponses.HttpResponseException, IOException {
final Table table = resolve(false);
if (table == null) {
rsp.sendError(404);
return;
}

String id = req.getRestOfPath().replace("/", "");

Object object = table.resolve(id);
if (object == null) {
rsp.sendError(200);
return;
}
table.release(id);
rsp.sendError(200);
}

/**
* This serves the script content for a bound object. Support CSP-compatible st:bind and similar methods of making
* objects accessible to JS.
Expand Down Expand Up @@ -231,6 +256,11 @@ public void release() {
Table.this.release(id);
}

@Override
public String getReleaseURL() {
return Stapler.getCurrentRequest2().getContextPath() + RELEASE_PREFIX + id;
}

@Override
public String getURL() {
return Stapler.getCurrentRequest2().getContextPath() + PREFIX + id;
Expand Down Expand Up @@ -351,6 +381,7 @@ private Object writeReplace() {
Duration.ofDays(1).toMillis());

public static final String PREFIX = "/$stapler/bound/";
public static final String RELEASE_PREFIX = "/$stapler/bound/release/";
static final String SCRIPT_PREFIX = "/$stapler/bound/script";

private static final Logger LOGGER = Logger.getLogger(BoundObjectTable.class.getName());
Expand Down