> On 2. Jan 2021, at 20:20, Robert Smith <[email protected]> wrote:
>
> 1) What magic is happening to tell Jenkins to bind all of the
> hudson/model/View/ajax*.jelly files to a URL of the same name? I couldn't
> figure it out.
Stapler, the web framework used in Jenkins. For this specifically, see the
section "View" in https://stapler.kohsuke.org/reference.html
If you run Jenkins/your plugin in debug mode (hpi:run or jetty:run), or set the
system property `stapler.trace` on startup, or set the field
`org.kohsuke.stapler.Dispatcher.TRACE=true` in the script console, HTTP
response headers will tell you how the request was processed and, if it failed,
404 pages will tell you what else exists (with some complications if
StaplerFallback objects are involved, but otherwise it is pretty useful). Given
the dynamic nature of this specific dispatcher, 404 pages will not show a list
of views, but you can at least see what type you're at in the chain (see below).
If you want to see the sources, JellyFacet and JellyDispatcher in Stapler are
useful places to start, MetaClass is what adds them to the list.
> 2) Can I accomplish this pattern in my own plugin using a Widget instead of a
> View and within my own package structure? If so, How?
Yes. The URL needs to route to the object you want.
> After many hours of headbanging and simplification, I concentrated solely on
> getting that ajaxMyThing.jelly file to be served up at some URL. I thought
> that it might have something to do with the object type - that Widgets didn't
> support this. So I created a simple view and placed the ajaxMyThing.jelly
> file into the matching package under resources. Nothing. I tried every
> combination of URL where I thought it might be lurking (adding
> /plugin/mything/ajaxMyThing, etc.) I tried adding @Symbol annotations and
> overriding getUrlName() and using those values in the URL. Nothing.
/plugin/mything is a `hudson.Plugin` (as stapler.trace would tell you). It's an
easy "default" location for plugins to put their stuff because it always exists
at a known URL, but not a great choice IMO as it is deprecated for user code
(see Javadoc).
@Symbol is completely unused by Stapler, it's much more recent and for a
different purpose.
`getUrlName()` for Widgets may actually be unused, unsure. Widgets don't seem
to have a really good URL binding: Jenkins#getWidgets() exists, but it returns
a list, which can only be numerically indexed.
The safe fallback would be to make sure it's annotated with `@Extension`
(~Jenkins creates and registers an instance on startup), because those are
always available via /extensionList/hudson.widgets.Widget/org.acme.myWidget/
So the full URL to your view should be something like
/extensionList/hudson.widgets.Widget/org.acme.MyWidget/ajaxMyThing
--
You received this message because you are subscribed to the Google Groups
"Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/jenkinsci-dev/E002A71A-035E-4439-AE62-F11FADFCC997%40beckweb.net.
