Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addAttributesToAsset(Asset, ResourceWithMetadata) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Responsible for adding any attributes to the asset that are derived from the uploaded
Resource
. - addAttributesToAsset(Asset, File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Responsible for adding any attributes to the asset that are derived from the uploaded file.
- addAttributesToAsset(Asset, ResourceWithMetadata) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Add attributes to the asset based on the resource.
- addAttributesToAsset(Asset, File) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Add attributes to the asset based on the file.
- addAttributesToAsset(Asset, Resource) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Add attributes to the asset based on the resource.
- addImageAttributes(Asset, Dimension) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- addNamedOperation(Operation, NamedOperation) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- addNamedOperations(Operation, List<String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- addOperation(Operation, String, String) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- addResourceFromStream(InputStream, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- addResourceFromStream(InputStream, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- addResourceFromStream(InputStream, String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Adds a new resource to the configured storage provider using the provided
InputStream
and filename. - addResourcesFromFiles(Map<String, File>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- addResourcesFromFiles(Map<String, File>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- addResourcesFromFiles(Map<String, File>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
- addResourcesFromStreams(Map<String, InputStream>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- addResourcesFromStreams(Map<String, InputStream>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- addResourcesFromStreams(Map<String, InputStream>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Adds new resources to the configured storage provider using the provided
Map
ofInputStreams
and filenames. - AFTER - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is after the query param's value.
- afterPropertiesSet() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- ALL - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
The asset will match iff all query param values match its field's value.
- ANY - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
The asset will match if any of the query param's values match its field's value.
- applyBrowserCachingHeaders(ResponseEntity.BodyBuilder) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- applyContentDisposition(ResourceWithMetadata, ResponseEntity.BodyBuilder, Asset) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- applyContentDisposition(Resource, ResponseEntity.BodyBuilder, Asset) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
-
Deprecated, for removal: This API element is subject to removal in a future version.
- applyEffects(ResourceWithMetadata, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- applyEffects(ResourceWithMetadata, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- applyEffects(ResourceWithMetadata, MultiValueMap<String, String>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Apply the effects to the
imageResource
and save it to the temp file. - applyEffects(File, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- applyEffects(File, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- applyEffects(File, MultiValueMap<String, String>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Apply the effects to the
file
and save it to the temp file. - applyEffectsAndStoreModifiedFile(File, String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- applyEffectsAndStoreModifiedFile(File, String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- applyEffectsAndStoreModifiedFile(File, String, MultiValueMap<String, String>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- applyEffectsAndStoreModifiedResource(ResourceWithMetadata, String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- applyEffectsAndStoreModifiedResource(ResourceWithMetadata, String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- applyEffectsAndStoreModifiedResource(ResourceWithMetadata, String, MultiValueMap<String, String>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Apply the effects to the
imageResource
and store the new resource to thetargetUrl
- applyHydration(FileUploadState, Map<String, Asset>) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- applyIncrementingSuffix(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.support.AssetUrlGenerationHelper
-
Accepts an
assetUrl
(this should typically be the output ofAssetUrlGenerationHelper.createUrl(String, String)
) and suffixes it with an incrementing integer value if it is found to be in use by other assets. - applyRsqlCriteria(Node, CriteriaBuilder, CriteriaQuery<D>, Map<String, Object>, List<Predicate>) - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
-
Processes the given
filters
to build and apply the necessaryPredicate
for RSQL. - assertAllPathsNotNull(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- assertAllPathsNotNull(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- assertAllResourcesNotNull(Iterable<InputStream>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- assertPathNotNull(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- assertPathNotNull(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- assertResourceNotNull(InputStream) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- Asset - Class in com.broadleafcommerce.asset.domain
-
A Asset encapsulates information related to stored, digital content such as images, videos, or text files.
- Asset() - Constructor for class com.broadleafcommerce.asset.domain.Asset
- ASSET_ENTITY_MANAGER_FACTORY - Static variable in class com.broadleafcommerce.asset.provider.jpa.JpaRouteConstants.Persistence
- ASSET_ROUTE_KEY - Static variable in class com.broadleafcommerce.asset.provider.RouteConstants.Persistence
- ASSET_ROUTE_PACKAGE - Static variable in class com.broadleafcommerce.asset.provider.RouteConstants.Persistence
- ASSET_TRANSACTION_MANAGER - Static variable in class com.broadleafcommerce.asset.provider.jpa.JpaRouteConstants.Persistence
- ASSET_TRANSACTION_TEMPLATE - Static variable in class com.broadleafcommerce.asset.provider.jpa.JpaRouteConstants.Persistence
- AssetAutoConfiguration - Class in com.broadleafcommerce.asset.autoconfigure
- AssetAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.autoconfigure.AssetAutoConfiguration
- AssetCacheAutoConfiguration - Class in com.broadleafcommerce.asset.autoconfigure
-
Configuration for engaging default Broadleaf support for Apache Ignite cache
- AssetCacheAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.autoconfigure.AssetCacheAutoConfiguration
- AssetCacheAutoConfiguration.AssetIgniteCacheConfiguration - Class in com.broadleafcommerce.asset.autoconfigure
- assetCacheByUrl() - Method in class com.broadleafcommerce.asset.autoconfigure.AssetCacheAutoConfiguration
- assetCacheManagerCustomizer(IgniteConfigurers.BasicIgniteConfigurer, AssetCacheProperties) - Method in class com.broadleafcommerce.asset.autoconfigure.AssetCacheAutoConfiguration.AssetIgniteCacheConfiguration
- AssetCacheProperties - Class in com.broadleafcommerce.asset.cache
-
Properties that influence cache settings for the asset service
- AssetCacheProperties() - Constructor for class com.broadleafcommerce.asset.cache.AssetCacheProperties
- AssetCacheProperties.StorageLocationMappingCacheProperties - Class in com.broadleafcommerce.asset.cache
- AssetContentUrlSerializerModule - Class in com.broadleafcommerce.asset.jackson
-
Since
ContentUrlResolver
(which is used internally byContentUrlSerializer
) can only work by using prefixes that are only available in a web application context, we should not directly annotate theAsset.url
field withJsonSerialize
. - AssetContentUrlSerializerModule() - Constructor for class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule
- AssetContentUrlSerializerModule.AssetWithContentUrl - Class in com.broadleafcommerce.asset.jackson
- AssetDataRouteSupporting - Interface in com.broadleafcommerce.asset.messaging.data
- AssetDefaultsEnvironmentPostProcessor - Class in com.broadleafcommerce.asset.autoconfigure
-
Initializes the default property overrides for the asset service
- AssetDefaultsEnvironmentPostProcessor() - Constructor for class com.broadleafcommerce.asset.autoconfigure.AssetDefaultsEnvironmentPostProcessor
- AssetEndpoint - Class in com.broadleafcommerce.asset.web.endpoint
- AssetEndpoint(AssetService<Asset>, FolderService<Folder>, StorageService) - Constructor for class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- AssetEndpoint.AssetUpdate - Class in com.broadleafcommerce.asset.web.endpoint
-
A custom DTO that is intended for the specific purpose of supporting PATCH for
Asset
. - AssetIgniteCacheConfiguration() - Constructor for class com.broadleafcommerce.asset.autoconfigure.AssetCacheAutoConfiguration.AssetIgniteCacheConfiguration
- AssetJpaAutoConfiguration - Class in com.broadleafcommerce.asset.provider.jpa.autoconfigure
- AssetJpaAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.provider.jpa.autoconfigure.AssetJpaAutoConfiguration
- AssetMessagingAutoConfiguration - Class in com.broadleafcommerce.asset.messaging.autoconfigure
- AssetMessagingAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.messaging.autoconfigure.AssetMessagingAutoConfiguration
- AssetRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.asset.repository
-
Repository
for persistent counter-parts ofAsset
- AssetSecurityEnhancer - Class in com.broadleafcommerce.asset.web.security
-
Allow anonymous access on the content resolver endpoint
- AssetSecurityEnhancer(InternalAssetProperties) - Constructor for class com.broadleafcommerce.asset.web.security.AssetSecurityEnhancer
- assetService - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- AssetService<P extends Asset> - Interface in com.broadleafcommerce.asset.service
-
Base service API for
Asset
. - AssetServiceAutoConfiguration - Class in com.broadleafcommerce.asset.service.autoconfigure
- AssetServiceAutoConfiguration(InternalAssetProperties, TypeFactory, ImageProperties) - Constructor for class com.broadleafcommerce.asset.service.autoconfigure.AssetServiceAutoConfiguration
- AssetServiceJacksonAutoConfiguration - Class in com.broadleafcommerce.asset.jackson.autoconfigure
-
Asset-service-specific configuration for serialization/deserialization.
- AssetServiceJacksonAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.jackson.autoconfigure.AssetServiceJacksonAutoConfiguration
- assetStorageUtils - Variable in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- assetStorageUtils - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- assetStorageUtils - Variable in class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated.
- AssetStorageUtils - Class in com.broadleafcommerce.asset.service.support
-
Utility class containing helpful functionality pertaining to the storage and processing of
Assets
by theStorageService
. - AssetStorageUtils() - Constructor for class com.broadleafcommerce.asset.service.support.AssetStorageUtils
- AssetTriggeredJobEventConsumer - Interface in com.broadleafcommerce.asset.messaging
-
Spring cloud stream messaging interface for receiving triggered job execution from the scheduled job microservice.
- AssetUpdate() - Constructor for class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- AssetUrlGenerationHelper - Class in com.broadleafcommerce.asset.service.support
-
A class containing convenience methods pertaining to the generation of
Asset.getUrl()
. - AssetUrlGenerationHelper(AssetService<Asset>) - Constructor for class com.broadleafcommerce.asset.service.support.AssetUrlGenerationHelper
- AssetValidationAutoConfiguration - Class in com.broadleafcommerce.asset.service.autoconfigure
-
Asset-specific configuration for validation.
- AssetValidationAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.service.autoconfigure.AssetValidationAutoConfiguration
- AssetValidator - Class in com.broadleafcommerce.asset.service.validation
-
Validations for
Asset
. - AssetValidator() - Constructor for class com.broadleafcommerce.asset.service.validation.AssetValidator
- AssetWebAutoConfiguration - Class in com.broadleafcommerce.asset.web.autoconfigure
- AssetWebAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.web.autoconfigure.AssetWebAutoConfiguration
- AssetWithContentUrl() - Constructor for class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- AsyncConfiguration - Class in com.broadleafcommerce.asset.autoconfigure
-
The configuration for the Spring Async
- AsyncConfiguration() - Constructor for class com.broadleafcommerce.asset.autoconfigure.AsyncConfiguration
- Attribute - Class in com.broadleafcommerce.asset.domain
-
Many entities have customizable dynamic attributes, and this class is intended to hold such values.
- Attribute() - Constructor for class com.broadleafcommerce.asset.domain.Attribute
- Attribute(Object, EmbeddedContextState) - Constructor for class com.broadleafcommerce.asset.domain.Attribute
- AttributeMapConverter - Class in com.broadleafcommerce.asset.provider.jpa.domain.support
- AttributeMapConverter(ObjectMapper) - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.support.AttributeMapConverter
- AUDIO - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
B
- batchOptimizeFiles(Map<String, File>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Delegates to
ImageOperationService
to optimize the given files as a batch. - BEFORE - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is before the query param's value.
- BETWEEN - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is between the query param values.
- BrowserCacheProperties() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- buildContextInfo(String, String) - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- buildContextInfoForAsset(Asset) - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- buildErrorMessage(List<DefaultStorageService.ZipEntryValidationError>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- buildFolderAndPutInMap(String, Map<String, Folder>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Given a directory path that was found in a zip file, build a
Folder
for it and put it in the givenfoldersByPath
map. - buildOperation(File, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- buildOperation(String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- buildStorageLocationMapping(String, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- buildStorageLocationMapping(String, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- BulkAddResourcesResponse - Class in com.broadleafcommerce.asset.storage.provider.service
-
Object that is returned from multi-upload operations in
StorageProvider
, containing information about which resources succeeded and which ones failed. - BulkAddResourcesResponse(Map<String, String>, Map<String, Throwable>) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- BulkStorageException - Exception in com.broadleafcommerce.asset.service
-
An exception that is thrown when many file operations are being performed in bulk (ex: adding/deleting many files in a loop).
- BulkStorageException(String, Map<String, Throwable>) - Constructor for exception com.broadleafcommerce.asset.service.BulkStorageException
- BulkTagRequest - Class in com.broadleafcommerce.asset.domain
-
Request domain for detailing how to handle bulk actions for adding and removing tags on multiple asset
- BulkTagRequest() - Constructor for class com.broadleafcommerce.asset.domain.BulkTagRequest
C
- CACHE_BY_PROVIDER_TYPE_AND_OG_LOCATION - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- CACHE_BY_URL - Static variable in class com.broadleafcommerce.asset.service.DefaultAssetService
- calculateHashedStorageLocationDirectory(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Determines the location of the directory (not a full file path) that should be used to actually store the data for the provided
url
. - canEqual(Object) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.Asset
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.Attribute
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.Folder
- canEqual(Object) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
- canEqual(Object) - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- canEqual(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- canEqual(Object) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- canEqual(Object) - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- canEqual(Object) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- canEqual(Object) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- canEqual(Object) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- CHANNEL - Static variable in interface com.broadleafcommerce.asset.messaging.AssetTriggeredJobEventConsumer
- com.broadleafcommerce.asset.autoconfigure - package com.broadleafcommerce.asset.autoconfigure
- com.broadleafcommerce.asset.cache - package com.broadleafcommerce.asset.cache
- com.broadleafcommerce.asset.domain - package com.broadleafcommerce.asset.domain
- com.broadleafcommerce.asset.domain.type - package com.broadleafcommerce.asset.domain.type
- com.broadleafcommerce.asset.jackson - package com.broadleafcommerce.asset.jackson
- com.broadleafcommerce.asset.jackson.autoconfigure - package com.broadleafcommerce.asset.jackson.autoconfigure
- com.broadleafcommerce.asset.messaging - package com.broadleafcommerce.asset.messaging
- com.broadleafcommerce.asset.messaging.autoconfigure - package com.broadleafcommerce.asset.messaging.autoconfigure
- com.broadleafcommerce.asset.messaging.data - package com.broadleafcommerce.asset.messaging.data
- com.broadleafcommerce.asset.provider - package com.broadleafcommerce.asset.provider
- com.broadleafcommerce.asset.provider.jpa - package com.broadleafcommerce.asset.provider.jpa
- com.broadleafcommerce.asset.provider.jpa.autoconfigure - package com.broadleafcommerce.asset.provider.jpa.autoconfigure
- com.broadleafcommerce.asset.provider.jpa.domain - package com.broadleafcommerce.asset.provider.jpa.domain
- com.broadleafcommerce.asset.provider.jpa.domain.support - package com.broadleafcommerce.asset.provider.jpa.domain.support
- com.broadleafcommerce.asset.provider.jpa.environment - package com.broadleafcommerce.asset.provider.jpa.environment
- com.broadleafcommerce.asset.provider.jpa.repository - package com.broadleafcommerce.asset.provider.jpa.repository
- com.broadleafcommerce.asset.provider.jpa.repository.nontrackable - package com.broadleafcommerce.asset.provider.jpa.repository.nontrackable
- com.broadleafcommerce.asset.provider.jpa.repository.support - package com.broadleafcommerce.asset.provider.jpa.repository.support
- com.broadleafcommerce.asset.repository - package com.broadleafcommerce.asset.repository
- com.broadleafcommerce.asset.service - package com.broadleafcommerce.asset.service
- com.broadleafcommerce.asset.service.autoconfigure - package com.broadleafcommerce.asset.service.autoconfigure
- com.broadleafcommerce.asset.service.autoconfigure.condition - package com.broadleafcommerce.asset.service.autoconfigure.condition
- com.broadleafcommerce.asset.service.image - package com.broadleafcommerce.asset.service.image
- com.broadleafcommerce.asset.service.support - package com.broadleafcommerce.asset.service.support
- com.broadleafcommerce.asset.service.validation - package com.broadleafcommerce.asset.service.validation
- com.broadleafcommerce.asset.storage.provider.service - package com.broadleafcommerce.asset.storage.provider.service
- com.broadleafcommerce.asset.web.autoconfigure - package com.broadleafcommerce.asset.web.autoconfigure
- com.broadleafcommerce.asset.web.endpoint - package com.broadleafcommerce.asset.web.endpoint
- com.broadleafcommerce.asset.web.endpoint.exception - package com.broadleafcommerce.asset.web.endpoint.exception
- com.broadleafcommerce.asset.web.filter.type - package com.broadleafcommerce.asset.web.filter.type
- com.broadleafcommerce.asset.web.security - package com.broadleafcommerce.asset.web.security
- configure(HttpSecurity) - Method in class com.broadleafcommerce.asset.web.security.AssetSecurityEnhancer
- CONTAINS - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if the query param's value is contained by its field's value.
- ContentResolverEndpoint - Class in com.broadleafcommerce.asset.web.endpoint
- ContentResolverEndpoint(ContentResolverService, InternalAssetProperties, AssetService<Asset>, FileTypeMap, CommonApplicationService<Application>) - Constructor for class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- ContentResolverService - Interface in com.broadleafcommerce.asset.storage.provider.service
-
Base service API for fetching the actual digital contents of
Asset
by their URLs. - ContentUrlResolver - Interface in com.broadleafcommerce.asset.jackson
-
Responsible for being able to take an
Asset
and building a fully resolved content URL path that can be used to directly fetch the binary data of the asset. - ContentUrlSerializer - Class in com.broadleafcommerce.asset.jackson
-
Serializer for
Asset.url
that writes the URL field itself and also introduces a newcontentUrl
property on the serialized output. - ContentUrlSerializer() - Constructor for class com.broadleafcommerce.asset.jackson.ContentUrlSerializer
- CONTEXT_REQUEST_PARAM - Static variable in class com.broadleafcommerce.asset.jackson.ServletContentUrlResolver
- CONTEXT_REQUEST_PARAM - Static variable in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- copyStreamToFilePath(InputStream, Path) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- create(HttpServletRequest, ContextInfo, Asset) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- create(P, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
-
Overridden so as to ensure instance fields are correctly initialized.
- createAll(List<P>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
-
Overridden so as to ensure instance fields are correctly initialized.
- createAllFolders(Map<String, Folder>, ContextInfo, Asset) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Creates all of the given
Folders
in the data store, and returns the created items. - createAssetsForSuccessfullyUploadedFiles(DefaultStorageService.ZipExtractionResult, Map<String, String>, Map<String, Folder>, BulkAddResourcesResponse, Asset, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Creates
Assets
in the data store for the files that were successfully uploaded to the storage provider. - createBaseFileUploadState(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateService
- createBaseFileUploadState(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FileUploadStateService
- createFolder(ContextInfo, Folder) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- createImageEffectsUrl(String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- createImageEffectsUrl(String, MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated.
- createNewMappingRecord(String, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Similar to
FilesystemStorageProvider.createNewMappingRecords(Map)
, but only for one record. - createNewMappingRecord(String, String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Similar to
GoogleCloudStorageProvider.createNewMappingRecords(Map)
, but only for one record. - createNewMappingRecords(Map<String, String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Establishes new
StorageLocationMapping
records inStorageLocationMappingService
for the given values. - createNewMappingRecords(Map<String, String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Establishes new
StorageLocationMapping
records inStorageLocationMappingService
for the given values. - createTempFile(String) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- createTempFile(MultipartFile) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- createUniqueUrlFromFilename(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Creates a URL for the given filename.
- createUniqueUrlFromFilename(String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Creates a URL for the given filename.
- createUrl(String) - Method in class com.broadleafcommerce.asset.service.support.AssetUrlGenerationHelper
-
Accepts a filename and strips any path prefix from it, returning just the file's actual name prefixed with a
"/"
. - createUrl(String, String) - Method in class com.broadleafcommerce.asset.service.support.AssetUrlGenerationHelper
-
If no folder name is passed, accepts a filename and strips any path prefix from it, returning just the file's actual name prefixed with a
"/"
. - CSV - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- CustomizedAssetRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.asset.repository
-
Advanced functionality related to asset maintenance and filtering.
D
- DataImportFile() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties.DataImportFile
- DEFAULT_STORAGE_LOCATION_MAPPING_PROVIDER_TYPE - Static variable in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- DEFAULT_STORAGE_LOCATION_MAPPING_PROVIDER_TYPE - Static variable in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- DefaultAssetService<P extends Asset> - Class in com.broadleafcommerce.asset.service
- DefaultAssetService(AssetRepository<Trackable>, RsqlCrudEntityHelper, InternalAssetProperties, TypeFactory) - Constructor for class com.broadleafcommerce.asset.service.DefaultAssetService
- DefaultAssetStorageType - Enum Class in com.broadleafcommerce.asset.domain.type
-
A DefaultAssetStorageType defines options as for where the
Asset's
file is stored. - DefaultAssetType - Enum Class in com.broadleafcommerce.asset.domain.type
-
Describes a basic variety of the general types an asset may fall under.
- DefaultContentResolver - Class in com.broadleafcommerce.asset.storage.provider.service
-
Default implementation of
ContentResolverService
. - DefaultContentResolver(StorageProvider, ImageOperationService, AssetStorageUtils) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- DefaultFilesystemContentResolver - Class in com.broadleafcommerce.asset.storage.provider.service
-
Deprecated, for removal: This API element is subject to removal in a future version.this service works not only with the Filesystem storage, so it was renamed to
DefaultContentResolver
- DefaultFilesystemContentResolver(StorageProvider, ImageOperationService) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated.
- DefaultFileUploadStateHydrationService - Class in com.broadleafcommerce.asset.service
- DefaultFileUploadStateHydrationService(AssetService<Asset>) - Constructor for class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- DefaultFileUploadStateService<P extends FileUploadState> - Class in com.broadleafcommerce.asset.service
- DefaultFileUploadStateService(FileUploadStateRepository<Trackable>, CrudEntityHelper, TypeFactory) - Constructor for class com.broadleafcommerce.asset.service.DefaultFileUploadStateService
- DefaultFolderService<P extends Folder> - Class in com.broadleafcommerce.asset.service
- DefaultFolderService(FolderRepository<Trackable>, RsqlCrudEntityHelper) - Constructor for class com.broadleafcommerce.asset.service.DefaultFolderService
- DefaultImageMagickDetector - Class in com.broadleafcommerce.asset.service.support
-
Executes the
convert --version
command and examines the output to determine whether the ImageMagick commandline utility is available on the current machine. - DefaultImageMagickDetector() - Constructor for class com.broadleafcommerce.asset.service.support.DefaultImageMagickDetector
- DefaultStorageLocationMappingService<P extends StorageLocationMapping> - Class in com.broadleafcommerce.asset.service
-
Default implementation of
StorageLocationMappingService
. - DefaultStorageLocationMappingService(StorageLocationMappingRepository<Identifiable>, RsqlMappableCrudEntityHelper, CacheStateManager, AssetCacheProperties) - Constructor for class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- DefaultStorageLocationMappingService.StorageLocationMappingCacheKeyGen - Class in com.broadleafcommerce.asset.service
-
A
ContextKeyGen
implementation used for caching ofStorageLocationMapping
. - DefaultStorageProviderImplementationTypes - Enum Class in com.broadleafcommerce.asset.storage.provider.service
-
The default storage provider implementation types.
- DefaultStorageService - Class in com.broadleafcommerce.asset.service
- DefaultStorageService(AssetService<Asset>, FolderService<Folder>, MultipartConfigElement, StorageProvider, InternalAssetProperties, TypeFactory, ImageOperationService, FileUploadStateService<FileUploadState>, FileTypeMap, AssetUrlGenerationHelper, DataRouteReference) - Constructor for class com.broadleafcommerce.asset.service.DefaultStorageService
- DefaultStorageService.ZipEntryValidationError - Class in com.broadleafcommerce.asset.service
-
A simple object holding information about a
ZipEntry
which failed validation for some reason. - DefaultStorageService.ZipExtractionResult - Class in com.broadleafcommerce.asset.service
-
A simple object holding information about the results of extracting the contents of a zip file.
- delete(ContextInfo, String) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- delete(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- deleteByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in interface com.broadleafcommerce.asset.provider.jpa.repository.nontrackable.JpaStorageLocationMappingRepository
-
Deletes the mapping records matching the specified filters.
- deleteByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in interface com.broadleafcommerce.asset.repository.StorageLocationMappingRepository
-
Deletes the mapping records matching the specified filters.
- deleteByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- deleteByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in interface com.broadleafcommerce.asset.service.StorageLocationMappingService
-
Deletes the mapping records matching the specified filters.
- deleteMappingRecords(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- deleteMappingRecords(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- deleteResource(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- deleteResource(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- deleteResource(String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Deletes the resource in the configured storage provider at the given path string if it exists.
- deleteResources(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- deleteResources(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- deleteResources(Iterable<String>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Deletes the resources in the configured storage provider at the given path strings if they exist.
- determineAssetTypeFromApplicationMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of application document it is, e.g., "pdf", "json", etc.
- determineAssetTypeFromAudioMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of audio document it is, e.g., "mpeg", "midi", etc.
- determineAssetTypeFromImageMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of image document it is, e.g., "png", "jpeg", etc.
- determineAssetTypeFromMimeType(String) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes a valid mime type (for example, "image/png") and converts it to a general
DefaultAssetType
for use asAsset.getType()
. - determineAssetTypeFromMimeType(String) - Static method in class com.broadleafcommerce.asset.service.support.StorageUtils
-
Deprecated.Takes a valid mime type (for example, "image/png") and converts it to a general
DefaultAssetType
for use asAsset.getType()
. - determineAssetTypeFromOtherMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of other document it is.
- determineAssetTypeFromTextMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of text document it is, e.g., "csv", "plain", etc.
- determineAssetTypeFromVideoMimeType(MediaType) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Takes the extension part of the mime type (after the slash) and determines what type of video document it is, e.g., "webm", "mp4", etc.
- determineReferencedAssetIds(FileUploadState) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- DoNothingImageOperationService - Class in com.broadleafcommerce.asset.service.image
-
A backup
ImageOperationService
implementation that does nothing. - DoNothingImageOperationService() - Constructor for class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- doWithoutCache(Supplier<R>) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- doWithoutPolicyValidation(Supplier<R>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Executes the given
returningWork
with security policy validations disabled. - doWithoutPolicyValidation(Supplier<R>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Executes the given
returningWork
with security policy validations disabled.
E
- EMBED - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- ENDS_WITH - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if the query param's value is contained by its field's value.
- equals(Object) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.Asset
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.Attribute
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.Folder
- equals(Object) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
- equals(Object) - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- equals(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
- equals(Object) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
- equals(Object) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- equals(Object) - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- equals(Object) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- equals(Object) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- equals(Object) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- EQUALS - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is not equal to the query param's value.
- exceedsMaxIndividualAssetSize(long) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- exceedsMaxZipFileSize(long) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- EXCEL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- existsByFolderContextId(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.AssetRepository
-
Returns whether or not there are any assets with
folderId
as theirAsset.folderId
. - existsByFolderId(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
Returns whether or not there are any assets with
folderId
as theirAsset.folderId
. - existsByFolderId(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- existsByParentFolderContextId(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FolderRepository
-
Returns whether or not there are any folders with
folderId
as theirFolder.parentFolderId
. - existsByParentFolderId(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFolderService
- existsByParentFolderId(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FolderService
-
Returns whether or not there are any folders with
folderId
as theirFolder.parentFolderId
. - EXTERNAL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetStorageType
-
Indicates that the asset's file is stored on an externally controlled system, i.e., the
Asset.getUrl()
points to a 3rd-party video-sharing website like Vimeo or YouTube (as opposed to a file on the local filesystem). - extractCurrentEntryToFile(ZipInputStream, File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Reads the current zip entry's data and writes it to the
extractionTarget
. - extractToFileAndPutInMap(String, Path, ZipInputStream, Map<String, File>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Creates a new file inside of
tempDirectoryForExtraction
, extracts the current zip entry's data to it viaDefaultStorageService.extractCurrentEntryToFile(ZipInputStream, File)
, and then puts the appropriate mapping infilesByPath
. - extractZip(File, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
F
- FAILED_TO_STORE_FILE_ERROR_MESSAGE - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- FILE_UPLOAD_ERROR_MESSAGE - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- Filesystem() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
- FILESYSTEM - Enum constant in enum class com.broadleafcommerce.asset.storage.provider.service.DefaultStorageProviderImplementationTypes
-
Specifies that the
FilesystemStorageProvider
implementation of the storage provider should be used. - FilesystemStorageProvider - Class in com.broadleafcommerce.asset.storage.provider.service
-
Default implementation of
StorageProvider
specifically designed to work with the local or shared filesystem as the storage provider for digital content related toAsset
. - FilesystemStorageProvider(InternalAssetProperties) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- FilesystemStorageProvider(InternalAssetProperties, Path) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- FileUploadBadRequestException - Exception in com.broadleafcommerce.asset.web.endpoint.exception
-
Exception that occurs when a file upload request fails validation.
- FileUploadBadRequestException(String) - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.FileUploadBadRequestException
- FileUploadEndpoint - Class in com.broadleafcommerce.asset.web.endpoint
- FileUploadEndpoint(StorageService, FileUploadStateService<FileUploadState>, FileUploadStateHydrationService) - Constructor for class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- FileUploadState - Class in com.broadleafcommerce.asset.domain
-
A FileUploadState encapsulates the state of file that was uploaded asynchronously
- FileUploadState() - Constructor for class com.broadleafcommerce.asset.domain.FileUploadState
- fileUploadStateHydrationService(AssetService<Asset>) - Method in class com.broadleafcommerce.asset.service.autoconfigure.AssetServiceAutoConfiguration
- FileUploadStateHydrationService - Interface in com.broadleafcommerce.asset.service
-
Responsible for performing simple hydration of the references to
Assets
made within aFileUploadState
by querying for those references and populating their full values. - FileUploadStateRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.asset.repository
-
Repository
for persistent counter-parts ofFileUploadState
. - fileUploadStateService - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- fileUploadStateService - Variable in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- fileUploadStateService(FileUploadStateRepository<Trackable>, CrudEntityHelper, TypeFactory) - Method in class com.broadleafcommerce.asset.service.autoconfigure.AssetServiceAutoConfiguration
- FileUploadStateService<P extends FileUploadState> - Interface in com.broadleafcommerce.asset.service
-
Base service API for
FileUploadState
. - FileUploadStatuses - Enum Class in com.broadleafcommerce.asset.domain.type
-
A FileUploadStatuses defines statuses for the
FileUploadState
- findActualStorageLocationsFromMappings(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Queries against
StorageLocationMappingService
to find the actual storage locations from the mapping records, if available in the system. - findActualStorageLocationsFromMappings(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Queries against
StorageLocationMappingService
to find the actual storage locations from the mapping records, if available in the system. - findAllByContextIdIn(List<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.AssetRepository
-
Retrieves a paged list of asset whose context IDs match any of the given IDs.
- findAllByContextIdIn(List<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FolderRepository
-
Retrieves a paged list of folders whose context IDs match any of the given IDs.
- findAllByFileName(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FileUploadStateRepository
-
Finds the
FileUploadStates
by name. - findAllByFileName(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateService
- findAllByFileName(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FileUploadStateService
-
Finds the
FileUploadStates
by name. - findAllByFolderContextId(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.AssetRepository
-
Returns the children asset of the given folder by finding all of the assets whose folder context ID matches the given ID.
- findAllByFolderContextIdIsNull(Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.AssetRepository
-
Reads all asset in root folders.
- findAllByNameContainingIgnoreCase(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FolderRepository
-
Retrieves a paged list of all Folders in the database, optionally filtered by name.
- findAllByParentFolderContextId(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FolderRepository
-
Returns the children folders of the given folder by finding all of the folders whose parent folder context ID matches the given ID.
- findAllByParentFolderContextIdIsNull(Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.FolderRepository
-
Returns all root folders.
- findAssetsAndCollectToMap(List<String>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- findByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in interface com.broadleafcommerce.asset.repository.StorageLocationMappingRepository
- findByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- findByStorageProviderTypeAndOriginalLocationIn(String, Collection<String>) - Method in interface com.broadleafcommerce.asset.service.StorageLocationMappingService
- findByStorageProviderTypeAndOriginalLocationInInternal(String, Collection<String>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- findByUrlAndStorageType(String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- findByUrlAndStorageType(String, String, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.CustomizedAssetRepository
-
Finds the asset whose url and storage type match the provided values.
- findByUrlStartsWithAndStorageType(String, String, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.AssetRepository
-
Finds all of the assets whose URL begins with a given string and whose storage type matches the given value.
- Folder - Class in com.broadleafcommerce.asset.domain
-
A domain that is intended to replicate the concept of folders in a filesystem.
- Folder() - Constructor for class com.broadleafcommerce.asset.domain.Folder
- FolderEndpoint - Class in com.broadleafcommerce.asset.web.endpoint
- FolderEndpoint(FolderService<Folder>, AssetService<Asset>) - Constructor for class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- FolderEndpoint.FolderUpdate - Class in com.broadleafcommerce.asset.web.endpoint
-
A custom DTO that is intended for the specific purpose of supporting PATCH for
Folder
. - FolderRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable> - Interface in com.broadleafcommerce.asset.repository
-
Repository
for persistent counter-parts ofFolders
. - folderService - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- FolderService<P extends Folder> - Interface in com.broadleafcommerce.asset.service
-
Base service API for
Folders
. - FolderUpdate() - Constructor for class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- FolderValidator - Class in com.broadleafcommerce.asset.service.validation
-
Validations for
Folder
. - FolderValidator() - Constructor for class com.broadleafcommerce.asset.service.validation.FolderValidator
- fromMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- fromMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- fromMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- fromMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
G
- GCS - Enum constant in enum class com.broadleafcommerce.asset.storage.provider.service.DefaultStorageProviderImplementationTypes
-
Specifies that the
GoogleCloudStorageProvider
implementation of the storage provider should be used. - generateActualStorageLocation(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Similar to
FilesystemStorageProvider.generateActualStorageLocations(Collection)
, but only for one URL. - generateActualStorageLocation(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Similar to
GoogleCloudStorageProvider.generateActualStorageLocations(Collection)
, but only for one URL. - generateActualStorageLocations(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Used during a 'resource add' operation to determine where new assets should actually be stored.
- generateActualStorageLocations(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Used during a 'resource add' operation to determine where new assets should actually be stored.
- generateAssetForUploadRequest(Asset, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Generates a new
Asset
object for an upload using the mime type and optional properties provided inassetRequest
. - generateAssetsForFiles(Stream<Map.Entry<String, File>>, Map<String, String>, Map<String, Folder>, Asset, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- generateContextDiscriminatedUniqueUrl(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Given a file path, generate a unique URL with a context-discrimination prefix that's suitable for being supplied to the storage provider.
- generateContextDiscriminatedUniqueUrl(String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Given a file path, generate a unique URL with a context-discrimination prefix that's suitable for being supplied to the storage provider.
- generateContextDiscriminatedUniqueUrls(Collection<String>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated.
- generateContextDiscriminatedUniqueUrls(Collection<String>, ContextInfo, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Given a collection of file names, generates a unique URL for each with a context-discrimination prefix that's suitable for being supplied to the storage provider.
- generateGloballyUniqueFilename(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- generateGloballyUniqueFilename(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getAdditionalMetadata() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
Any additional metadata for this resource.
- getAltText() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Text that corresponds to the HTML
alt
attribute that should be used when this asset is rendered in a browser. - getAltText() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Text that corresponds to the HTML
alt
attribute that should be used when this asset is rendered in a browser. - getAltText() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- getApplicationService() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getAsset() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
-
The
JpaAsset
that this tag belongs to. - getAsset() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- getAssetContextIds() - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
-
The list of asset ids with which to add/remove the tag to/from
- getAssetDimensions(ResourceWithMetadata) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Gets dimensions for given asset
ResourceWithMetadata
- getAssetDimensions(File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Gets dimensions for given asset file
- getAssetDimensions(InputStream) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Gets dimensions for given asset
InputStream
- getAssetService() - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getAssetService() - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- getAssetService() - Method in class com.broadleafcommerce.asset.service.support.AssetUrlGenerationHelper
- getAssetService() - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- getAssetService() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- getAssetStorageUtils() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getAssetStorageUtils() - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- getAssetUrlGenerationHelper() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getAttributes() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Additional attributes of the asset.
- getAttributes() - Method in class com.broadleafcommerce.asset.domain.Folder
-
Additional attributes of the folder.
- getAttributes() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getAttributes() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getAttributes() - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- getAuthor() - Method in class com.broadleafcommerce.asset.domain.Asset
-
User who created this asset.
- getAuthor() - Method in class com.broadleafcommerce.asset.domain.Folder
-
User who created this folder.
- getAuthor() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
User who created this asset.
- getAuthor() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getAvailableEffects() - Method in class com.broadleafcommerce.asset.autoconfigure.ImageProperties
-
Which named, ImageMagic effects can be applied for image transformations.
- getBackwardsCompatibleCachingHeaders() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getBlobId(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.since 2.0.3, not used by the framework anymore. Use
GoogleCloudStorageProvider.generateActualStorageLocations(Collection)
orGoogleCloudStorageProvider.resolveExistingActualStorageLocations(Collection)
instead. - getBrowserAssetCaching() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- getBucketName() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- getBusinessDomainType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getBusinessDomainType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getBusinessDomainType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getBusinessDomainType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- getByProviderTypeAndOriginalLocationTtl() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties.StorageLocationMappingCacheProperties
- getByUrlTtl() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- getCacheControl() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getCacheKeyByProviderTypeAndOriginalLocation(StorageLocationMapping) - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- getCacheKeyByProviderTypeAndOriginalLocation(String, String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- getContentDisposition() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The Content-Disposition HTTP header value of the resource if known when reading it.
- getContentLength() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The Content-Length HTTP header value indicating the size of the associated object in bytes.
- getContentProviderUrlPrefix() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Prefix that will be added to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- getContentResolverEndpointPath() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Defines the relative path of the endpoint to use to retrieve the actual digital content, as opposed to retrieving the Asset that represents it.
- getContentResolverService() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getContentType() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The content type of the resource if known when reading it.
- getContentType(MultipartFile) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getContentUrl(Asset) - Method in interface com.broadleafcommerce.asset.jackson.ContentUrlResolver
-
Builds and returns a fully resolved content URL path that can be used to directly fetch the binary data of the asset.
- getContentUrl(Asset) - Method in class com.broadleafcommerce.asset.jackson.ServletContentUrlResolver
-
If the
Asset.storageType
is internal, the content URL will be the result of prepending the necessary prefixes (like the content provider URL) to theAsset.url
. - getContentUrlResolver() - Method in class com.broadleafcommerce.asset.jackson.ContentUrlSerializer
- getContext() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties.DataImportFile
- getContextAwareAssetUrlPrefix(ContextInfo) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Returns the tenant discrimination prefix that would be applied to an asset URL for the given context.
- getContextAwareAssetUrlPrefix(ContextInfo) - Static method in class com.broadleafcommerce.asset.service.support.StorageUtils
-
Deprecated.Returns the tenant discrimination prefix that would be applied to an asset URL for the given context.
- getContextAwareUrl(Asset, ContextInfo) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Returns the
Asset.getUrl()
prepended with a tenant discriminated prefix based on theContextInfo
. - getContextAwareUrl(Asset, ContextInfo) - Static method in class com.broadleafcommerce.asset.service.support.StorageUtils
-
Deprecated.Returns the
Asset.getUrl()
prepended with a tenant discriminated prefix based on theContextInfo
. - getContextId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getContextId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getContextId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getContextInfoFromRequest(ContextInfo, HttpServletRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
-
Check if the contextInfo passed in is missing any relevant information.
- getContextState() - Method in class com.broadleafcommerce.asset.domain.Asset
-
A subset of
Tracking
information to expose the context state for this object. - getContextState() - Method in class com.broadleafcommerce.asset.domain.Attribute
-
A subset of
Tracking
information to expose the context state for this object. - getContextState() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
A subset of
Tracking
information to expose the context state for this object. - getContextState() - Method in class com.broadleafcommerce.asset.domain.Folder
-
A subset of
Tracking
information to expose the context state for this object. - getCustomOperationNames() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getDatasource() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- getDelegating() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- getDisplay() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getDisplay() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getDynamicImgOptimizationOperation() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getEmbedCode() - Method in class com.broadleafcommerce.asset.domain.Asset
-
If and only if the
Asset.type
isDefaultAssetType.EMBED
, this field holds the HTML to embed. - getEmbedCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
If and only if the
JpaAsset.type
isDefaultAssetType.EMBED
, this field holds the HTML to embed. - getEntryFileName() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
-
The file name of the zip entry which failed validation.
- getErrorMessage() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
-
The error message describing why it failed.
- getExternalProvider() - Method in class com.broadleafcommerce.asset.domain.Asset
-
For assets with an external
Asset.storageType
, this field is required and names where the external asset is sourced from. - getExternalProvider() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
For assets with an external
JpaAsset.storageType
, this field is required and names where the external asset is sourced from. - getFailedNormalizedFilePaths(DefaultStorageService.ZipExtractionResult, BulkAddResourcesResponse, Map<String, String>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getFileAsResource(File) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated, for removal: This API element is subject to removal in a future version.this method is no longer used
- getFileExtensionWithDot(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getFileExtensionWithDot(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getFilename() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
Returns
filename
if it is not blank or theResource filename
. - getFileName() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The file name
- getFileName() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getFiles() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties
- getFilesByNormalizedPath() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- getFilesystem() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The properties for the
FilesystemStorageProvider
. - getFilesystemBaseDirectory() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
-
The base path where file system resources will be stored.
- getFileUploadState(String, ContextInfo) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- getFileUploadState(String, ContextRequest) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
-
Looks for an existing
FileUploadState
matching the path or creates one if none found. - getFileUploadStateHydrationService() - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- getFileUploadStateService() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- getFolderContextId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getFolderId() - Method in class com.broadleafcommerce.asset.domain.Asset
-
The context ID of the folder in which this asset is placed.
- getFolderId() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- getFoldersByNormalizedPath() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- getFolderService() - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- getFolderService() - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
- getFolderService() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- getGCSProperties() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getGivenFilenamesToErrors() - Method in exception com.broadleafcommerce.asset.service.BulkStorageException
- getGivenFilenamesToErrors() - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- getGivenFilenamesToSuccessfullyCreatedPaths() - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- getGoogleCloudStorage() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The properties for the
GoogleCloudStorageProvider
. - getHashedResourcePath(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
This method represents the 'legacy' storage path calculation.
- getHashedResourcePath(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getHydratedOrLog(Asset, Map<String, Asset>) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
-
Returns the fully-populated instance of
unhydrated
if it was found, otherwise logs a warning and returnsunhydrated
as-is. - getId() - Method in class com.broadleafcommerce.asset.domain.Asset
-
the context ID of this asset
- getId() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The context ID of the state.
- getId() - Method in class com.broadleafcommerce.asset.domain.Folder
-
The context ID of the folder.
- getId() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
Unique identifier for this record.
- getId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- getIdempotentConsumptionService() - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getImageDimensions(ResourceWithMetadata) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getImageDimensions(File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getImageDimensions(ImageInputStream) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getImageOperationService() - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- getImgBatchConverter() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getImgConvertCmd() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getImgInfo(String) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getImgOptimizationOperation(List<String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getImplementation() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The name of the storage provider implementation.
- getIndividualAssetTooLargeErrorMessage() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getInitialDataProperties() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- getInitUrlPathHelper() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getInternalAssetProperties() - Method in class com.broadleafcommerce.asset.jackson.ServletContentUrlResolver
- getInternalAssetProperties() - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- getInternalAssetProperties() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getJpa() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- getJpegImOperation(List<String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getLastUpdatedDate() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Date the file was last updated.
- getLastUpdatedDate() - Method in class com.broadleafcommerce.asset.domain.Folder
-
Date the folder was last updated.
- getLastUpdatedDate() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Date the file was last updated.
- getLastUpdatedDate() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getLinkedQuery() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
-
Holds the value from
CriteriaContext.getLinkedQuery()
. - getLinkedQueryParams() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
-
Holds the value from
CriteriaContext.getLinkedNarrowingParams()
. - getLiquibase() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- getLocale() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Designate this asset to be used in a specific
Locale
. - getLocale() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Designate this asset to be used in a specific
Locale
- getLocale() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- getManagedType() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- getMatchOutcome(ConditionContext, AnnotatedTypeMetadata) - Method in class com.broadleafcommerce.asset.service.autoconfigure.condition.ImageMagickAvailable
- getMaxAge() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- getMaxGeneratedDirectoryDepth() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
-
URLs for images and other content will be stored efficiently on the filesystem using a set of generated directories based on the MD5 hash of the filename.
- getMaxGeneratedDirectoryDepth() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- getMaxGeneratedDirectoryDepth() - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getMaxGeneratedDirectoryDepth() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getMaxIndividualAssetSize() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
The maximum file size an individual asset can have.
- getMaxZipFileSize() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
The maximum file size a zip file (sent in multi-upload requests) can have.
- getMimeFileTypeMap() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getMimeFileTypeMap() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getMimeFileTypeMap() - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getMimeFileTypeMap() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getMimeFileTypeMap() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getMimeType() - Method in class com.broadleafcommerce.asset.domain.Asset
-
MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.
- getMimeType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.
- getMimeType(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getMimeType(MultipartFile) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getMimeTypeNotSupportedErrorMessage(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- getMimeTypeWhitelist() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
Set of MIME types that determine which types of resources are allowed to be uploaded.
- getName() - Method in class com.broadleafcommerce.asset.domain.Folder
-
The user facing name of this folder.
- getName() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getName() - Method in interface com.broadleafcommerce.asset.service.image.NamedOperation
-
Get the name of
NamedOperation
- getName() - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- getNarrowingHelper() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- getObjectMapper() - Method in class com.broadleafcommerce.asset.jackson.ServletContentUrlResolver
- getOperations() - Method in interface com.broadleafcommerce.asset.service.image.NamedOperation
-
Get the the
Map
of operations NOTE: the key of this map should be one of the ImageMagick operations that configured by the property broadleaf.image.availableEffects - getOrder() - Method in interface com.broadleafcommerce.asset.service.image.NamedOperation
- getOriginalLocation() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
The original location that a caller gave to the
StorageProvider
to associate with the binary data. - getOriginalLocation() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- getPageSize(ScheduledJobRef) - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getParentDirectoryPath(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Gets the parent directory path from the given normalized path.
- getParentFolderContextId() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getParentFolderId() - Method in class com.broadleafcommerce.asset.domain.Folder
- getParentFolderId() - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- getParentFolderId(String, Map<String, Folder>, Asset) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Gets the parent directory path from
normalizedPath
, gets theFolder
for that parent directory path increatedFoldersByNormalizedPath
, and returns itsFolder.getId()
. - getPath() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties.DataImportFile
- getPathPrefixInBucket() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- getPhase() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- getPngGifImgOperation(List<String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- getProjectId() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- getRepository() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- getRepository() - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- getRepository() - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateService
- getRepository() - Method in class com.broadleafcommerce.asset.service.DefaultFolderService
- getRepository() - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- getResource() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The resource descriptor.
- getResource(ContextInfo, MultiValueMap<String, String>, HttpServletRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getResourceLoader() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- getResourceNamesToIgnore() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Set of resource names to ignore when uploading.
- getResourceWithMetadata(Blob) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getRoutes() - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getRsqlQueryTransformers() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- getRsqlVisitor() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- getService() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getSize() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Size in bytes of the file represented by this asset.
- getSize() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Size in bytes of the file represented by this asset.
- getSizeWithUnits() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Added to provide a more human-readable way to display
Asset.size
by appending the units. - getStatus() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The status of the uploading
- getStatus() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getStorage() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getStorageLocationMapping() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- getStorageLocationMappingCacheKeyGen() - Method in class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService
- getStorageLocationMappingProviderType() - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getStorageLocationMappingProviderType() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getStorageLocationMappingSvc() - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getStorageLocationMappingSvc() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getStorageProvider() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- getStorageProvider() - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getStorageProvider() - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- getStorageProviderLocation() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
The actual location within the
StorageProvider
backing datastore that holds the binary data of the file. - getStorageProviderLocation() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- getStorageProviderType() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
Each
StorageProvider
implementation should correspond to a different type value here. - getStorageProviderType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- getStorageService() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- getStorageService() - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- getStorageService() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- getStorageType() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Defines where the digital content represented by this asset is stored.
- getStorageType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Defines where the digital content represented by this asset is stored.
- getTag() - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
-
The tag with which to perform the action
- getTag() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
-
The actual tag value.
- getTag() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- getTags() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Descriptive or identifying labels.
- getTags() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Descriptive or identifying labels.
- getTags() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- getTemporaryDirectoryFilesWereExtractedTo() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- getTitle() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Text that corresponds to the HTML
title
attribute that should be used when this asset is rendered in a browser. - getTitle() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Text that corresponds to the HTML
title
attribute that should be used when this asset is rendered in a browser. - getTitle() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- getTracking() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- getTracking() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getTracking() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- getType() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Describes the general type of the asset.
- getType() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Describes the general type of the asset.
- getTypeFactory() - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- getTypeFactory() - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateService
- getTypeFactory() - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- getTypeFactory() - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- getTypeFactory() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- getUnsuccessfulUploadFileNames() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The
Set
of the file names that weren't successfully uploaded - getUnsuccessfulUploadFileNames() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getUploadDate() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Date the file was uploaded to create this asset.
- getUploadDate() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Date the file was uploaded to create this asset.
- getUploadedAsset() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The
List
of the uploadedAsset
- getUploadedAssetContextIds() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- getUrl() - Method in class com.broadleafcommerce.asset.domain.Asset
-
Location used to resolve this asset by callers using the service such as "/icon.png" for an
internal asset
or "https://www.youtube.com/watch?v=a1S2d3F4" forexternal asset
. - getUrl() - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- getUrl() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Location used to resolve this asset by callers using the service such as "/icon.png" for an
internal asset
or "https://www.youtube.com/watch?v=a1S2d3F4" forexternal asset
. - getValue() - Method in class com.broadleafcommerce.asset.domain.Attribute
-
The value represented by this attribute.
- getValue() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- getZipTooLargeErrorMessage() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- GoogleCloudStorage() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- GoogleCloudStorageProvider - Class in com.broadleafcommerce.asset.storage.provider.service
-
The default implementation of the
StorageProvider
for the Google Cloud storage. - GoogleCloudStorageProvider(InternalAssetProperties, Storage, FileTypeMap, TypeFactory) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- GoogleCloudStorageProviderAutoConfiguration - Class in com.broadleafcommerce.asset.service.autoconfigure
- GoogleCloudStorageProviderAutoConfiguration() - Constructor for class com.broadleafcommerce.asset.service.autoconfigure.GoogleCloudStorageProviderAutoConfiguration
- GTE - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is
<=
the query param's.
H
- handleBulkStorageException(BulkStorageException, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- handleExceptionWithZipFile(FileUploadState, String, Exception, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- handleFailedValidationWithZipFile(FileUploadState, String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- handleImageOptimizationException(Exception, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- handleInvalidUploadRequest(Exception, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- handleMessage(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- handleResourceResolutionException(ResourceResolutionException, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- handleStorageException(Exception, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- hashCode() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- hashCode() - Method in class com.broadleafcommerce.asset.domain.Asset
- hashCode() - Method in class com.broadleafcommerce.asset.domain.Attribute
- hashCode() - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
- hashCode() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
- hashCode() - Method in class com.broadleafcommerce.asset.domain.Folder
- hashCode() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
- hashCode() - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- hashCode() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
- hashCode() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
- hashCode() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- hashCode() - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- hashCode() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- hashCode() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- hashCode() - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- hydrate(FileUploadState, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFileUploadStateHydrationService
- hydrate(FileUploadState, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FileUploadStateHydrationService
-
Gets the IDs of
Assets
that are referenced byunhydrated
, finds the corresponding items in the data store, and then replaces each reference with the fully populated representation of the item.
I
- IGNORE_CASE - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.OperatorOption
-
The asset will match if it's field matches the value(s) regardless of case.
- IMAGE - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- IMAGE_MAGICK_DETECTOR_OVERRIDE_ENV_PROPERTY - Static variable in class com.broadleafcommerce.asset.service.autoconfigure.condition.ImageMagickAvailable
- imageMagickAvailable() - Method in class com.broadleafcommerce.asset.service.support.DefaultImageMagickDetector
- imageMagickAvailable() - Method in interface com.broadleafcommerce.asset.service.support.ImageMagickDetector
-
Determines if the ImageMagick commandline utillity is available on the current machine.
- ImageMagickAvailable - Class in com.broadleafcommerce.asset.service.autoconfigure.condition
-
SpringBootCondition
based upon whether the ImageMagick commandline utility is available. - ImageMagickAvailable() - Constructor for class com.broadleafcommerce.asset.service.autoconfigure.condition.ImageMagickAvailable
- ImageMagickDetector - Interface in com.broadleafcommerce.asset.service.support
-
Represents a class that can identify whether the ImageMagick commandline utility is available on the current machine.
- ImageMagickImageOperationService - Class in com.broadleafcommerce.asset.service.image
-
The default implementation of the
ImageOperationService
. - ImageMagickImageOperationService(StorageProvider, ImageProperties, FileTypeMap) - Constructor for class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- ImageOperationException - Exception in com.broadleafcommerce.asset.service.image
-
Exception indicating an error occurred while attempting to perform an image operation on a resource.
- ImageOperationException() - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOperationException
- ImageOperationException(String) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOperationException
- ImageOperationException(String, Throwable) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOperationException
- ImageOperationException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOperationException
- ImageOperationException(Throwable) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOperationException
- imageOperationService - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- ImageOperationService - Interface in com.broadleafcommerce.asset.service.image
-
This interface exposes methods required to apply such image effects like resize, crop, sharpen.
- ImageOptimizationException - Exception in com.broadleafcommerce.asset.service.image
-
Exception that occurs when the optimization of the images failed
- ImageOptimizationException(String) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOptimizationException
- ImageOptimizationException(String, Throwable) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOptimizationException
- ImageOptimizationException(Throwable) - Constructor for exception com.broadleafcommerce.asset.service.image.ImageOptimizationException
- imageProperties - Variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- ImageProperties - Class in com.broadleafcommerce.asset.autoconfigure
-
Properties related to the
ImageOperationService
. - ImageProperties() - Constructor for class com.broadleafcommerce.asset.autoconfigure.ImageProperties
- imgBatchConverter() - Method in class com.broadleafcommerce.asset.service.autoconfigure.AssetServiceAutoConfiguration
- imgConvertCmd() - Method in class com.broadleafcommerce.asset.service.autoconfigure.AssetServiceAutoConfiguration
- IN_PROGRESS - Enum constant in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Indicates that the uploading is in progress
- init() - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- InitialDataAutoConfiguration - Class in com.broadleafcommerce.asset.autoconfigure
-
Configuration class for initializing the base seed data for the app.
- InitialDataAutoConfiguration(StorageService, FileUploadStateService<FileUploadState>, ResourceLoader, InitialDataAutoConfiguration.InitialDataProperties) - Constructor for class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- InitialDataAutoConfiguration.InitialDataProperties - Class in com.broadleafcommerce.asset.autoconfigure
-
Configuration properties for loading any initial asset data on startup.
- InitialDataAutoConfiguration.InitialDataProperties.DataImportFile - Class in com.broadleafcommerce.asset.autoconfigure
-
Represents a file to be uploaded to a certain context.
- InitialDataProperties() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties
- initOptimizeImgOperation() - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- INTERNAL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetStorageType
-
Indicates that the file is stored in an internally controlled system, e.g., on the local filesystem or a configured storage provider like Google Cloud, Amazon S3, Azure, etc.
- internalAssetProperties - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- internalAssetProperties - Variable in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- InternalAssetProperties - Class in com.broadleafcommerce.asset.autoconfigure
-
Properties related to the
Asset
of storageTypeDefaultAssetStorageType.INTERNAL
. - InternalAssetProperties() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- InternalAssetProperties.BrowserCacheProperties - Class in com.broadleafcommerce.asset.autoconfigure
-
Properties for browser-related caching of asset content returned by the
ContentResolverEndpoint
. - InternalAssetProperties.StorageProvider - Class in com.broadleafcommerce.asset.autoconfigure
- InternalAssetProperties.StorageProvider.Filesystem - Class in com.broadleafcommerce.asset.autoconfigure
-
Properties related to the using the filesystem as the Asset digital content storage provider.
- InternalAssetProperties.StorageProvider.GoogleCloudStorage - Class in com.broadleafcommerce.asset.autoconfigure
- isAudio(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isByProviderTypeAndOriginalLocationEnabled() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties.StorageLocationMappingCacheProperties
- isCsv(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isEmbed(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isEnabled() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- isExcel(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isImage(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isLoadOnStartup() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties
- isPdf(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isPrependContentResolverEndpointPath() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
If "contentProviderUrlPrefix" is not blank, then this property determines whether to also prepend the "contentResolverEndpointPath" to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- isPrependRequestContextPath() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Determines whether to prepend the request context path to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- isPrependServletContextPath() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
If "contentProviderUrlPrefix" is not blank, then this property determines whether to also prepend the servlet's context path (e.g., "/asset") to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- isRunning() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- isStoreZipFileOnProvider() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
In multi-upload requests, the zip file's contents are always extracted and stored on the provider.
- isSupportedContentType(String) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- isText(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isUnknown(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isValidImageEffectTags(MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- isValidImageEffectTags(MultiValueMap<String, String>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- isValidImageEffectTags(MultiValueMap<String, String>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Check that the
imageEffectsTags
is valid - isVideo(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isWhitelistedMimeType(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- isWhitelistedMimeType(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- isWhitelistedMimeType(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- isWhitelistedMimeType(String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Determines whether the given MIME type string is supported by this provider.
- isWord(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- isZipType(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
J
- JOB_TYPE - Static variable in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- JpaAsset - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
Persistent counter-part to a
Asset
for use with a JPA-supported datastore. - JpaAsset() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- JpaAssetProperties - Class in com.broadleafcommerce.asset.provider.jpa.environment
- JpaAssetProperties() - Constructor for class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- JpaAssetRepository<D extends JpaAsset> - Interface in com.broadleafcommerce.asset.provider.jpa.repository
-
JPA domain-specific implementation of
AssetRepository
. - JpaAssetTag - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
JpaAsset.tags
are meant to be query-able and individually modifiable, and thus it is necessary to maintain them in a separate table. - JpaAssetTag() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
- JpaAssetTagId - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
The ID class representing the composite key for
JpaAssetTag
. - JpaAssetTagId() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- JpaAssetTagId(String, String) - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- JpaAttribute - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
Persistent counter-part to an
Attribute
for use with a JPA-supported datastore. - JpaAttribute() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- JpaAttribute(Object) - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- JpaCustomizedAssetRepository<D extends JpaAsset> - Class in com.broadleafcommerce.asset.provider.jpa.repository
-
Default implementation of
CustomizedAssetRepository
for JPA. - JpaCustomizedAssetRepository(TrackableBehaviorUtil, List<RsqlQueryTransformer>, JpaCriteriaBuilderRsqlVisitor, JpaFiltersCriteriaBuilder, RepositoryEntityTypeManager, FilterParser<Node>) - Constructor for class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- JpaFileUploadState - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
Persistent counter-part to
FileUploadState
for use with a JPA-supported datastore. - JpaFileUploadState() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- JpaFileUploadStateRepository<D extends JpaFileUploadState> - Interface in com.broadleafcommerce.asset.provider.jpa.repository
-
JPA domain-specific implementation of
FileUploadStateRepository
. - JpaFolder - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
Persistent counter-part to
Folder
for use with a JPA-supported datastore. - JpaFolder() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- JpaFolderRepository<D extends JpaFolder> - Interface in com.broadleafcommerce.asset.provider.jpa.repository
-
JPA domain-specific implementation of
FolderRepository
. - JpaRouteConstants - Class in com.broadleafcommerce.asset.provider.jpa
- JpaRouteConstants.Persistence - Class in com.broadleafcommerce.asset.provider.jpa
- JpaStorageLocationMapping - Class in com.broadleafcommerce.asset.provider.jpa.domain
-
Persisted domain counterpart of
StorageLocationMapping
. - JpaStorageLocationMapping() - Constructor for class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- JpaStorageLocationMappingRepository<D extends JpaStorageLocationMapping> - Interface in com.broadleafcommerce.asset.provider.jpa.repository.nontrackable
-
JPA domain-specific implementation of
StorageLocationMappingRepository
.
L
- LinkedRSQLQueryDetails - Class in com.broadleafcommerce.asset.provider.jpa.repository.support
-
Intended to hold the values from
CriteriaContext.getLinkedQuery()
andCriteriaContext.getLinkedNarrowingParams()
after processing RSQL filters. - LinkedRSQLQueryDetails(CriteriaQuery<?>, Map<String, Object>) - Constructor for class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
- listen(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
-
Queries the data store for all assets and updates their attributes.
- loadInitialDataForFile(InitialDataAutoConfiguration.InitialDataProperties.DataImportFile) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- LTE - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is
>=
the query param's.
M
- mapEligibleProperties(Asset, Asset) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
If
source
is present, will copy itsAsset.getTags()
,Asset.getFolderId()
andAsset.getLocale()
totargetAsset
. - mapGivenPathsToHashedPaths(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.since 2.0.3, not used by the framework anymore. Use
FilesystemStorageProvider.generateActualStorageLocations(Collection)
orFilesystemStorageProvider.resolveExistingActualStorageLocations(Collection)
instead. - matches(String) - Method in enum class com.broadleafcommerce.asset.web.filter.type.Operator
- matches(String) - Method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorOption
- matches(String) - Method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
Determines whether the given operator string matches the scope.
- matchesAnyResourceNameToIgnore(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- MIME_TYPE_NOT_SUPPORTED_FMT - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- moveResourceFromDirectory(File) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Moves a given
resource
from a directory to the configured storage provider and returns the path as a string to the resource within that provider. - moveResourceFromDirectoryAndGetPath(File) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
- moveResourcesFromDirectory(Iterable<File>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Moves all the given
resources
from a directory to the configured storage provider and returns the paths to the resources within that provider as strings. - moveResourcesFromDirectoryAndGetPaths(Iterable<File>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
- multipartConfigElement - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
N
- name() - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProviderImplementationTypes
- NamedOperation - Interface in com.broadleafcommerce.asset.service.image
-
NamedOperation
is an interface that can be implemented to add group of operation. - namedOperations - Variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- NONE - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
The asset will match iff none of the query param's values match its field's value.
- NOT_EQUALS - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if its field's value is not equal to the query param's value.
O
- ONLY_ZIP_SUPPORTED - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- operator() - Method in enum class com.broadleafcommerce.asset.web.filter.type.Operator
- Operator - Enum Class in com.broadleafcommerce.asset.web.filter.type
-
Enumeration of supported filter operators.
- OperatorOption - Enum Class in com.broadleafcommerce.asset.web.filter.type
-
Enumeration of supported filter operator options.
- OperatorScope - Enum Class in com.broadleafcommerce.asset.web.filter.type
-
Enumeration of supported filter operator scopes.
- OPTIMIZED_IMG_NAME_PATTERN - Static variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- optimizeImage(MultipartFile) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- optimizeImage(MultipartFile) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- optimizeImage(MultipartFile) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Optimizes a GIF, PNG, or JPEG in an attempt to reduce its size.
- optimizeImageBatch(Map<String, File>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- optimizeImageBatch(Map<String, File>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- optimizeImageBatch(Map<String, File>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
This method will batch-optimize any GIF, PNG, and JPEG image files in the input map in an attempt to reduce their sizes.
- optimizeImgOperation - Variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- option() - Method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorOption
P
- PACKAGE_FRAGMENT - Static variable in interface com.broadleafcommerce.asset.messaging.data.AssetDataRouteSupporting
- PARTIALLY_SUCCESSFUL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Indicates that some of the files from zip archive weren't uploaded
- PDF - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- postProcessEnvironment(ConfigurableEnvironment, SpringApplication) - Method in class com.broadleafcommerce.asset.autoconfigure.AssetDefaultsEnvironmentPostProcessor
- prependBucketPathPrefix(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- prependContextAwarePrefix(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.support.AssetStorageUtils
-
Returns the
assetUrl
prepended with a tenant discriminated prefix based on theContextInfo
. - prependContextAwarePrefix(String, ContextInfo) - Static method in class com.broadleafcommerce.asset.service.support.StorageUtils
-
Deprecated.Returns the
assetUrl
prepended with a tenant discriminated prefix based on theContextInfo
. - ProcessAssetsListener - Class in com.broadleafcommerce.asset.messaging
-
A listener that accepts triggered scheduled job events of type
ProcessAssetsListener.JOB_TYPE
and updates the attributes of all assets in the data store. - ProcessAssetsListener(IdempotentMessageConsumptionService, AssetService<Asset>, StorageProvider, StorageService, List<AssetDataRouteSupporting>) - Constructor for class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- processZipExtractionResult(DefaultStorageService.ZipExtractionResult, FileUploadState, Asset, ContextInfo, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated.
- processZipExtractionResult(DefaultStorageService.ZipExtractionResult, FileUploadState, Asset, ContextInfo, boolean, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Given a
DefaultStorageService.ZipExtractionResult
, creates all of the necessaryFolders
in the data store, uploads the extracted files to the storage provider (after optimizing them if necessary), and createsAssets
in the data store for all successfully uploaded files.
R
- read(ContextInfo, String) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- read(HttpServletRequest, ContextInfo, String) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- readAllAssetContentsOfFolder(ContextInfo, String, Pageable, Node) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- readAllAssets(HttpServletRequest, ContextInfo, String, Pageable, Node) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- readAllAssetsInFolder(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
Reads all of the assets in the given folder.
- readAllAssetsInFolder(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- readAllByContextIds(List<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
Finds all asset with IDs in the supplied list.
- readAllByContextIds(List<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- readAllByContextIds(List<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFolderService
- readAllByContextIds(List<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FolderService
-
Finds all folders with IDs in the supplied list.
- readAllByName(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFolderService
- readAllByName(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FolderService
-
Reads all of the folders in the database, optionally filtering by name if specified.
- readAllOrRootFolders(ContextInfo, String, Boolean, Pageable, Node) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- readAllSubFoldersOfFolder(ContextInfo, String, Pageable, Node) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- readAllSubFoldersOfFolder(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultFolderService
- readAllSubFoldersOfFolder(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.FolderService
-
Reads all of the folders who have the given folder as a parent.
- readByUrlAndStorageType(String, String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
Finds the asset whose url and storage type (optional) match the provided values.
- readByUrlAndStorageType(String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- readByUrlStartsWithAndStorageType(String, String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
Finds all of the assets whose URL begins with a given string and whose storage type matches the given value.
- readByUrlStartsWithAndStorageType(String, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- readEntryAndReturnIfSizeExceedsLimit(ZipInputStream) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Reads and counts the byte size of the current entry in the zip input stream, reporting if the size exceeds the
InternalAssetProperties.getMaxIndividualAssetSize()
. - readResource(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- readResource(String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.
- readResource(String, MultiValueMap<String, String>, ContextInfo) - Method in interface com.broadleafcommerce.asset.storage.provider.service.ContentResolverService
-
This method will accept a URL and then return a handle to stream the resource from the
StorageProvider
. - readResource(String, MultiValueMap<String, String>, ContextInfo) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated.
- readResources(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- readResources(Iterable<String>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Deprecated, for removal: This API element is subject to removal in a future version.
- readResourceWithMetadata(String, MultiValueMap<String, String>, ContextInfo) - Method in interface com.broadleafcommerce.asset.storage.provider.service.ContentResolverService
-
This method will accept a URL and then return a handle to stream the resource from the
StorageProvider
. - readResourceWithMetadata(String, MultiValueMap<String, String>, ContextInfo) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultContentResolver
- readResourceWithMetadata(String, MultiValueMap<String, String>, ContextInfo) - Method in class com.broadleafcommerce.asset.storage.provider.service.DefaultFilesystemContentResolver
-
Deprecated.
- readStreamableResource(String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Retrieves the
resource
in the configured storage provider at the given path string if it exists. - readStreamableResources(Iterable<String>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Retrieves the
resources
in the configured storage provider at the given path strings if they exist. - readStreamableResourcesWithMetadata(Iterable<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- readStreamableResourcesWithMetadata(Iterable<String>) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Retrieves the
resources
in the configured storage provider at the given path strings if they exist. - readStreamableResourceWithMetadata(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- readStreamableResourceWithMetadata(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- readStreamableResourceWithMetadata(String) - Method in interface com.broadleafcommerce.asset.storage.provider.service.StorageProvider
-
Retrieves the
resource
in the configured storage provider at the given path string if it exists. - reference - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- removeFile(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- removeFile(String) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- removeFile(String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- removeFile(String, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Remove the provided file from the storage provider.
- replace(String, P, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
-
Overridden so as to ensure instance fields are correctly initialized.
- resolveExistingActualStorageLocation(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Similar to
FilesystemStorageProvider.resolveExistingActualStorageLocations(Collection)
, but only for one URL. - resolveExistingActualStorageLocation(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Similar to
GoogleCloudStorageProvider.resolveExistingActualStorageLocations(Collection)
, but only for one URL. - resolveExistingActualStorageLocations(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
-
Used during resource read/delete operations to figure out what the actual storage locations are for some given URLs.
- resolveExistingActualStorageLocations(Collection<String>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
-
Used during resource read/delete operations to figure out what the actual storage locations are for some given URLs.
- ResourceResolutionException - Exception in com.broadleafcommerce.asset.web.endpoint.exception
-
Error that is thrown when a resource cannot be streamed for some reason.
- ResourceResolutionException() - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException
- ResourceResolutionException(String) - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException
- ResourceResolutionException(String, Throwable) - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException
- ResourceResolutionException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException
- ResourceResolutionException(Throwable) - Constructor for exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException
- ResourceWithMetadata - Class in com.broadleafcommerce.asset.storage.provider.service
-
The
Resource
wrapper that contains the additional resource metadata. - ResourceWithMetadata() - Constructor for class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- ResourceWithMetadata(Resource, String, String, String, long, Map<String, Object>) - Constructor for class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- rootLocation - Variable in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- RouteConstants - Class in com.broadleafcommerce.asset.provider
- RouteConstants.Persistence - Class in com.broadleafcommerce.asset.provider
- runMagickVersionCommand() - Method in class com.broadleafcommerce.asset.service.support.DefaultImageMagickDetector
S
- scope() - Method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
- searchAll(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- searchAll(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.repository.CustomizedAssetRepository
-
If
searchString
is provided, then this method will search for assets whoseAsset.url
,Asset.title
,Asset.altText
, orAsset.tags
contain it. - searchAll(String, Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.asset.service.AssetService
-
If
searchString
is provided, then this method will search for assets whoseAsset.url
,Asset.title
,Asset.altText
, orAsset.tags
contain it. - searchAll(String, Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
- serialize(String, JsonGenerator, SerializerProvider) - Method in class com.broadleafcommerce.asset.jackson.ContentUrlSerializer
- ServletContentUrlResolver - Class in com.broadleafcommerce.asset.jackson
-
Implements
ContentUrlResolver
for web applications of typeConditionalOnWebApplication.Type.SERVLET
. - ServletContentUrlResolver(InternalAssetProperties, ObjectMapper) - Constructor for class com.broadleafcommerce.asset.jackson.ServletContentUrlResolver
- setAdditionalMetadata(Map<String, Object>) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
Any additional metadata for this resource.
- setAltText(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Text that corresponds to the HTML
alt
attribute that should be used when this asset is rendered in a browser. - setAltText(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Text that corresponds to the HTML
alt
attribute that should be used when this asset is rendered in a browser. - setAsset(JpaAsset) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
-
The
JpaAsset
that this tag belongs to. - setAsset(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- setAssetContextIds(Set<String>) - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
-
The list of asset ids with which to add/remove the tag to/from
- setAssetService(AssetService<Asset>) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
-
Lazy injection since this validator is itself a service component.
- setAssetStorageUtils(AssetStorageUtils) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- setAttributes(Map<String, Attribute>) - Method in class com.broadleafcommerce.asset.domain.Folder
-
Additional attributes of the folder.
- setAttributes(Map<String, JpaAttribute>) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Additional attributes of the asset.
- setAttributes(Map<String, String>) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- setAuthor(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
User who created this asset.
- setAuthor(String) - Method in class com.broadleafcommerce.asset.domain.Folder
-
User who created this folder.
- setAuthor(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
User who created this asset.
- setAuthor(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setAvailableEffects(List<String>) - Method in class com.broadleafcommerce.asset.autoconfigure.ImageProperties
-
Which named, ImageMagic effects can be applied for image transformations.
- setBrowserAssetCaching(InternalAssetProperties.BrowserCacheProperties) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- setBucketName(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- setByProviderTypeAndOriginalLocationEnabled(boolean) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties.StorageLocationMappingCacheProperties
- setByProviderTypeAndOriginalLocationTtl(Duration) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties.StorageLocationMappingCacheProperties
- setByUrlTtl(Duration) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- setContentDisposition(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The Content-Disposition HTTP header value of the resource if known when reading it.
- setContentLength(long) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The Content-Length HTTP header value indicating the size of the associated object in bytes.
- setContentProviderUrlPrefix(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Prefix that will be added to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- setContentResolver(ContentUrlResolver) - Method in class com.broadleafcommerce.asset.jackson.ContentUrlSerializer
-
We use this autowired setter here, as Jackson will throw a
JsonMappingException
if it cannot find a default constructor. - setContentResolverEndpointPath(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- setContentType(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The content type of the resource if known when reading it.
- setContext(ContextRequest) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties.DataImportFile
- setContextId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- setContextId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setContextId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.asset.domain.Attribute
-
A subset of
Tracking
information to expose the context state for this object. - setContextState(ContextState) - Method in class com.broadleafcommerce.asset.domain.Asset
-
A subset of
Tracking
information to expose the context state for this object. - setContextState(ContextState) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
A subset of
Tracking
information to expose the context state for this object. - setContextState(ContextState) - Method in class com.broadleafcommerce.asset.domain.Folder
-
A subset of
Tracking
information to expose the context state for this object. - setDatasource(DataSourceProperties) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- setDelegating(SchemaDelegatingProperties) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- setEmbedCode(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
If and only if the
Asset.type
isDefaultAssetType.EMBED
, this field holds the HTML to embed. - setEmbedCode(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
If and only if the
JpaAsset.type
isDefaultAssetType.EMBED
, this field holds the HTML to embed. - setEnabled(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- setExternalProvider(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
For assets with an external
Asset.storageType
, this field is required and names where the external asset is sourced from. - setExternalProvider(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
For assets with an external
JpaAsset.storageType
, this field is required and names where the external asset is sourced from. - setFilename(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The file name.
- setFileName(String) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The file name
- setFileName(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setFiles(Set<InitialDataAutoConfiguration.InitialDataProperties.DataImportFile>) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties
- setFilesByNormalizedPath(Map<String, File>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- setFilesystem(InternalAssetProperties.StorageProvider.Filesystem) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The properties for the
FilesystemStorageProvider
. - setFilesystemBaseDirectory(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
- setFolderContextId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- setFolderId(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
The context ID of the folder in which this asset is placed.
- setFoldersByNormalizedPath(Map<String, Folder>) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- setFolderService(FolderService<Folder>) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
-
Lazy injection since this validator is itself a service component.
- setFolderService(FolderService<Folder>) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
-
Lazy injection since this validator is itself a service component.
- setGoogleCloudStorage(InternalAssetProperties.StorageProvider.GoogleCloudStorage) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The properties for the
GoogleCloudStorageProvider
. - setId(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
the context ID of this asset
- setId(String) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The context ID of the state.
- setId(String) - Method in class com.broadleafcommerce.asset.domain.Folder
-
The context ID of the folder.
- setId(String) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
Unique identifier for this record.
- setId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- setImplementation(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
The name of the storage provider implementation.
- setJpa(JpaProperties) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- setLastUpdatedDate(Instant) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Date the file was last updated.
- setLastUpdatedDate(Instant) - Method in class com.broadleafcommerce.asset.domain.Folder
-
Date the folder was last updated.
- setLastUpdatedDate(Instant) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Date the file was last updated.
- setLastUpdatedDate(Instant) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setLiquibase(LiquibaseProperties) - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- setLoadOnStartup(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties
- setLocale(Locale) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Designate this asset to be used in a specific
Locale
. - setLocale(Locale) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Designate this asset to be used in a specific
Locale
- setMaxAge(Duration) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- setMaxGeneratedDirectoryDepth(int) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
-
Sets the maximum generated directory depth on the filesystem based on the MD5 hash of the filename.
- setMaxGeneratedDirectoryDepth(int) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
-
Sets the maximum generated directory depth on the filesystem based on the MD5 hash of the filename.
- setMaxIndividualAssetSize(DataSize) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
The maximum file size an individual asset can have.
- setMaxZipFileSize(DataSize) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
The maximum file size a zip file (sent in multi-upload requests) can have.
- setMimeFileTypeMap(FileTypeMap) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- setMimeType(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.
- setMimeType(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.
- setMimeTypeWhitelist(Set<String>) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
-
Set of MIME types that determine which types of resources are allowed to be uploaded.
- setName(String) - Method in class com.broadleafcommerce.asset.domain.Folder
-
The user facing name of this folder.
- setName(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setNamedOperations(List<NamedOperation>) - Method in class com.broadleafcommerce.asset.service.image.DoNothingImageOperationService
- setNamedOperations(List<NamedOperation>) - Method in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- setNamedOperations(List<NamedOperation>) - Method in interface com.broadleafcommerce.asset.service.image.ImageOperationService
-
Set the
List
ofNamedOperation
- setOriginalLocation(String) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
The original location that a caller gave to the
StorageProvider
to associate with the binary data. - setOriginalLocation(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- setParentFolderContextId(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setParentFolderId(String) - Method in class com.broadleafcommerce.asset.domain.Folder
- setPath(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration.InitialDataProperties.DataImportFile
- setPathPrefixInBucket(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- setPrependContentResolverEndpointPath(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
If "contentProviderUrlPrefix" is not blank, then this property determines whether to also prepend the "contentResolverEndpointPath" to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- setPrependRequestContextPath(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Determines whether to prepend the request context path to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- setPrependServletContextPath(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
If "contentProviderUrlPrefix" is not blank, then this property determines whether to also prepend the servlet's context path (e.g., "/asset") to the asset's URL (Asset#url) when the API is generating the "contentUrl" field for internal assets (DefaultAssetStorageType#INTERNAL).
- setProjectId(String) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- setRepository(AssetRepository<D>) - Method in class com.broadleafcommerce.asset.provider.jpa.repository.JpaCustomizedAssetRepository
- setResource(Resource) - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
-
The resource descriptor.
- setResourceNamesToIgnore(Set<String>) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
Set of resource names to ignore when uploading.
- setSize(long) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Size in bytes of the file represented by this asset.
- setSize(long) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Size in bytes of the file represented by this asset.
- setSizeWithUnits(String) - Method in class com.broadleafcommerce.asset.domain.Asset
- setStatus(FileUploadStatuses) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The status of the uploading
- setStatus(FileUploadStatuses) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setStorageLocationMapping(AssetCacheProperties.StorageLocationMappingCacheProperties) - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- setStorageLocationMappingSvc(StorageLocationMappingService<StorageLocationMapping>) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- setStorageLocationMappingSvc(StorageLocationMappingService<StorageLocationMapping>) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- setStorageProvider(InternalAssetProperties.StorageProvider) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- setStorageProviderLocation(String) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
The actual location within the
StorageProvider
backing datastore that holds the binary data of the file. - setStorageProviderLocation(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- setStorageProviderType(String) - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
-
Each
StorageProvider
implementation should correspond to a different type value here. - setStorageProviderType(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- setStorageType(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Defines where the digital content represented by this asset is stored.
- setStorageType(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Defines where the digital content represented by this asset is stored.
- setStoreZipFileOnProvider(boolean) - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
-
In multi-upload requests, the zip file's contents are always extracted and stored on the provider.
- setTag(String) - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
-
The tag with which to perform the action
- setTag(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
-
The actual tag value.
- setTag(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- setTags(LinkedHashSet<String>) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Descriptive or identifying labels.
- setTags(List<JpaAssetTag>) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Descriptive or identifying labels.
- setTemporaryDirectoryFilesWereExtractedTo(File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- setTitle(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Text that corresponds to the HTML
title
attribute that should be used when this asset is rendered in a browser. - setTitle(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Text that corresponds to the HTML
title
attribute that should be used when this asset is rendered in a browser. - setTracking(ApplicationJpaTracking) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- setTracking(ApplicationJpaTracking) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setTracking(ApplicationJpaTracking) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- setType(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Describes the general type of the asset.
- setType(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Describes the general type of the asset.
- setTypeFactory(TypeFactory) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- setTypeFactory(TypeFactory) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- setUnsuccessfulUploadFileNames(Set<String>) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The
Set
of the file names that weren't successfully uploaded - setUnsuccessfulUploadFileNames(Set<String>) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setUploadDate(Instant) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Date the file was uploaded to create this asset.
- setUploadDate(Instant) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Date the file was uploaded to create this asset.
- setUploadedAsset(List<Asset>) - Method in class com.broadleafcommerce.asset.domain.FileUploadState
-
The
List
of the uploadedAsset
- setUploadedAssetContextIds(List<String>) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- setUploadStatus(FileUploadState, BulkAddResourcesResponse) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- setUrl(String) - Method in class com.broadleafcommerce.asset.domain.Asset
-
Location used to resolve this asset by callers using the service such as "/icon.png" for an
internal asset
or "https://www.youtube.com/watch?v=a1S2d3F4" forexternal asset
. - setUrl(String) - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- setUrl(String) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
-
Location used to resolve this asset by callers using the service such as "/icon.png" for an
internal asset
or "https://www.youtube.com/watch?v=a1S2d3F4" forexternal asset
. - setValue(Object) - Method in class com.broadleafcommerce.asset.domain.Attribute
-
The value represented by this attribute.
- setValue(Object) - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- start() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- STARTS_WITH - Enum constant in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
The asset will match if the query param's value is contained by its field's value.
- stop() - Method in class com.broadleafcommerce.asset.autoconfigure.InitialDataAutoConfiguration
- StorageException - Exception in com.broadleafcommerce.asset.service
-
Exception that occurs when a checked error is encountered while attempting to store or remove a file from the filesystem.
- StorageException(String) - Constructor for exception com.broadleafcommerce.asset.service.StorageException
- StorageException(String, Throwable) - Constructor for exception com.broadleafcommerce.asset.service.StorageException
- StorageLocationMapping - Class in com.broadleafcommerce.asset.domain
-
Certain
StorageProvider
implementations may store data at a different location than the original path/'URL' provided to them. - StorageLocationMapping() - Constructor for class com.broadleafcommerce.asset.domain.StorageLocationMapping
- StorageLocationMappingCacheKeyGen() - Constructor for class com.broadleafcommerce.asset.service.DefaultStorageLocationMappingService.StorageLocationMappingCacheKeyGen
- StorageLocationMappingCacheProperties() - Constructor for class com.broadleafcommerce.asset.cache.AssetCacheProperties.StorageLocationMappingCacheProperties
- StorageLocationMappingRepository<D extends com.broadleafcommerce.data.tracking.core.Identifiable> - Interface in com.broadleafcommerce.asset.repository
-
Repository
allowing management and retrieval of persistent counterparts ofStorageLocationMapping
. - StorageLocationMappingService<P extends StorageLocationMapping> - Interface in com.broadleafcommerce.asset.service
-
CRUD Service API for
StorageLocationMapping
. - storageProvider - Variable in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- storageProvider - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- storageProvider - Variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- StorageProvider - Interface in com.broadleafcommerce.asset.storage.provider.service
-
This interface exposes methods required for interacting with a asset storage provider, that is, to store, retrieve, and delete digital content.
- StorageProvider() - Constructor for class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
- StorageProviderImplementationTypes - Interface in com.broadleafcommerce.asset.storage.provider.service
-
The storage provider implementation types.
- storageService - Variable in class com.broadleafcommerce.asset.messaging.ProcessAssetsListener
- storageService - Variable in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- StorageService - Interface in com.broadleafcommerce.asset.service
-
This interface exposes methods required to perform basic tasks involving processing of uploaded files.
- StorageUtils - Class in com.broadleafcommerce.asset.service.support
-
Deprecated, for removal: This API element is subject to removal in a future version.This logic was moved to an extensible bean:
AssetStorageUtils
. - storeFile(String, InputStream, String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- storeMultipartFile(String, MultipartFile, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated, for removal: This API element is subject to removal in a future version.
- storeMultipartFileResource(String, MultipartFile, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- storeResource(String, InputStream, String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- stripEndpointPrefix(HttpServletRequest) - Method in class com.broadleafcommerce.asset.web.endpoint.ContentResolverEndpoint
- SUCCESSFUL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Indicates that the upload was successful
- supports(Class<?>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- supports(Class<?>, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
T
- tagValuesToTagEntities() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- TEMP_FILE_PREFIX - Static variable in class com.broadleafcommerce.asset.service.image.ImageMagickImageOperationService
- TEXT - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- toBlobId(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- toMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- toMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- toMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- toMe() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.ImageProperties
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.BrowserCacheProperties
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.Filesystem
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider.GoogleCloudStorage
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties.StorageProvider
- toString() - Method in class com.broadleafcommerce.asset.autoconfigure.InternalAssetProperties
- toString() - Method in class com.broadleafcommerce.asset.cache.AssetCacheProperties
- toString() - Method in class com.broadleafcommerce.asset.domain.Asset
- toString() - Method in class com.broadleafcommerce.asset.domain.Attribute
- toString() - Method in class com.broadleafcommerce.asset.domain.BulkTagRequest
- toString() - Method in class com.broadleafcommerce.asset.domain.FileUploadState
- toString() - Method in class com.broadleafcommerce.asset.domain.Folder
- toString() - Method in class com.broadleafcommerce.asset.domain.StorageLocationMapping
- toString() - Method in class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule.AssetWithContentUrl
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.environment.JpaAssetProperties
- toString() - Method in class com.broadleafcommerce.asset.provider.jpa.repository.support.LinkedRSQLQueryDetails
- toString() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
- toString() - Method in class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
- toString() - Method in class com.broadleafcommerce.asset.storage.provider.service.BulkAddResourcesResponse
- toString() - Method in class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata
- toString() - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint.AssetUpdate
- toString() - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint.FolderUpdate
- triggeredJobEventInputProcessAssets() - Method in interface com.broadleafcommerce.asset.messaging.AssetTriggeredJobEventConsumer
- typeFactory - Variable in class com.broadleafcommerce.asset.service.DefaultStorageService
U
- UNKNOWN - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
- UNSUCCESSFUL - Enum constant in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Indicates that upload was unsuccessful
- unzipAndUploadResourcesAsync(File, String, Asset, ContextInfo, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Deprecated.
- unzipAndUploadResourcesAsync(File, String, Asset, ContextInfo, boolean) - Method in interface com.broadleafcommerce.asset.service.StorageService
- unzipAndUploadResourcesAsync(File, String, Asset, ContextInfo, boolean, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- unzipAndUploadResourcesAsync(File, String, Asset, ContextInfo, boolean, boolean) - Method in interface com.broadleafcommerce.asset.service.StorageService
- update(ContextInfo, String, FolderEndpoint.FolderUpdate) - Method in class com.broadleafcommerce.asset.web.endpoint.FolderEndpoint
- update(HttpServletRequest, ContextInfo, String, AssetEndpoint.AssetUpdate) - Method in class com.broadleafcommerce.asset.web.endpoint.AssetEndpoint
- update(String, P, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultAssetService
-
Overridden so as to ensure instance fields are correctly initialized.
- uploadFile(HttpServletRequest, ContextInfo, Asset, MultipartFile, Boolean) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- uploadMultiFile(HttpServletRequest, ContextInfo, MultipartFile, Asset, Boolean) - Method in class com.broadleafcommerce.asset.web.endpoint.FileUploadEndpoint
- uploadResource(MultipartFile, Asset, ContextInfo, boolean) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- uploadResource(MultipartFile, Asset, ContextInfo, boolean) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
Uploads a single file, creating an
Asset
for it (optionally using details specified inassetRequest
if present). - uploadResourcesExecutor() - Method in class com.broadleafcommerce.asset.autoconfigure.AsyncConfiguration
V
- validate(Object, Errors, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validate(Object, Errors, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
- validateAndCleanFilePath(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.FilesystemStorageProvider
- validateAndCleanFilePath(String) - Method in class com.broadleafcommerce.asset.storage.provider.service.GoogleCloudStorageProvider
- validateEntriesInZip(File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Reads and validates all of the non-directory (and non-ignored) entries in the given zip file.
- validateEntry(ZipEntry, ZipInputStream) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Reads the entry and validates its mime type and size are acceptable.
- validateEntryName(String) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Validates that the filename of the Zip entry does not contain any path traversals.
- validateFileAndCreateUrl(MultipartFile, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Validates the uploaded file and creates a URL for it.
- validateFileAndCreateUrl(MultipartFile, String, ContextInfo) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Validates the uploaded file and creates a URL for it.
- validateFolderId(Asset, Errors, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateIndividualAssetSize(long) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- validateLastUpdatedDate(Asset, Errors) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateLastUpdatedDate(Folder, Errors) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
- validateMimeType(Errors) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateName(Errors) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
- validateParentFolderId(Folder, Errors, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.FolderValidator
- validateStorageType(Errors) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateStorageTypeDependentFields(Asset, Errors) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateType(Asset, Errors) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateUrlAndEmbedCode(Asset, Errors, ContextInfo) - Method in class com.broadleafcommerce.asset.service.validation.AssetValidator
- validateZipAndReturnErrorMessage(File) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
-
Validates that the given file does not exceed the
InternalAssetProperties.getMaxZipFileSize()
, and validates the individual files inside as described inDefaultStorageService.validateEntriesInZip(File)
. - validateZipFileSize(long) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- validateZipResource(MultipartFile) - Method in class com.broadleafcommerce.asset.service.DefaultStorageService
- validateZipResource(MultipartFile) - Method in interface com.broadleafcommerce.asset.service.StorageService
-
A simple method intended to be used to pre-validate a
MultipartFile
received in an API request when expecting a zip file. - valueOf(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetStorageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.storage.provider.service.DefaultStorageProviderImplementationTypes
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorOption
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetStorageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.domain.type.FileUploadStatuses
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.storage.provider.service.DefaultStorageProviderImplementationTypes
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.web.filter.type.Operator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.broadleafcommerce.asset.web.filter.type.OperatorScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VIDEO - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
W
- WORD - Enum constant in enum class com.broadleafcommerce.asset.domain.type.DefaultAssetType
Z
- ZIP_FILENAME_PATH_TRAVERSAL - Static variable in class com.broadleafcommerce.asset.service.DefaultStorageService
- ZipEntryValidationError(String, String) - Constructor for class com.broadleafcommerce.asset.service.DefaultStorageService.ZipEntryValidationError
- ZipExtractionResult() - Constructor for class com.broadleafcommerce.asset.service.DefaultStorageService.ZipExtractionResult
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ContentResolverEndpoint.applyContentDisposition(ResourceWithMetadata, ResponseEntity.BodyBuilder, Asset)