Serialized Form

Package com.broadleafcommerce.asset.domain

Class com.broadleafcommerce.asset.domain.Asset

class Asset extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

altText

String altText

Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser. This is used as an alternative for screen-readers and as an SEO enhancement describing the asset.

attributes

Map<String,Object> attributes

Additional attributes of the asset.

author

String author

User who created this asset.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

embedCode

String embedCode

If and only if the Asset.type is DefaultAssetType.EMBED, this field holds the HTML to embed.

Note that Asset.url and this field can never both be present.

externalProvider

String externalProvider

For assets with an external Asset.storageType, this field is required and names where the external asset is sourced from. This field should be null for assets with an internal Asset.storageType.

folderId

String folderId

The context ID of the folder in which this asset is placed. A asset with a null folderId is not returned from folder content endpoints like /folder/{id}/assets.

id

String id

the context ID of this asset

lastUpdatedDate

Instant lastUpdatedDate

Date the file was last updated.

locale

Locale locale

Designate this asset to be used in a specific Locale.

mimeType

String mimeType

MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types for more info on MIME types

size

long size

Size in bytes of the file represented by this asset.

storageType

String storageType

Defines where the digital content represented by this asset is stored. The default types are DefaultAssetStorageType.INTERNAL and DefaultAssetStorageType.EXTERNAL.

See Also:

• DefaultAssetStorageType

tags

LinkedHashSet<String> tags

Descriptive or identifying labels.

Tags can be used to:

• provide a means of designating special purposes for the asset
• group otherwise related assets such as "banners"
• provide a label for some other, arbitrary purpose

title

String title

Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser. This is used a tooltip or caption.

type

String type

Describes the general type of the asset. This is used to determine how to render the asset on the frontend. For example, if the type is DefaultAssetType.IMAGE, then the frontend will know to render it in an <img/> tag.

For assets with an external Asset.storageType, this field is required input. For internal assets, this is inferred from the Asset.mimeType during upload.

See Also:

• DefaultAssetType

uploadDate

Instant uploadDate

Date the file was uploaded to create this asset.

url

String url

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" for external asset.

Note: In the case of internal asset, this field is not the full path. The rest of the path is constructed using the prefixes defined in InternalAssetProperties.

Note that Asset.embedCode and this field can never both be present.

See Also:

• InternalAssetProperties
• AssetContentUrlSerializerModule.AssetWithContentUrl

Class com.broadleafcommerce.asset.domain.Attribute

class Attribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

value

Object value

The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values: Map<String, Attribute>.

Class com.broadleafcommerce.asset.domain.BulkTagRequest

class BulkTagRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assetContextIds

Set<String> assetContextIds

The list of asset ids with which to add/remove the tag to/from

tag

String tag

The tag with which to perform the action

Class com.broadleafcommerce.asset.domain.FileUploadState

class FileUploadState extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

fileName

String fileName

The file name

id

String id

The context ID of the state.

status

FileUploadStatuses status

The status of the uploading

See Also:

• FileUploadState

unsuccessfulUploadFileNames

Set<String> unsuccessfulUploadFileNames

The Set of the file names that weren't successfully uploaded

uploadedAsset

List<Asset> uploadedAsset

The List of the uploaded Asset

Class com.broadleafcommerce.asset.domain.Folder

class Folder extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Attribute> attributes

Additional attributes of the folder.

author

String author

User who created this folder.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context ID of the folder.

lastUpdatedDate

Instant lastUpdatedDate

Date the folder was last updated.

name

String name

The user facing name of this folder.

parentFolderId

String parentFolderId

Class com.broadleafcommerce.asset.domain.StorageLocationMapping

class StorageLocationMapping extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

Unique identifier for this record.

originalLocation

String originalLocation

The original location that a caller gave to the StorageProvider to associate with the binary data. Typically, this is a 'URL' value obtained by prepending context-specific information to the Asset.getUrl(), as done in AssetStorageUtils.getContextAwareUrl(Asset, ContextInfo).

This is the value callers will give to the StorageProvider to store/read/delete the resource.

This is already expected to be globally unique, but for correctness, queries should be done against a combination of StorageLocationMapping.getOriginalLocation() and StorageLocationMapping.getStorageProviderType().

storageProviderLocation

String storageProviderLocation

The actual location within the StorageProvider backing datastore that holds the binary data of the file.

The contained value here may look different depending on the StorageProvider. For example, in the case of FilesystemStorageProvider, this will just be another file path. In other cases, it may be a cloud object identifier, or something else. Ultimately, it should be something that the StorageProvider can use to reliably resolve/manage the file.

storageProviderType

String storageProviderType

Each StorageProvider implementation should correspond to a different type value here. There is currently no support for any more than one active StorageProvider implementation at a time, but tracking which provider this mapping is for may be useful in the event of a migration (or auditing in general).

Package com.broadleafcommerce.asset.jackson

Class com.broadleafcommerce.asset.jackson.AssetContentUrlSerializerModule

class AssetContentUrlSerializerModule extends com.fasterxml.jackson.databind.module.SimpleModule implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.asset.jackson.ContentUrlSerializer

class ContentUrlSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<String> implements Serializable

Serialized Fields

contentUrlResolver

ContentUrlResolver contentUrlResolver

Package com.broadleafcommerce.asset.provider.jpa.domain

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaAsset

class JpaAsset extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

altText

String altText

Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser. This is used as an alternative for screen-readers and as an SEO enhancement describing the asset.

attributes

Map<String,String> attributes

author

String author

User who created this asset.

contextId

String contextId

embedCode

String embedCode

If and only if the JpaAsset.type is DefaultAssetType.EMBED, this field holds the HTML to embed.

Note that JpaAsset.url and this field can never both be present.

externalProvider

String externalProvider

For assets with an external JpaAsset.storageType, this field is required and names where the external asset is sourced from. This field should be null for assets with an internal JpaAsset.storageType.

See Also:

• Asset.externalProvider

folderContextId

String folderContextId

lastUpdatedDate

Instant lastUpdatedDate

Date the file was last updated.

locale

Locale locale

Designate this asset to be used in a specific Locale

mimeType

String mimeType

MIME storageType of the file represented by this asset: image/png, image/jpeg, application/pdf, &c.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types for more info on MIME types

size

long size

Size in bytes of the file represented by this asset.

storageType

String storageType

Defines where the digital content represented by this asset is stored. The default types are DefaultAssetStorageType.INTERNAL and DefaultAssetStorageType.EXTERNAL.

See Also:

• DefaultAssetStorageType

tags

List<JpaAssetTag> tags

Descriptive or identifying labels.

Tags can be used to:

• provide a means of designating special purposes for the asset
• group otherwise related assets such as "banners"
• provide a label for some other, arbitrary purpose

title

String title

Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser. This is used a tooltip or caption.

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

type

String type

Describes the general type of the asset. This is used to determine how to render the asset on the frontend. For example, if the type is DefaultAssetType.IMAGE, then the frontend will know to render it in an <img/> tag.

For assets with an external JpaAsset.storageType, this field is required input. For internal assets, this is inferred from the JpaAsset.mimeType during upload.

See Also:

• DefaultAssetType
• Asset.type

uploadDate

Instant uploadDate

Date the file was uploaded to create this asset.

url

String url

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" for external asset.

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTag

class JpaAssetTag extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

JpaAsset asset

The JpaAsset that this tag belongs to.

tag

String tag

The actual tag value.

See Also:

• Asset.tags
• JpaAsset.tags

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaAssetTagId

class JpaAssetTagId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

String asset

See Also:

• JpaAssetTag.asset

tag

String tag

See Also:

• JpaAssetTag.tag

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaAttribute

class JpaAttribute extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

value

Object value

See Also:

• Attribute.getValue()

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaFileUploadState

class JpaFileUploadState extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

fileName

String fileName

status

String status

This field is persisted as a String to enable flexibility in scenarios like RSQL filtration.

See Also:

• FileUploadState.status
• JpaFileUploadState.getStatus()
• JpaFileUploadState.setStatus(FileUploadStatuses)

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

unsuccessfulUploadFileNames

Set<String> unsuccessfulUploadFileNames

uploadedAssetContextIds

List<String> uploadedAssetContextIds

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaFolder

class JpaFolder extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,JpaAttribute> attributes

author

String author

contextId

String contextId

lastUpdatedDate

Instant lastUpdatedDate

name

String name

parentFolderContextId

String parentFolderContextId

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

Class com.broadleafcommerce.asset.provider.jpa.domain.JpaStorageLocationMapping

class JpaStorageLocationMapping extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

See Also:

• StorageLocationMapping.getId()

originalLocation

String originalLocation

See Also:

• StorageLocationMapping.getOriginalLocation()

storageProviderLocation

String storageProviderLocation

See Also:

• StorageLocationMapping.getStorageProviderLocation()

storageProviderType

String storageProviderType

See Also:

• StorageLocationMapping.getStorageProviderType()

Package com.broadleafcommerce.asset.service

Exception com.broadleafcommerce.asset.service.BulkStorageException

class BulkStorageException extends RuntimeException implements Serializable

Serialized Fields

givenFilenamesToErrors

Map<String,Throwable> givenFilenamesToErrors

Exception com.broadleafcommerce.asset.service.StorageException

class StorageException extends RuntimeException implements Serializable

Package com.broadleafcommerce.asset.service.image

Exception com.broadleafcommerce.asset.service.image.ImageOperationException

class ImageOperationException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.asset.service.image.ImageOptimizationException

class ImageOptimizationException extends RuntimeException implements Serializable

Package com.broadleafcommerce.asset.storage.provider.service

Class com.broadleafcommerce.asset.storage.provider.service.ResourceWithMetadata

class ResourceWithMetadata extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalMetadata

Map<String,Object> additionalMetadata

Any additional metadata for this resource.

contentDisposition

String contentDisposition

The Content-Disposition HTTP header value of the resource if known when reading it.

contentLength

long contentLength

The Content-Length HTTP header value indicating the size of the associated object in bytes.

contentType

String contentType

The content type of the resource if known when reading it.

filename

String filename

The file name. Typically, the last part of the path — for example, "myfile.txt".

resource

org.springframework.core.io.Resource resource

The resource descriptor.

Package com.broadleafcommerce.asset.web.endpoint.exception

Exception com.broadleafcommerce.asset.web.endpoint.exception.FileUploadBadRequestException

class FileUploadBadRequestException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.asset.web.endpoint.exception.ResourceResolutionException

class ResourceResolutionException extends RuntimeException implements Serializable