Uses of Class
com.broadleafcommerce.asset.domain.Asset

Packages that use Asset

Package	Description
com.broadleafcommerce.asset.domain
com.broadleafcommerce.asset.jackson
com.broadleafcommerce.asset.messaging
com.broadleafcommerce.asset.service
com.broadleafcommerce.asset.service.autoconfigure
com.broadleafcommerce.asset.service.support
com.broadleafcommerce.asset.service.validation
com.broadleafcommerce.asset.web.endpoint

Uses of Asset in com.broadleafcommerce.asset.domain

Methods in com.broadleafcommerce.asset.domain that return types with arguments of type Asset

Modifier and Type	Method	Description
List<Asset>	FileUploadState.getUploadedAsset()	The List of the uploaded Asset

Method parameters in com.broadleafcommerce.asset.domain with type arguments of type Asset

Modifier and Type	Method	Description
void	FileUploadState.setUploadedAsset(List<Asset> uploadedAsset)	The List of the uploaded Asset

Uses of Asset in com.broadleafcommerce.asset.jackson

Methods in com.broadleafcommerce.asset.jackson with parameters of type Asset

Modifier and Type	Method	Description
String	ContentUrlResolver.getContentUrl(Asset asset)	Builds and returns a fully resolved content URL path that can be used to directly fetch the binary data of the asset.
String	ServletContentUrlResolver.getContentUrl(Asset asset)	If the storageType is internal, the content URL will be the result of prepending the necessary prefixes (like the content provider URL) to the url.

Uses of Asset in com.broadleafcommerce.asset.messaging

Methods in com.broadleafcommerce.asset.messaging that return types with arguments of type Asset

Modifier and Type	Method	Description
protected AssetService<Asset>	ProcessAssetsListener.getAssetService()

Methods in com.broadleafcommerce.asset.messaging with parameters of type Asset

Modifier and Type	Method	Description
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	ProcessAssetsListener.buildContextInfoForAsset(Asset asset)

Constructor parameters in com.broadleafcommerce.asset.messaging with type arguments of type Asset

Modifier	Constructor	Description
	ProcessAssetsListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, AssetService<Asset> assetService, StorageProvider storageProvider, StorageService storageService, List<AssetDataRouteSupporting> routes)

Uses of Asset in com.broadleafcommerce.asset.service

Classes in com.broadleafcommerce.asset.service with type parameters of type Asset

Modifier and Type	Interface	Description
interface	AssetService<P extends Asset>	Base service API for Asset.
class	DefaultAssetService<P extends Asset>

Fields in com.broadleafcommerce.asset.service with type parameters of type Asset

Modifier and Type	Field	Description
protected final AssetService<Asset>	DefaultStorageService.assetService

Methods in com.broadleafcommerce.asset.service that return Asset

Modifier and Type	Method	Description
protected Asset	DefaultStorageService.generateAssetForUploadRequest(Asset assetRequest, String mimeType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Generates a new Asset object for an upload using the mime type and optional properties provided in assetRequest.
protected Asset	DefaultFileUploadStateHydrationService.getHydratedOrLog(Asset unhydrated, Map<String,Asset> foundAssetsById)	Returns the fully-populated instance of unhydrated if it was found, otherwise logs a warning and returns unhydrated as-is.
Asset	DefaultStorageService.uploadResource(org.springframework.web.multipart.MultipartFile file, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)
Asset	StorageService.uploadResource(org.springframework.web.multipart.MultipartFile file, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)	Uploads a single file, creating an Asset for it (optionally using details specified in assetRequest if present).

Methods in com.broadleafcommerce.asset.service that return types with arguments of type Asset

Modifier and Type	Method	Description
protected List<Asset>	DefaultStorageService.createAssetsForSuccessfullyUploadedFiles(DefaultStorageService.ZipExtractionResult zipExtractionResult, Map<String,String> contextDiscriminatedUrlsByNormalizedPath, Map<String,Folder> createdFoldersByNormalizedPath, BulkAddResourcesResponse addResourcesResponse, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates Assets in the data store for the files that were successfully uploaded to the storage provider.
protected Map<String,Asset>	DefaultFileUploadStateHydrationService.findAssetsAndCollectToMap(List<String> assetIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<Asset>	DefaultStorageService.generateAssetsForFiles(Stream<Map.Entry<String,File>> filesByNormalizedPath, Map<String,String> contextDiscriminatedUrlsByNormalizedPath, Map<String,Folder> createdFoldersByNormalizedPath, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AssetService<Asset>	DefaultFileUploadStateHydrationService.getAssetService()
org.springframework.data.domain.Page<Asset>	AssetService.readAllAssetsInFolder(String folderId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads all of the assets in the given folder.
org.springframework.data.domain.Page<Asset>	DefaultAssetService.readAllAssetsInFolder(String folderId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageInfo, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods in com.broadleafcommerce.asset.service with parameters of type Asset

Modifier and Type	Method	Description
void	DefaultStorageService.addAttributesToAsset(@NonNull Asset asset, @NonNull ResourceWithMetadata resource)	Responsible for adding any attributes to the asset that are derived from the uploaded Resource.
void	DefaultStorageService.addAttributesToAsset(@NonNull Asset asset, @NonNull File file)	Responsible for adding any attributes to the asset that are derived from the uploaded file.
void	StorageService.addAttributesToAsset(Asset asset, ResourceWithMetadata resource)	Add attributes to the asset based on the resource.
void	StorageService.addAttributesToAsset(Asset asset, File file)	Add attributes to the asset based on the file.
default void	StorageService.addAttributesToAsset(Asset asset, org.springframework.core.io.Resource resource)	Add attributes to the asset based on the resource.
protected void	DefaultStorageService.addImageAttributes(@NonNull Asset asset, @NonNull Dimension imageDimension)
protected Map<String,Folder>	DefaultStorageService.createAllFolders(Map<String,Folder> foldersToCreateByNormalizedPath, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset assetRequest)	Creates all of the given Folders in the data store, and returns the created items.
protected List<Asset>	DefaultStorageService.createAssetsForSuccessfullyUploadedFiles(DefaultStorageService.ZipExtractionResult zipExtractionResult, Map<String,String> contextDiscriminatedUrlsByNormalizedPath, Map<String,Folder> createdFoldersByNormalizedPath, BulkAddResourcesResponse addResourcesResponse, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates Assets in the data store for the files that were successfully uploaded to the storage provider.
protected Asset	DefaultStorageService.generateAssetForUploadRequest(Asset assetRequest, String mimeType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Generates a new Asset object for an upload using the mime type and optional properties provided in assetRequest.
protected List<Asset>	DefaultStorageService.generateAssetsForFiles(Stream<Map.Entry<String,File>> filesByNormalizedPath, Map<String,String> contextDiscriminatedUrlsByNormalizedPath, Map<String,Folder> createdFoldersByNormalizedPath, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Asset	DefaultFileUploadStateHydrationService.getHydratedOrLog(Asset unhydrated, Map<String,Asset> foundAssetsById)	Returns the fully-populated instance of unhydrated if it was found, otherwise logs a warning and returns unhydrated as-is.
protected String	DefaultStorageService.getParentFolderId(String normalizedPath, Map<String,Folder> createdFoldersByNormalizedPath, Asset assetRequest)	Gets the parent directory path from normalizedPath, gets the Folder for that parent directory path in createdFoldersByNormalizedPath, and returns its Folder.getId().
protected void	DefaultStorageService.mapEligibleProperties(Asset targetAsset, Asset source)	If source is present, will copy its getTags(), getFolderId() and getLocale() to targetAsset.
protected void	DefaultStorageService.processZipExtractionResult(DefaultStorageService.ZipExtractionResult zipExtractionResult, FileUploadState uploadState, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)	Deprecated.
protected void	DefaultStorageService.processZipExtractionResult(DefaultStorageService.ZipExtractionResult zipExtractionResult, FileUploadState uploadState, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg, boolean ignoreFolderName)	Given a DefaultStorageService.ZipExtractionResult, creates all of the necessary Folders in the data store, uploads the extracted files to the storage provider (after optimizing them if necessary), and creates Assets in the data store for all successfully uploaded files.
void	DefaultStorageService.unzipAndUploadResourcesAsync(File sourceZipFile, String fileUploadStateId, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)	Deprecated.
void	DefaultStorageService.unzipAndUploadResourcesAsync(File sourceZipFile, String fileUploadStateId, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg, boolean ignoreFolderName)
void	StorageService.unzipAndUploadResourcesAsync(File sourceZipFile, String fileUploadStateId, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)	Deprecated. Use StorageService.unzipAndUploadResourcesAsync(File, String, Asset, ContextInfo, boolean, boolean)
void	StorageService.unzipAndUploadResourcesAsync(File sourceZipFile, String fileUploadStateId, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg, boolean ignoreFolderName)	Asynchronously upload the individual contents of a zip file to the storage provider, and create all necessary Folders and Assets in the data store for them.
Asset	DefaultStorageService.uploadResource(org.springframework.web.multipart.MultipartFile file, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)
Asset	StorageService.uploadResource(org.springframework.web.multipart.MultipartFile file, Asset assetRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, boolean optimizeImg)	Uploads a single file, creating an Asset for it (optionally using details specified in assetRequest if present).

Method parameters in com.broadleafcommerce.asset.service with type arguments of type Asset

Modifier and Type	Method	Description
protected FileUploadState	DefaultFileUploadStateHydrationService.applyHydration(FileUploadState state, Map<String,Asset> foundAssetsById)
protected Asset	DefaultFileUploadStateHydrationService.getHydratedOrLog(Asset unhydrated, Map<String,Asset> foundAssetsById)	Returns the fully-populated instance of unhydrated if it was found, otherwise logs a warning and returns unhydrated as-is.

Constructor parameters in com.broadleafcommerce.asset.service with type arguments of type Asset

Modifier	Constructor	Description
	DefaultFileUploadStateHydrationService(AssetService<Asset> assetService)
	DefaultStorageService(AssetService<Asset> assetService, FolderService<Folder> folderService, jakarta.servlet.MultipartConfigElement multipartConfigElement, StorageProvider storageProvider, InternalAssetProperties internalAssetProperties, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ImageOperationService imageOperationService, FileUploadStateService<FileUploadState> fileUploadStateService, jakarta.activation.FileTypeMap mimeFileTypeMap, AssetUrlGenerationHelper assetUrlGenerationHelper, com.broadleafcommerce.common.extension.data.DataRouteReference reference)

Uses of Asset in com.broadleafcommerce.asset.service.autoconfigure

Method parameters in com.broadleafcommerce.asset.service.autoconfigure with type arguments of type Asset

Modifier and Type	Method	Description
FileUploadStateHydrationService	AssetServiceAutoConfiguration.fileUploadStateHydrationService(AssetService<Asset> assetService)

Uses of Asset in com.broadleafcommerce.asset.service.support

Methods in com.broadleafcommerce.asset.service.support that return types with arguments of type Asset

Modifier and Type	Method	Description
protected AssetService<Asset>	AssetUrlGenerationHelper.getAssetService()

Methods in com.broadleafcommerce.asset.service.support with parameters of type Asset

Modifier and Type	Method	Description
String	AssetStorageUtils.getContextAwareUrl(Asset asset, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Returns the getUrl() prepended with a tenant discriminated prefix based on the ContextInfo.
static String	StorageUtils.getContextAwareUrl(Asset asset, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the getUrl() prepended with a tenant discriminated prefix based on the ContextInfo.

Constructor parameters in com.broadleafcommerce.asset.service.support with type arguments of type Asset

Modifier	Constructor	Description
	AssetUrlGenerationHelper(AssetService<Asset> assetService)

Uses of Asset in com.broadleafcommerce.asset.service.validation

Methods in com.broadleafcommerce.asset.service.validation that return types with arguments of type Asset

Modifier and Type	Method	Description
protected AssetService<Asset>	AssetValidator.getAssetService()

Methods in com.broadleafcommerce.asset.service.validation with parameters of type Asset

Modifier and Type	Method	Description
protected void	AssetValidator.validateFolderId(Asset asset, org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AssetValidator.validateLastUpdatedDate(Asset asset, org.springframework.validation.Errors errors)
protected void	AssetValidator.validateStorageTypeDependentFields(Asset asset, org.springframework.validation.Errors errors)
protected void	AssetValidator.validateType(Asset asset, org.springframework.validation.Errors errors)
protected void	AssetValidator.validateUrlAndEmbedCode(Asset asset, org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Method parameters in com.broadleafcommerce.asset.service.validation with type arguments of type Asset

Modifier and Type	Method	Description
void	AssetValidator.setAssetService(AssetService<Asset> assetService)	Lazy injection since this validator is itself a service component.

Uses of Asset in com.broadleafcommerce.asset.web.endpoint

Methods in com.broadleafcommerce.asset.web.endpoint that return Asset

Modifier and Type	Method	Description
Asset	AssetEndpoint.create(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset req)
Asset	AssetEndpoint.read(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
Asset	AssetEndpoint.update(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, AssetEndpoint.AssetUpdate assetUpdate)
Asset	FileUploadEndpoint.uploadFile(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset asset, org.springframework.web.multipart.MultipartFile file, Boolean optimizeImg)

Methods in com.broadleafcommerce.asset.web.endpoint that return types with arguments of type Asset

Modifier and Type	Method	Description
protected AssetService<Asset>	AssetEndpoint.getAssetService()
protected AssetService<Asset>	ContentResolverEndpoint.getService()
org.springframework.data.domain.Page<Asset>	FolderEndpoint.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<Asset>	AssetEndpoint.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)

Methods in com.broadleafcommerce.asset.web.endpoint with parameters of type Asset

Modifier and Type	Method	Description
protected void	ContentResolverEndpoint.applyContentDisposition(ResourceWithMetadata resourceWithMetadata, org.springframework.http.ResponseEntity.BodyBuilder responseBuilder, Asset asset)
protected void	ContentResolverEndpoint.applyContentDisposition(org.springframework.core.io.Resource resource, org.springframework.http.ResponseEntity.BodyBuilder responseBuilder, Asset asset)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of ContentResolverEndpoint.applyContentDisposition(ResourceWithMetadata, ResponseEntity.BodyBuilder, Asset)
Asset	AssetEndpoint.create(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset req)
Asset	FileUploadEndpoint.uploadFile(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Asset asset, org.springframework.web.multipart.MultipartFile file, Boolean optimizeImg)
FileUploadState	FileUploadEndpoint.uploadMultiFile(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, org.springframework.web.multipart.MultipartFile file, Asset asset, Boolean optimizeImg)

Constructor parameters in com.broadleafcommerce.asset.web.endpoint with type arguments of type Asset

Modifier	Constructor	Description
	AssetEndpoint(AssetService<Asset> assetService, FolderService<Folder> folderService, StorageService storageService)
	ContentResolverEndpoint(ContentResolverService contentResolverService, InternalAssetProperties internalAssetProperties, AssetService<Asset> service, jakarta.activation.FileTypeMap mimeFileTypeMap, com.broadleafcommerce.data.tracking.core.tenant.service.CommonApplicationService<com.broadleafcommerce.data.tracking.core.tenant.domain.Application> applicationService)
	FolderEndpoint(FolderService<Folder> folderService, AssetService<Asset> assetService)