Package com.broadleafcommerce.asset.web.endpoint

Class AssetEndpoint

java.lang.Object

com.broadleafcommerce.asset.web.endpoint.AssetEndpoint

@FrameworkRestController
@FrameworkMapping("/assets")
@DataRouteByExample(Asset.class)
public class AssetEndpoint
extends Object

Author:

Nathan Moore (nathanmoore)., Samarth Dhruva (samarthd)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssetEndpoint.AssetUpdate	A custom DTO that is intended for the specific purpose of supporting PATCH for Asset.

Constructor Summary

Constructors

Constructor	Description
AssetEndpoint(AssetService<Asset> assetService, FolderService<Folder> folderService, StorageService storageService)

Method Summary

Modifier and Type	Method	Description
Asset	create(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset req)
void	delete(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected AssetService<Asset>	getAssetService()
protected FolderService<Folder>	getFolderService()
protected StorageService	getStorageService()
Asset	read(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
org.springframework.data.domain.Page<Asset>	readAllAssets(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String searchString, org.springframework.data.domain.Pageable pageInfo, cz.jirutka.rsql.parser.ast.Node filters)
Asset	update(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, AssetEndpoint.AssetUpdate assetUpdate)

Methods inherited from class java.lang.Object

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

Constructor Details

AssetEndpoint

public AssetEndpoint(AssetService<Asset> assetService,
 FolderService<Folder> folderService,
 StorageService storageService)

Method Details

readAllAssets

@FrameworkGetMapping
@Policy(permissionRoots="ASSET")
public org.springframework.data.domain.Page<Asset> readAllAssets(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String searchString,
 @PageableDefault(size=50,sort="url",direction=ASC)
 org.springframework.data.domain.Pageable pageInfo,
 cz.jirutka.rsql.parser.ast.Node filters)

read

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="ASSET")
public Asset read(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

update

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="ASSET")
public Asset update(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 AssetEndpoint.AssetUpdate assetUpdate)

create

@FrameworkPostMapping
@Policy(permissionRoots="ASSET")
public Asset create(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 Asset req)

delete

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="ASSET")
public void delete(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

getAssetService

protected AssetService<Asset> getAssetService()

getFolderService

protected FolderService<Folder> getFolderService()

getStorageService

protected StorageService getStorageService()