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

Class SynonymEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.SynonymEndpoint

@FrameworkRestController
@FrameworkMapping("/synonyms/{indexableType}")
@DataRouteByKey("search")
@ConditionalOnProperty(name="broadleaf.search.feature.synonym.enabled",
                       havingValue="true")
public class SynonymEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	SYNONYM_BY_TYPE_LANG
static final String	SYNONYM_BY_TYPE_LANG_WORD
static final String	SYNONYM_BY_TYPE_LANG_WORD_SYNONYM

Constructor Summary

Constructors

Constructor	Description
SynonymEndpoint(SynonymService synonymService)

Method Summary

Modifier and Type	Method	Description
Synonym	addSynonym(String indexableType, String managedLanguage, Synonym synonym, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<Synonym>	addSynonyms(String indexableType, String managedLanguage, List<Synonym> synonyms, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	The "/" mapping of this endpoint is deprecated in favor of an explicit "/bulk-create".
protected void	deleteRemovedSynonymsOnUpdate(String indexableType, String managedLanguage, String word, Synonym synonym, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSynonym(String indexableType, String managedLanguage, String word, String synonym, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSynonyms(String indexableType, String managedLanguage, String word, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<ManagedLanguage>	getAvailableSynonymLocales(String indexableType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ManagedLanguage	getSynonymLanguage(String indexableType, String managedLanguage, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected SynonymService	getSynonymService()
List<Synonym>	readAllSynonyms(String indexableType, String managedLanguage, cz.jirutka.rsql.parser.ast.Node filters, String query, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Synonym	readSynonym(String indexableType, String managedLanguage, String word, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Synonym	updateSynonym(String indexableType, String managedLanguage, String word, Synonym synonym, 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

SYNONYM_BY_TYPE_LANG

public static final String SYNONYM_BY_TYPE_LANG

See Also:

• Constant Field Values

SYNONYM_BY_TYPE_LANG_WORD

public static final String SYNONYM_BY_TYPE_LANG_WORD

See Also:

• Constant Field Values

SYNONYM_BY_TYPE_LANG_WORD_SYNONYM

public static final String SYNONYM_BY_TYPE_LANG_WORD_SYNONYM

See Also:

• Constant Field Values

Constructor Details

SynonymEndpoint

public SynonymEndpoint(@Autowired(required=false)
 SynonymService synonymService)

Method Details

readAllSynonyms

@FrameworkGetMapping("/{managedLanguage}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public List<Synonym> readAllSynonyms(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 cz.jirutka.rsql.parser.ast.Node filters,
 @RequestParam(value="q",required=false)
 String query,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSynonym

@FrameworkGetMapping("/{managedLanguage}/{word}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public Synonym readSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @PathVariable
 String word,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addSynonym

@FrameworkPostMapping("/{managedLanguage}")
@Policy(permissionRoots="FIELD",
        operationTypes={CREATE,UPDATE})
public Synonym addSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @RequestBody
 Synonym synonym,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addSynonyms

@FrameworkPostMapping(path="/{managedLanguage}/bulk-create")
@Policy(permissionRoots="FIELD",
        operationTypes={CREATE,UPDATE})
public List<Synonym> addSynonyms(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @RequestBody
 List<Synonym> synonyms,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

The "/" mapping of this endpoint is deprecated in favor of an explicit "/bulk-create". The deprecation was done to provide an endpoint for supporting the creation a single synonym on this path.

Since:

2.2.0

updateSynonym

@FrameworkMapping(path="/{managedLanguage}/{word}",
                  method={PATCH,PUT})
@Policy(permissionRoots="FIELD",
        operationTypes={UPDATE,CREATE})
public Synonym updateSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @PathVariable
 String word,
 @RequestBody
 Synonym synonym,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSynonym

@FrameworkDeleteMapping("/{managedLanguage}/{word}/{synonym}")
@Policy(permissionRoots="FIELD",
        operationTypes=DELETE)
public void deleteSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @PathVariable
 String word,
 @PathVariable
 String synonym,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSynonyms

@FrameworkDeleteMapping("/{managedLanguage}/{word}")
@Policy(permissionRoots="FIELD",
        operationTypes=DELETE)
public void deleteSynonyms(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @PathVariable
 String word,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getAvailableSynonymLocales

@FrameworkGetMapping("/languages")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public List<ManagedLanguage> getAvailableSynonymLocales(@PathVariable
 String indexableType,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSynonymLanguage

@FrameworkGetMapping("/languages/{managedLanguage}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public ManagedLanguage getSynonymLanguage(@PathVariable
 String indexableType,
 @PathVariable
 String managedLanguage,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteRemovedSynonymsOnUpdate

protected void deleteRemovedSynonymsOnUpdate(String indexableType,
 String managedLanguage,
 String word,
 Synonym synonym,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSynonymService

protected SynonymService getSynonymService()