Package com.broadleafcommerce.tenant.web.endpoint

Class ApplicationCatalogEndpoint

java.lang.Object

com.broadleafcommerce.tenant.web.endpoint.ApplicationCatalogEndpoint

@FrameworkRestController
@FrameworkMapping("/application-catalogs")
@DataRouteByExample(ApplicationCatalog.class)
public class ApplicationCatalogEndpoint
extends Object

This is a special endpoint that is intended to support the "Application Catalogs" page, which is visible exclusively in the context of a standard application.

Author:

Samarth Dhruva (samarthd)

Constructor Summary

Constructors

Constructor	Description
ApplicationCatalogEndpoint(ApplicationCatalogService applicationCatalogService)

Method Summary

Modifier and Type	Method	Description
ApplicationCatalog	createAndAssignCatalog(ApplicationCatalog applicationCatalog, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteApplicationCatalogRef(String applicationCatalogRefId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError>	handleApplicationContextException(Exception ex, org.springframework.web.context.request.WebRequest request)	Returns a 400 Bad Request in the event of a InvalidApplicationContextException.
protected void	logDebug(Exception ex, org.springframework.web.context.request.WebRequest request)
org.springframework.data.domain.Page<ApplicationCatalogRef>	readAll(cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. Filters are ignored since the application catalogs are an embedded collection.
org.springframework.data.domain.Page<ApplicationCatalogRef>	readAll(String type, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ApplicationCatalog	readApplicationCatalogRef(String applicationCatalogRefId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ApplicationCatalog	replaceApplicationCatalogRef(String applicationCatalogRefId, ApplicationCatalogRef applicationCatalogRef, 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

Constructor Details

ApplicationCatalogEndpoint

public ApplicationCatalogEndpoint(ApplicationCatalogService applicationCatalogService)

Method Details

readAll

@Policy(permissionRoots="TENANT")
@Deprecated
public org.springframework.data.domain.Page<ApplicationCatalogRef> readAll(cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                                    throws InvalidApplicationContextException

Deprecated.

Filters are ignored since the application catalogs are an embedded collection. Use readAll(String, ContextInfo) instead.

Throws:

InvalidApplicationContextException

readAll

@FrameworkGetMapping
@Policy(permissionRoots="TENANT")
public org.springframework.data.domain.Page<ApplicationCatalogRef> readAll(@RequestParam(name="type",required=false)
 String type,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                                    throws InvalidApplicationContextException

Throws:

InvalidApplicationContextException

createAndAssignCatalog

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="TENANT")
public ApplicationCatalog createAndAssignCatalog(@RequestBody
 ApplicationCatalog applicationCatalog,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                          throws InvalidApplicationContextException

Throws:

InvalidApplicationContextException

readApplicationCatalogRef

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="TENANT")
public ApplicationCatalog readApplicationCatalogRef(@PathVariable("id")
 String applicationCatalogRefId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                             throws InvalidApplicationContextException

Throws:

InvalidApplicationContextException

replaceApplicationCatalogRef

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="TENANT")
public ApplicationCatalog replaceApplicationCatalogRef(@PathVariable("id")
 String applicationCatalogRefId,
 @RequestBody
 ApplicationCatalogRef applicationCatalogRef,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                                throws InvalidApplicationContextException

Throws:

InvalidApplicationContextException

deleteApplicationCatalogRef

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="TENANT")
public void deleteApplicationCatalogRef(@PathVariable("id")
 String applicationCatalogRefId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                 throws InvalidApplicationContextException

Throws:

InvalidApplicationContextException

handleApplicationContextException

@ExceptionHandler(InvalidApplicationContextException.class)
public org.springframework.http.ResponseEntity<com.broadleafcommerce.common.error.ApiError> handleApplicationContextException(Exception ex,
 org.springframework.web.context.request.WebRequest request)

Returns a 400 Bad Request in the event of a InvalidApplicationContextException.

logDebug

protected void logDebug(Exception ex,
 org.springframework.web.context.request.WebRequest request)