Package org.craftercms.engine.controller.rest

Class SiteNavigationController

java.lang.Object

org.craftercms.core.controller.rest.RestControllerBase

org.craftercms.engine.controller.rest.SiteNavigationController

@Validated
@CrafterRestController
@RequestMapping("${crafter.core.rest.base.uri}/site/navigation")
public class SiteNavigationController
extends org.craftercms.core.controller.rest.RestControllerBase

REST controller to access site navigation services.

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final NavBreadcrumbBuilder	navBreadcrumbBuilder
protected final NavTreeBuilder	navTreeBuilder
static final String	URL_BREADCRUMB
static final String	URL_ROOT
static final String	URL_TREE

Fields inherited from class org.craftercms.core.controller.rest.RestControllerBase

MESSAGE_MODEL_ATTRIBUTE_NAME, REST_BASE_URI

Constructor Summary

Constructors

Constructor	Description
SiteNavigationController(NavTreeBuilder navTreeBuilder, NavBreadcrumbBuilder navBreadcrumbBuilder)

Method Summary

Modifier and Type	Method	Description
List<NavItem>	getNavBreadcrumb(String url, String root)
NavItem	getNavTree(String url, int depth, String currentPageUrl)

Methods inherited from class org.craftercms.core.controller.rest.RestControllerBase

createResponseMessage, createSingletonModifiableMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

URL_ROOT

public static final String URL_ROOT

See Also:

• Constant Field Values

URL_TREE

public static final String URL_TREE

See Also:

• Constant Field Values

URL_BREADCRUMB

public static final String URL_BREADCRUMB

See Also:

• Constant Field Values

navTreeBuilder

protected final NavTreeBuilder navTreeBuilder

navBreadcrumbBuilder

protected final NavBreadcrumbBuilder navBreadcrumbBuilder

Constructor Details

SiteNavigationController

@ConstructorProperties({"navTreeBuilder","navBreadcrumbBuilder"})
public SiteNavigationController(NavTreeBuilder navTreeBuilder,
 NavBreadcrumbBuilder navBreadcrumbBuilder)

Method Details

getNavTree

@GetMapping("/tree")
public NavItem getNavTree(@RequestParam
 String url,
 @RequestParam(required=false,defaultValue="1")
 int depth,
 @RequestParam(required=false,defaultValue="")
 String currentPageUrl)

getNavBreadcrumb

@GetMapping("/breadcrumb")
public List<NavItem> getNavBreadcrumb(@RequestParam
 String url,
 @RequestParam(required=false,defaultValue="")
 String root)