Learn about Edge Delivery Services in upcoming GEM session
Delegate fails for Custom Container Component
Hi Chintan,
The core v1 container component at /apps/core/wcm/components/container/v1/container uses the Sling model "com.adobe.cq.wcm.core.components.models.LayoutContainer". You can check this at line 16 "/apps/core/wcm/components/container/v1/container/container.html". You can use this interface as adapter in your custom sling model. Please find below the working code which overrides getId() and also i have added a testMethod().
import com.adobe.cq.wcm.core.components.models.LayoutContainer;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.Via;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.via.ResourceSuperType;
@Model(adaptables = {Resource.class, SlingHttpServletRequest.class},
adapters = LayoutContainer.class, //Use LayoutContainer.class instead of Container.class
resourceType = "mysite/components/content/container",
defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class CustomContainerModel implements LayoutContainer {
@Self
@Via(type = ResourceSuperType.class)
private LayoutContainer container;
@Override
public String getBackgroundStyle() {
return "black";
}
// Override getId method
@Override
public String getId() {
return "myId";
}
// adding a custom method
public String testMethod() {
return "From test method";
}
}
Below is the code inside my proxy container component.
<sly data-sly-use.container="com.adobe.cq.wcm.core.components.models.LayoutContainer"/>
<p>Container id: ${container.id}</p>
<p>Container test method: ${container.testMethod}</p>
Let me know if you have further questions.
Thanks
Hi @chintan1997
The solution to your issue is to add LayoutContainer and ComponentExporter as adapters to your CustomContainer model. You will get the child resource data as well as acess to any custom method you write in your CustomContainer model. Below is the code snippet.
@Model(
adaptables = { SlingHttpServletRequest.class },
adapters = { LayoutContainer.class, ComponentExporter.class },
resourceType = "mysite/components/content/container",
defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL
)
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME,
selector = ExporterConstants.SLING_MODEL_SELECTOR,
extensions = ExporterConstants.SLING_MODEL_EXTENSION,
options = {
@ExporterOption(name = "MapperFeature.SORT_PROPERTIES_ALPHABETICALLY", value = "true"),
@ExporterOption(name = "SerializationFeature.WRITE_DATES_AS_TIMESTAMPS", value="false")
}
)
@JsonSerialize(as = CustomContainerModel.class)
public class CustomContainerModel implements ComponentExporter, LayoutContainer {
@Self
@Via(type = ResourceSuperType.class)
private LayoutContainer container;
@Override
public Map<String, ? extends ComponentExporter> getExportedItems() {
return container.getExportedItems();
}
public String getTestMethod() {
return " From SampleComponentExporter Model ";
}
}
Below is a snapshot of the model.json
'text' and 'textimage' are the components added in the container. 'testMethod' is the method i have addedion the CustomContainer model. Let me know if this satisfies your need.
Thanks
Hi @chintan1997
I did try with the same hierarchy you have mentioned above and i can see all the data of the child containers and resources inside those containers. Please see the below model.json
This is how the hierarchy looks like.
I'm adding the full code for your reference.
@Model(
adaptables = { SlingHttpServletRequest.class },
adapters = { LayoutContainer.class, ComponentExporter.class },
resourceType = "mysite/components/content/container",
defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL
)
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME,
selector = ExporterConstants.SLING_MODEL_SELECTOR,
extensions = ExporterConstants.SLING_MODEL_EXTENSION,
options = {
@ExporterOption(name = "MapperFeature.SORT_PROPERTIES_ALPHABETICALLY", value = "true"),
@ExporterOption(name = "SerializationFeature.WRITE_DATES_AS_TIMESTAMPS", value="false")
}
)
@JsonSerialize(as = SampleComponentExporter.class)
public class SampleComponentExporter implements ComponentExporter, LayoutContainer {
@Self
@Via(type = ResourceSuperType.class)
private LayoutContainer container;
@Override
public Map<String, ? extends ComponentExporter> getExportedItems() {
return container.getExportedItems();
}
@Override
public String getRoleAttribute() {
return container.getRoleAttribute();
}
@Override
public String[] getExportedItemsOrder() {
return container.getExportedItemsOrder();
}
@Override
public List<ListItem> getItems() {
return container.getItems();
}
public String getTestMethod() {
return " From SampleComponentExporter Model ";
}
}
Thanks
