Package com.broadleafcommerce.asset.web.endpoint

Class FolderEndpoint

java.lang.Object

com.broadleafcommerce.asset.web.endpoint.FolderEndpoint

@FrameworkRestController
@FrameworkMapping("/folders")
@DataRouteByExample(Folder.class)
public class FolderEndpoint
extends Object

Author:

Samarth Dhruva (samarthd)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FolderEndpoint.FolderUpdate	A custom DTO that is intended for the specific purpose of supporting PATCH for Folder.

Constructor Summary

Constructors

Constructor	Description
FolderEndpoint(FolderService<Folder> folderService, AssetService<Asset> assetService)

Method Summary

Modifier and Type	Method	Description
Folder	createFolder(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Folder folder)
void	delete(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String folderId)
Folder	read(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String folderId)
org.springframework.data.domain.Page<Asset>	readAllAssetContentsOfFolder(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String folderId, org.springframework.data.domain.Pageable pageInfo, cz.jirutka.rsql.parser.ast.Node filters)
org.springframework.data.domain.Page<Folder>	readAllOrRootFolders(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String nameQuery, Boolean isRoot, org.springframework.data.domain.Pageable pageInfo, cz.jirutka.rsql.parser.ast.Node filters)
org.springframework.data.domain.Page<Folder>	readAllSubFoldersOfFolder(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String folderId, org.springframework.data.domain.Pageable pageInfo, cz.jirutka.rsql.parser.ast.Node filters)
Folder	update(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String folderId, FolderEndpoint.FolderUpdate folderUpdate)

Methods inherited from class java.lang.Object

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

Constructor Details

FolderEndpoint

public FolderEndpoint(FolderService<Folder> folderService,
 AssetService<Asset> assetService)

Method Details

createFolder

@FrameworkPostMapping
@Policy(permissionRoots="ASSET")
public Folder createFolder(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 Folder folder)

read

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="ASSET")
public Folder read(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String folderId)

readAllOrRootFolders

@FrameworkGetMapping
@Policy(permissionRoots="ASSET")
public org.springframework.data.domain.Page<Folder> readAllOrRootFolders(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam(value="q",required=false)
 String nameQuery,
 @RequestParam(value="isRoot",required=false)
 Boolean isRoot,
 @PageableDefault(size=50,sort="name",direction=ASC)
 org.springframework.data.domain.Pageable pageInfo,
 cz.jirutka.rsql.parser.ast.Node filters)

update

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="ASSET")
public Folder update(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String folderId,
 @RequestBody
 FolderEndpoint.FolderUpdate folderUpdate)

delete

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

readAllAssetContentsOfFolder

@FrameworkGetMapping("/{id}/assets")
@Policy(permissionRoots="ASSET")
public org.springframework.data.domain.Page<Asset> readAllAssetContentsOfFolder(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String folderId,
 @PageableDefault(size=50,sort="url",direction=ASC)
 org.springframework.data.domain.Pageable pageInfo,
 cz.jirutka.rsql.parser.ast.Node filters)

readAllSubFoldersOfFolder

@FrameworkGetMapping("/{id}/subfolders")
@Policy(permissionRoots="ASSET")
public org.springframework.data.domain.Page<Folder> readAllSubFoldersOfFolder(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String folderId,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable pageInfo,
 cz.jirutka.rsql.parser.ast.Node filters)