/**
* Handles a request for navigation data, for example for the top navigation menu, left-side
* navigation or breadcrumb bar.
*
* @param request The request.
* @param entityId The name of the entity.
* @param navType Navigation type.
* @return The name of the entity view that should be rendered for this request.
* @throws NavigationProviderException If an error occurs so that the navigation data cannot be
* retrieved.
* @throws java.lang.Exception if any.
*/
@RequestMapping(
method = RequestMethod.GET,
value = DefaultsMvcData.CoreAreaConstants.NAVIGATION_ACTION_NAME + "/{entityId}")
public String handleGetNavigation(
HttpServletRequest request, @PathVariable String entityId, @RequestParam String navType)
throws Exception {
LOG.trace("handleGetNavigation:, entityId={}", entityId);
EntityModel entity = getEntityFromRequest(request, entityId);
final String requestPath = webRequestContext.getRequestPath();
final Localization localization = webRequestContext.getLocalization();
NavigationLinks navigationLinks;
switch (navType) {
case NAV_TYPE_TOP:
navigationLinks = navigationProvider.getTopNavigationLinks(requestPath, localization);
break;
case NAV_TYPE_LEFT:
navigationLinks = navigationProvider.getContextNavigationLinks(requestPath, localization);
break;
case NAV_TYPE_BREADCRUMB:
navigationLinks =
navigationProvider.getBreadcrumbNavigationLinks(requestPath, localization);
break;
default:
LOG.warn("Unsupported navigation type: {}", navType);
navigationLinks = null;
break;
}
final ViewModel enrichedEntity = enrichModel(entity, request);
entity = enrichedEntity instanceof EntityModel ? (EntityModel) enrichedEntity : navigationLinks;
request.setAttribute(ENTITY_MODEL, entity);
if (navigationLinks != null) {
navigationLinks.setXpmMetadata(entity.getXpmMetadata());
navigationLinks.setXpmPropertyMetadata(entity.getXpmPropertyMetadata());
request.setAttribute(ENTITY_MODEL, navigationLinks);
}
final MvcData mvcData = entity.getMvcData();
LOG.trace("Entity MvcData: {}", mvcData);
return resolveView(mvcData, "Entity", request);
}
/**
* Handles a request to get the sitemap (in HTML).
*
* @param request The request.
* @param entityId The name of the entity.
* @return The name of the entity view that should be rendered for this request.
* @throws com.sdl.webapp.common.api.content.NavigationProviderException If an error occurs so
* that the navigation data cannot be retrieved.
*/
@RequestMapping(
method = RequestMethod.GET,
value = DefaultsMvcData.CoreAreaConstants.SITEMAP_ACTION_NAME + "/{entityId}")
public String handleGetSiteMap(HttpServletRequest request, @PathVariable String entityId)
throws NavigationProviderException {
LOG.trace("handleGetSiteMap: entityId={}", entityId);
final EntityModel entity = getEntityFromRequest(request, entityId);
final SitemapItem navigationModel =
navigationProvider.getNavigationModel(webRequestContext.getLocalization());
navigationModel.setXpmMetadata(entity.getXpmMetadata());
navigationModel.setXpmPropertyMetadata(entity.getXpmPropertyMetadata());
request.setAttribute(ENTITY_MODEL, navigationModel);
// Put all items that do not have any subitems under the "Home" item
final List<SitemapItem> topSubItems = navigationModel.getItems();
final List<SitemapItem> homeSubItems = new ArrayList<>();
for (Iterator<SitemapItem> i = topSubItems.iterator(); i.hasNext(); ) {
final SitemapItem subItem = i.next();
if (subItem.getItems().isEmpty()) {
i.remove();
homeSubItems.add(subItem);
}
}
final SitemapItem homeItem = new SitemapItem();
homeItem.setTitle(navigationModel.getTitle());
homeItem.setUrl(navigationModel.getUrl());
homeItem.setItems(homeSubItems);
// Add the "Home" item as the first item
topSubItems.add(0, homeItem);
final MvcData mvcData = entity.getMvcData();
LOG.trace("Entity MvcData: {}", mvcData);
return mvcData.getAreaName() + "/Entity/" + mvcData.getViewName();
}