I'm trying to create a Widget to display the status of an external server.
I'd like the status information to refresh every few seconds. I'd like to
render even the dynamic part of the UI using Jelly.
I searched the Jenkins core code and came across the pattern of using an
"ajaxMyThing.jelly" file with a taglib "component" that includes a call to
the JS function refreshPart(). For example, lib/hudson/queue.jelly calls
refreshPart() and passes in the Ajax URL that will point to where
hudson/model/View/ajaxBuildQueue.jelly is rendered.
I also read in the comments (inside ajax.jelly) that I should examine the
Matrix Project to see how it is used. I did - and the pattern is the same
as what I saw in the Jenkins core.
I followed this pattern. I created a taglib component in Jelly that
rendered the UI and set up the AJAX call to refresh a section of the UI. I
created an "ajaxMyThing.jelly" file (that included the <l:ajax> tag) and
placed it in the Widget's resource directory. I included (using
<st:include>) that file in the Widget's index.jelly file.
The initial rendering and the Javascript side of things seemed to work just
fine. The widget showed up and the status data was there. Every 5 seconds,
a call was made to where I expected my ajaxMyThing.jelly file to be
rendered. However, it always got a 404. It seems Jenkins was simply not
binding the URL to that rendered Jelly content.
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.
Finally, I deleted everything else and dropped the ajaxMyThing.jelly file
into the hudson/model/View directory, and like magic, there it was. I could
see my Jelly rendered at ${rootURL}/ajaxMyThing. However, when I tried to
restore the rest of my code, it still didn't work as ${it} no longer
pointed to my Widget object during the AJAX call - so the status update
would work once, then, 5 seconds later, the refresh would wipe out the data.
My questions are:
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.
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?
Thanks so much!!!
Robert
--
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/b41ec984-819b-4cc7-bc4f-ccbf2df166dfn%40googlegroups.com.
