Ressources serving

Through the render method of the Portlet interface the Portlet produces its complete markup that is embedded as a fragment into the overall page by the portal application. However, there are use cases where the portlet would like to only replace a part of its markup, e.g. via an AJAX call. Serving fragments via serveResource is under the complete control of the portlet. Typically a portlet would issue an XMLHttpRequest with a resource URL and provide either markup or data as response in the serveResource method.

In order to provide a resource URL for each event handler that are supposed to serve either partial markup or data, the portletModule replaced the default implementation of the Linksource service by a class called PortletLinkSource.

public void contributeServiceOverride( MappedConfiguration<Class, Object> configuration, @InjectService("PortletCookieSource") final CookieSource cookieSource, @InjectService("PortletLinkSource") final PortletLinkSource linkSource, @InjectService("PortletRequestSelectorAnalyzer") final ComponentRequestSelectorAnalyzer analyzer) { configuration.add(LinkSource.class, linkSource);// <-----overrided service configuration.add(CookieSource.class, cookieSource); configuration.add(ComponentRequestSelectorAnalyzer.class, analyzer); }

more precisely the method called createComponentEventLink returns a resource URL when:

1) the event name start with the keyword "serve"

<t:eventlink t:event="serveresource">Download File</t:eventlink></li>

2) the component referenced by the link is declared as a resource sender.

The following code extracted from the PortletModule, show us how the bridge contributes values to the PortletResourceResponseIdentifier's configuration for components that come from tapestry-core and tapestry5-jQuery.

public static void contributePortletResourceResponseIdentifier( Configuration<DeclaredResourceResponseSender> configuration) { // declare core component that will return resource response form ajax call configuration.add(new DeclaredResourceResponseSender(DateField.class.getName())); configuration.add(new DeclaredResourceResponseSender(FormInjector.class.getName())); configuration.add(new DeclaredResourceResponseSender(BeanEditForm.class.getName())); // ajaxFormLoop DeclaredResourceResponseSender ajaxFormLoop = new DeclaredResourceResponseSender( AjaxFormLoop.class.getName()); ajaxFormLoop.addEvent(EventConstants.ADD_ROW); ajaxFormLoop.addEvent(EventConstants.REMOVE_ROW); configuration.add(ajaxFormLoop); // declare core mixin that will return resource response form ajax call configuration.add(new DeclaredResourceResponseSender(Autocomplete.class.getName(), true)); // declare tapestry-jquery component that will return resource response // form ajax call configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.AjaxUpload")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.CarouselItem")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.DataTable")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.DialogAjaxLink")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.InPlaceEditor")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.ProgressiveDisplay")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.RangeSlider")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.Slider")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.Tabs")); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.TwitterView")); // declare tapestry-jquery mixin that will return resource response from ajax call configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.mixins.Autocomplete",true)); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.mixins.ZoneDroppable",true)); configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.mixins.ZoneRefresh",true)); // for page or mixin like org.got5.tapestry5.jquery.mixins.Bind you have to declare the full pagename // and the eventname that should be treat as resource URL }

if you have to add a component to the list you have to:
- declare all the events raised by the component that request a resource serving url like

configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.components.AjaxUpload"));

- declare only the events raised by the component that should be declared as a resource sender.

DeclaredResourceResponseSender ajaxFormLoop = new DeclaredResourceResponseSender( AjaxFormLoop.class.getName()); ajaxFormLoop.addEvent(EventConstants.ADD_ROW); ajaxFormLoop.addEvent(EventConstants.REMOVE_ROW); configuration.add(ajaxFormLoop);

- declare a mixin that raised that should be declared as a resource sender.

configuration.add(new DeclaredResourceResponseSender("org.got5.tapestry5.jquery.mixins.Autocomplete",true));