Package com.broadleafcommerce.search.core.web.endpoint

Class SearchSettingsEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.SearchSettingsEndpoint

@FrameworkRestController
@FrameworkMapping("/search-settings")
@DataRouteByKey("search")
public class SearchSettingsEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	SEARCH_SETTINGS_PERMISSION

Constructor Summary

Constructors

Constructor

Description

SearchSettingsEndpoint(SearchSettingsService<com.broadleafcommerce.search.api.domain.SearchSettings> searchSettingsService, FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> facetGroupService, SortGroupService<com.broadleafcommerce.search.api.domain.SortGroup> sortGroupService, SettingsFacetGroupService<com.broadleafcommerce.search.api.domain.SettingsFacetGroup> SettingsFacetGroupService, SettingsSortGroupService<com.broadleafcommerce.search.api.domain.SettingsSortGroup> settingsSortGroupService)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.search.api.domain.SettingsFacetGroup	addFacetGroupToSearchSettings(String id, com.broadleafcommerce.search.api.domain.SettingsFacetGroup settingsFacetGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup	addRelevancyRuleGroupsToSearchSettings(String id, com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup settingsRelevancyRuleGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SettingsSortGroup	addSortGroupToSearchSettings(String id, com.broadleafcommerce.search.api.domain.SettingsSortGroup settingsSortGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SearchSettings	createSearchSettings(com.broadleafcommerce.search.api.domain.SearchSettings searchSettings, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSearchSettings(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSettingsFacetGroupForSearchSettings(String id, String settingsFacetGroupId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSettingsRelevancyRuleGroupForSearchSettings(String id, String settingsRelevancyRuleGroupId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSettingsSortGroupForSearchSettings(String id, String settingsSortGroupId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup>	getFacetGroupService()
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup>	getRelevancyRuleGroupService()
protected SearchSettingsService<com.broadleafcommerce.search.api.domain.SearchSettings>	getSearchSettingsService()
protected SettingsFacetGroupService<com.broadleafcommerce.search.api.domain.SettingsFacetGroup>	getSettingsFacetGroupService()
protected SettingsRelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup>	getSettingsRelevancyRuleGroupService()
protected SettingsSortGroupService<com.broadleafcommerce.search.api.domain.SettingsSortGroup>	getSettingsSortGroupService()
protected SortGroupService<com.broadleafcommerce.search.api.domain.SortGroup>	getSortGroupService()
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SearchSettings>	readAllSearchSettings(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsFacetGroup>	readFacetGroupsForSearchSettings(String id, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup>	readRelevancyRuleGroupsForSearchSettings(String id, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SearchSettings	readSearchSettingsByContext(String context, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SearchSettings	readSearchSettingsByContextIgnoringCatalog(String context, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SearchSettings	readSearchSettingsById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsSortGroup>	readSortGroupsForSearchSettings(String id, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.SearchSettings	replaceSearchSettings(com.broadleafcommerce.search.api.domain.SearchSettings searchSettings, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
void	setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)
void	setRelevancyRuleGroupService(RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> relevancyRuleGroupService)
void	setSettingsRelevancyRuleGroupService(SettingsRelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup> settingsRelevancyRuleGroupService)
com.broadleafcommerce.search.api.domain.SearchSettings	updateSearchSettings(com.broadleafcommerce.search.api.domain.SearchSettings searchSettings, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected com.broadleafcommerce.search.api.domain.FacetGroup	validateAndFetchRequestedFacetGroup(com.broadleafcommerce.search.api.domain.FacetGroup request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.search.api.domain.RelevancyRuleGroup	validateAndFetchRequestedRelevancyRuleGroup(com.broadleafcommerce.search.api.domain.RelevancyRuleGroup request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.search.api.domain.SortGroup	validateAndFetchRequestedSortGroup(com.broadleafcommerce.search.api.domain.SortGroup request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

SEARCH_SETTINGS_PERMISSION

public static final String SEARCH_SETTINGS_PERMISSION

See Also:

• Constant Field Values

Constructor Details

SearchSettingsEndpoint

public SearchSettingsEndpoint(SearchSettingsService<com.broadleafcommerce.search.api.domain.SearchSettings> searchSettingsService,
 FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> facetGroupService,
 SortGroupService<com.broadleafcommerce.search.api.domain.SortGroup> sortGroupService,
 SettingsFacetGroupService<com.broadleafcommerce.search.api.domain.SettingsFacetGroup> SettingsFacetGroupService,
 SettingsSortGroupService<com.broadleafcommerce.search.api.domain.SettingsSortGroup> settingsSortGroupService)

Method Details

readAllSearchSettings

@FrameworkGetMapping
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SearchSettings> readAllSearchSettings(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readSearchSettingsByContextIgnoringCatalog

@FrameworkGetMapping(params={"context","ignoreCatalog=true"})
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public com.broadleafcommerce.search.api.domain.SearchSettings readSearchSettingsByContextIgnoringCatalog(@RequestParam("context")
 String context,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSearchSettingsByContext

@FrameworkGetMapping(params="context")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public com.broadleafcommerce.search.api.domain.SearchSettings readSearchSettingsByContext(@RequestParam("context")
 String context,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSearchSettingsById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public com.broadleafcommerce.search.api.domain.SearchSettings readSearchSettingsById(@PathVariable("id")
 String id,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createSearchSettings

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.SearchSettings createSearchSettings(@RequestBody
 com.broadleafcommerce.search.api.domain.SearchSettings searchSettings,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSearchSettings

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=DELETE)
public void deleteSearchSettings(@PathVariable("id")
 String id,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceSearchSettings

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=UPDATE)
public com.broadleafcommerce.search.api.domain.SearchSettings replaceSearchSettings(@RequestBody
 com.broadleafcommerce.search.api.domain.SearchSettings searchSettings,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

updateSearchSettings

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=UPDATE)
public com.broadleafcommerce.search.api.domain.SearchSettings updateSearchSettings(@RequestBody
 com.broadleafcommerce.search.api.domain.SearchSettings searchSettings,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

readFacetGroupsForSearchSettings

@FrameworkGetMapping("/{id}/facet-groups")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsFacetGroup> readFacetGroupsForSearchSettings(@PathVariable("id")
 String id,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addFacetGroupToSearchSettings

@FrameworkPostMapping(value="/{id}/facet-groups",
                      consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.SettingsFacetGroup addFacetGroupToSearchSettings(@PathVariable("id")
 String id,
 @RequestBody
 com.broadleafcommerce.search.api.domain.SettingsFacetGroup settingsFacetGroup,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSettingsFacetGroupForSearchSettings

@FrameworkDeleteMapping("/{id}/facet-groups/{settingsFacetGroupId}")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=DELETE)
public void deleteSettingsFacetGroupForSearchSettings(@PathVariable("id")
 String id,
 @PathVariable("settingsFacetGroupId")
 String settingsFacetGroupId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readRelevancyRuleGroupsForSearchSettings

@FrameworkGetMapping("/{id}/relevancy-rule-groups")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup> readRelevancyRuleGroupsForSearchSettings(@PathVariable("id")
 String id,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addRelevancyRuleGroupsToSearchSettings

@FrameworkPostMapping(value="/{id}/relevancy-rule-groups",
                      consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup addRelevancyRuleGroupsToSearchSettings(@PathVariable("id")
 String id,
 @RequestBody
 com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup settingsRelevancyRuleGroup,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSettingsRelevancyRuleGroupForSearchSettings

@FrameworkDeleteMapping("/{id}/relevancy-rule-groups/{settingsRelevancyRuleGroupId}")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=DELETE)
public void deleteSettingsRelevancyRuleGroupForSearchSettings(@PathVariable("id")
 String id,
 @PathVariable("settingsRelevancyRuleGroupId")
 String settingsRelevancyRuleGroupId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSortGroupsForSearchSettings

@FrameworkGetMapping("/{id}/sort-groups")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.SettingsSortGroup> readSortGroupsForSearchSettings(@PathVariable("id")
 String id,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addSortGroupToSearchSettings

@FrameworkPostMapping(value="/{id}/sort-groups",
                      consumes="application/json")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.SettingsSortGroup addSortGroupToSearchSettings(@PathVariable("id")
 String id,
 @RequestBody
 com.broadleafcommerce.search.api.domain.SettingsSortGroup settingsSortGroup,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSettingsSortGroupForSearchSettings

@FrameworkDeleteMapping("/{id}/sort-groups/{settingsSortGroupId}")
@Policy(permissionRoots="SEARCH_SETTINGS",
        operationTypes=DELETE)
public void deleteSettingsSortGroupForSearchSettings(@PathVariable("id")
 String id,
 @PathVariable("settingsSortGroupId")
 String settingsSortGroupId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

validateAndFetchRequestedFacetGroup

protected com.broadleafcommerce.search.api.domain.FacetGroup validateAndFetchRequestedFacetGroup(@Nullable
 com.broadleafcommerce.search.api.domain.FacetGroup request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                                                          throws RuntimeException

Throws:

RuntimeException

validateAndFetchRequestedSortGroup

protected com.broadleafcommerce.search.api.domain.SortGroup validateAndFetchRequestedSortGroup(@Nullable
 com.broadleafcommerce.search.api.domain.SortGroup request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                                                        throws RuntimeException

Throws:

RuntimeException

validateAndFetchRequestedRelevancyRuleGroup

protected com.broadleafcommerce.search.api.domain.RelevancyRuleGroup validateAndFetchRequestedRelevancyRuleGroup(@Nullable
 com.broadleafcommerce.search.api.domain.RelevancyRuleGroup request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                                                                          throws RuntimeException

Throws:

RuntimeException

getSearchSettingsService

protected SearchSettingsService<com.broadleafcommerce.search.api.domain.SearchSettings> getSearchSettingsService()

getFacetGroupService

protected FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> getFacetGroupService()

getSortGroupService

protected SortGroupService<com.broadleafcommerce.search.api.domain.SortGroup> getSortGroupService()

getRelevancyRuleGroupService

protected RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> getRelevancyRuleGroupService()

setRelevancyRuleGroupService

@Autowired
public void setRelevancyRuleGroupService(RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> relevancyRuleGroupService)

getSettingsFacetGroupService

protected SettingsFacetGroupService<com.broadleafcommerce.search.api.domain.SettingsFacetGroup> getSettingsFacetGroupService()

getSettingsSortGroupService

protected SettingsSortGroupService<com.broadleafcommerce.search.api.domain.SettingsSortGroup> getSettingsSortGroupService()

getSettingsRelevancyRuleGroupService

protected SettingsRelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup> getSettingsRelevancyRuleGroupService()

setSettingsRelevancyRuleGroupService

@Autowired
public void setSettingsRelevancyRuleGroupService(SettingsRelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.SettingsRelevancyRuleGroup> settingsRelevancyRuleGroupService)

getParser

protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getParser()

setParser

@Autowired
public void setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)