public class DamEvent
extends java.lang.Object
DamEvent
represents events occurring upon assets within DAM. Such events are sent out from
implementations performing any of the specified event DamEvent.Type
s.Modifier and Type | Class and Description |
---|---|
static class |
DamEvent.Type
A list of events that are supported by assets.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EVENT_TOPIC
Event topic for DAM events.
|
static java.lang.String |
PROPERTY_ADDITIONAL_INFO |
static java.lang.String |
PROPERTY_CREATEDBY |
static java.lang.String |
PROPERTY_EXPIRATIONDATE |
static java.lang.String |
PROPERTY_LICENSE_INFO |
static java.lang.String |
PROPERTY_VERSION_ID |
Modifier and Type | Method and Description |
---|---|
static DamEvent |
accepted(java.lang.String assetPath,
java.lang.String userId,
java.lang.String licenseInfo)
Creates a
DamEvent that corresponds to the event of the license of a DRM-protected asset having been
accepted. |
static DamEvent |
addedComment(java.lang.String assetPath,
java.lang.String userId,
java.lang.String additionalInfo)
Creates a
DamEvent that corresponds to the event of addidng a
commment to an asset. |
static DamEvent |
assetCreated(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset having been created. |
static DamEvent |
assetExpired(java.lang.String assetPath,
java.lang.String userId,
java.util.Date expirationDate,
java.lang.String createdBy)
Creates a
DamEvent that corresponds to the event of an asset after expiration. |
static DamEvent |
assetExpiring(java.lang.String assetPath,
java.lang.String userId,
java.util.Date expirationDate,
java.lang.String createdBy)
Creates a
DamEvent that corresponds to the event of an asset getting expired in future. |
static DamEvent |
assetMoved(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset having been ,pved. |
static DamEvent |
assetPublished(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset
being published. |
static DamEvent |
assetRemoved(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset having been removed. |
static DamEvent |
assetShared(java.lang.String assetPath,
java.lang.String userId,
java.lang.String additionalInfo)
Creates a
DamEvent that corresponds to the event of an asset
being shared on different cloud solutions. |
static DamEvent |
assetUsage(java.lang.String assetPath,
java.lang.String usageType,
java.util.Date date)
Creates a
DamEvent that corresponds to the event that asset is
used in some solution. |
static DamEvent |
assetViewed(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event upon visiting an
asset's detail page. |
static DamEvent |
collectionViewed(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of a collection
being viewed. |
static DamEvent |
damMetadataWritebackWorkflowCompleted(java.lang.String assetPath)
Creates a
DamEvent that corresponds to the event that DAM metadata
writeback workflow is completed. |
static DamEvent |
damUpdateAssetWorkflowCompleted(java.lang.String assetPath)
Creates a
DamEvent that corresponds to the event that DAM update
asset workflow is completed. |
static DamEvent |
downloaded(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset having been downloaded. |
static DamEvent |
downloaded(java.lang.String assetPath,
java.lang.String userId,
java.lang.String additionalInfo)
Creates a
DamEvent that corresponds to the event of an asset having been downloaded. |
static DamEvent |
fromEvent(Event event)
|
java.lang.String |
getAdditionalInfo()
Any additional information provided for certain event types.
|
java.lang.String |
getAssetPath()
The path of the asset the event occurred upon.
|
java.lang.String |
getCreatedBy()
Creator of the asset.
|
java.util.Date |
getDate()
The date the event occurred on.
|
java.util.Date |
getExpirationDate()
Expiration date for the ASSET_EXPIRED event.
|
java.lang.String |
getLicenseInfo()
Information about the license upon which the user accepted or rejected.
|
DamEvent.Type |
getType()
The
DamEvent.Type of event that occurred on the asset. |
java.lang.String |
getUserId()
The id of the user generating the event.
|
java.lang.String |
getVersionId()
The ID of the version that was created upon the asset versioning event.
|
boolean |
isPublishedExternally()
Indicates whether this event represents an asset having been uploaded to an external system.
|
static DamEvent |
metadataUpdated(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset's metadata having been updated. |
static DamEvent |
metadataUpdated(java.lang.String assetPath,
java.lang.String userId,
java.lang.String additionalInfo)
Creates a
DamEvent that corresponds to the event of an asset's metadata having been updated. |
static DamEvent |
originalUpdated(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of an asset's original rendition having been updated. |
static DamEvent |
projectViewed(java.lang.String assetPath,
java.lang.String userId)
Creates a
DamEvent that corresponds to the event of a project
being viewed. |
static DamEvent |
publishedExternally(java.lang.String assetPath,
java.lang.String userId,
java.lang.String additionalInfo)
Creates a
DamEvent that corresponds to the event of an asset having been uploaded to an external system. |
static DamEvent |
rejected(java.lang.String assetPath,
java.lang.String userId,
java.lang.String licenseInfo)
Creates a
DamEvent that corresponds to the event of the license of a DRM-protected asset having been
rejected. |
static DamEvent |
renditionDownloaded(java.lang.String assetPath,
java.lang.String userId,
java.lang.String renditionPath)
Creates a
DamEvent that corresponds to the event of a rendition having been downloaded for an
asset. |
static DamEvent |
renditionRemoved(java.lang.String assetPath,
java.lang.String userId,
java.lang.String renditionPath)
Creates a
DamEvent that corresponds to the event of a rendition having been removed for an asset. |
static DamEvent |
renditionUpdated(java.lang.String assetPath,
java.lang.String userId,
java.lang.String renditionPath)
Creates a
DamEvent that corresponds to the event of a rendition having been added or updated for an
asset. |
static DamEvent |
restored(java.lang.String assetPath,
java.lang.String userId,
java.lang.String versionId)
Creates a
DamEvent that corresponds to the event of an asset having been restored from a previous
version. |
static DamEvent |
subassetRemoved(java.lang.String assetPath,
java.lang.String userId,
java.lang.String subassetPath)
Creates a
DamEvent that corresponds to the event of a sub-asset having been removed for an asset. |
static DamEvent |
subassetUpdated(java.lang.String assetPath,
java.lang.String userId,
java.lang.String subassetPath)
Creates a
DamEvent that corresponds to the event of a sub-asset having been added or updated for an
asset. |
Event |
toEvent()
Create a distributable event.
|
Event |
toNonDistributableEvent()
Create a non distributable event.
|
static DamEvent |
versioned(java.lang.String assetPath,
java.lang.String userId,
java.lang.String versionId)
Creates a
DamEvent that corresponds to the event of an asset having been versioned. |
public static final java.lang.String EVENT_TOPIC
public static final java.lang.String PROPERTY_EXPIRATIONDATE
public static final java.lang.String PROPERTY_CREATEDBY
public static final java.lang.String PROPERTY_VERSION_ID
public static final java.lang.String PROPERTY_LICENSE_INFO
public static final java.lang.String PROPERTY_ADDITIONAL_INFO
public java.lang.String getAssetPath()
String
representing the asset, folder or collection path.public java.util.Date getDate()
Date
representing the date/time the event occurred on.public java.lang.String getLicenseInfo()
String
representing the license information, or null
if n/a.public java.lang.String getVersionId()
String
representing the version ID, or null
if n/a.public java.lang.String getUserId()
String
representing the user id.public DamEvent.Type getType()
DamEvent.Type
of event that occurred on the asset.DamEvent.Type
public java.lang.String getAdditionalInfo()
String
representing the additional information, or null
if n/a.public java.util.Date getExpirationDate()
Date
representing the expiration date, or null
if n/a.public java.lang.String getCreatedBy()
String
representing the creator of asset, or null
if n/a.public boolean isPublishedExternally()
true
if the event type is DamEvent.Type.PUBLISHED_EXTERNAL
.public Event toEvent()
public Event toNonDistributableEvent()
public static DamEvent accepted(java.lang.String assetPath, java.lang.String userId, java.lang.String licenseInfo)
DamEvent
that corresponds to the event of the license of a DRM-protected asset having been
accepted.assetPath
- The path of the asset for which the license has been accepted.userId
- The id of the user that accepted the license.licenseInfo
- Information about the license, such as its path or URL.DamEvent
DamEvent.Type.ACCEPTED
public static DamEvent rejected(java.lang.String assetPath, java.lang.String userId, java.lang.String licenseInfo)
DamEvent
that corresponds to the event of the license of a DRM-protected asset having been
rejected.assetPath
- The path of the asset for which the license has been rejected.userId
- The id of the user that rejected the license.licenseInfo
- Information about the license, such as its path or URL.DamEvent
DamEvent.Type.REJECTED
public static DamEvent downloaded(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset having been downloaded. In case of a
DRM-protected asset, this event can only follow a accepted(String, String, String)
event.assetPath
- The path of the asset that was downloaded.userId
- The id of the user that downloaded the asset.DamEvent
DamEvent.Type.DOWNLOADED
public static DamEvent downloaded(java.lang.String assetPath, java.lang.String userId, java.lang.String additionalInfo)
DamEvent
that corresponds to the event of an asset having been downloaded. In case of a
DRM-protected asset, this event can only follow a accepted(String, String, String)
event.assetPath
- The path of the asset that was downloaded.userId
- The id of the user that downloaded the asset.additionalInfo
- Name of the source workflow of the downloaded asset, empty value means normal download.DamEvent
DamEvent.Type.DOWNLOADED
public static DamEvent versioned(java.lang.String assetPath, java.lang.String userId, java.lang.String versionId)
DamEvent
that corresponds to the event of an asset having been versioned.assetPath
- The path of the asset that was versioned.userId
- The id of the user that versioned the asset.versionId
- The id of the version that was created.DamEvent
DamEvent.Type.VERSIONED
,
Asset.createRevision(String, String)
public static DamEvent restored(java.lang.String assetPath, java.lang.String userId, java.lang.String versionId)
DamEvent
that corresponds to the event of an asset having been restored from a previous
version.assetPath
- The path of the asset that was restored.userId
- The id of the user that restored the asset.versionId
- The id of the version from which the asset was restored.DamEvent
DamEvent.Type.RESTORED
,
AssetManager.restore(String)
public static DamEvent metadataUpdated(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset's metadata having been updated.assetPath
- The path of the asset the metadata of which was updated.userId
- The id of the user that updated the metadata.DamEvent
DamEvent.Type.METADATA_UPDATED
public static DamEvent metadataUpdated(java.lang.String assetPath, java.lang.String userId, java.lang.String additionalInfo)
DamEvent
that corresponds to the event of an asset's metadata having been updated.assetPath
- The path of the asset the metadata of which was updated.userId
- The id of the user that updated the metadata.additionalInfo
- metadata info passed as "property1=value1,property2=value2..."DamEvent
DamEvent.Type.METADATA_UPDATED
public static DamEvent publishedExternally(java.lang.String assetPath, java.lang.String userId, java.lang.String additionalInfo)
DamEvent
that corresponds to the event of an asset having been uploaded to an external system.assetPath
- The path of the asset that was uploaded.userId
- The id of the user that uploaded the asset.additionalInfo
- Information about the external system to which the asset was uploaded, such as a URL.DamEvent
DamEvent.Type.PUBLISHED_EXTERNAL
public static DamEvent originalUpdated(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset's original rendition having been updated.assetPath
- The path of the asset the original of which was updated.userId
- The id of the user that updated the asset's original.DamEvent
DamEvent.Type.ORIGINAL_UPDATED
,
Asset.addRendition(String, java.io.InputStream, String)
public static DamEvent renditionUpdated(java.lang.String assetPath, java.lang.String userId, java.lang.String renditionPath)
DamEvent
that corresponds to the event of a rendition having been added or updated for an
asset.assetPath
- The path of the asset for which a rendition was added or updated.userId
- The id of the user that added/updated the rendition.renditionPath
- The path of the rendition that was added/updated.DamEvent
DamEvent.Type.RENDITION_UPDATED
,
Asset.addRendition(String, java.io.InputStream, String)
public static DamEvent renditionRemoved(java.lang.String assetPath, java.lang.String userId, java.lang.String renditionPath)
DamEvent
that corresponds to the event of a rendition having been removed for an asset.assetPath
- The path of the asset for which a rendition was removed.userId
- The id of the user that removed the rendition.renditionPath
- The path of the rendition that was removed.DamEvent
DamEvent.Type.RENDITION_REMOVED
,
Asset.removeRendition(String)
public static DamEvent renditionDownloaded(java.lang.String assetPath, java.lang.String userId, java.lang.String renditionPath)
DamEvent
that corresponds to the event of a rendition having been downloaded for an
asset.assetPath
- The path of the asset for which a rendition was downloaded.userId
- The id of the user that downloaded the rendition.renditionPath
- The path of the rendition that was downloaded.DamEvent
DamEvent.Type.RENDITION_DOWNLOADED
public static DamEvent subassetUpdated(java.lang.String assetPath, java.lang.String userId, java.lang.String subassetPath)
DamEvent
that corresponds to the event of a sub-asset having been added or updated for an
asset.assetPath
- The path of the asset for which a sub-asset was added or updated.userId
- The id of the user that added/updated the sub-asset.subassetPath
- The path of the sub-asset that was added/updated.DamEvent
DamEvent.Type.SUBASSET_UPDATED
,
Asset.addSubAsset(String, String, java.io.InputStream)
public static DamEvent subassetRemoved(java.lang.String assetPath, java.lang.String userId, java.lang.String subassetPath)
DamEvent
that corresponds to the event of a sub-asset having been removed for an asset.assetPath
- The path of the asset for which a sub-asset was removed.userId
- The id of the user that removed the sub-asset.subassetPath
- The path of the sub-asset that was removed.DamEvent
DamEvent.Type.SUBASSET_REMOVED
public static DamEvent assetCreated(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset having been created.assetPath
- The path of the asset that was just created.userId
- The id of the user that created the asset.DamEvent
DamEvent.Type.ASSET_CREATED
,
AssetManager.createAsset(String, java.io.InputStream, String, boolean)
public static DamEvent assetMoved(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset having been ,pved.assetPath
- The path of the asset that was just moved.userId
- The id of the user that moved the asset.DamEvent
DamEvent.Type.ASSET_MOVED
public static DamEvent assetRemoved(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset having been removed.assetPath
- The path of the asset that was just removed.userId
- The id of the user that removed the asset.DamEvent
DamEvent.Type.ASSET_REMOVED
public static DamEvent assetExpired(java.lang.String assetPath, java.lang.String userId, java.util.Date expirationDate, java.lang.String createdBy)
DamEvent
that corresponds to the event of an asset after expiration.
By default expiration date property that is considered is jcr:content/offTimeassetPath
- The path of the asset that was expired.expirationDate
- The expiration date of the asset.createdBy
- Creator of the assetuserId
- The id of the user that expired the asset.DamEvent
DamEvent.Type.ASSET_EXPIRING
public static DamEvent assetExpiring(java.lang.String assetPath, java.lang.String userId, java.util.Date expirationDate, java.lang.String createdBy)
DamEvent
that corresponds to the event of an asset getting expired in future.
By default expiration date property that is considered is jcr:content/offTimeassetPath
- The path of the asset that is getting expired.expirationDate
- The expiration date of the asset.createdBy
- Creator of the assetuserId
- The id of the user that expired the asset.DamEvent
DamEvent.Type.ASSET_EXPIRED
public static DamEvent assetViewed(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event upon visiting an
asset's detail page.assetPath
- The path of the asset whose details were accessed.userId
- The id of the user that accessed the asset details page.DamEvent
DamEvent.Type.ASSET_VIEWED
public static DamEvent assetShared(java.lang.String assetPath, java.lang.String userId, java.lang.String additionalInfo)
DamEvent
that corresponds to the event of an asset
being shared on different cloud solutions.assetPath
- The path of the asset that was shared.userId
- The id of the user who shared the asset.additionalInfo
- Place where this asset was shared.DamEvent
DamEvent.Type.ASSET_SHARED
public static DamEvent assetPublished(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of an asset
being published.assetPath
- The path of the asset that was published.userId
- The id of the user that updated the metadata.DamEvent
DamEvent.Type.ASSET_PUBLISHED
public static DamEvent projectViewed(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of a project
being viewed.assetPath
- The path of the project that was viewed.userId
- The id of the user who viewed the project.DamEvent
DamEvent.Type.PROJECT_VIEWED
public static DamEvent collectionViewed(java.lang.String assetPath, java.lang.String userId)
DamEvent
that corresponds to the event of a collection
being viewed.assetPath
- The path of the collection that was viewed.userId
- The id of the user who viewed the collection.DamEvent
DamEvent.Type.COLLECTION_VIEWED
public static DamEvent addedComment(java.lang.String assetPath, java.lang.String userId, java.lang.String additionalInfo)
DamEvent
that corresponds to the event of addidng a
commment to an asset.assetPath
- The path of the asset which was commented upon.userId
- The id of the user who commented on the asset.additionalInfo
- Message of added comment.DamEvent
DamEvent.Type.ADDED_COMMENT
public static DamEvent assetUsage(java.lang.String assetPath, java.lang.String usageType, java.util.Date date)
DamEvent
that corresponds to the event that asset is
used in some solution.assetPath
- The path of the asset which was used.usageType
- defines the type of usage, whether asset is used in
collection or some third party solution like Campaign, Social.date
- The time when asset was used.DamEvent
DamEvent.Type.ASSET_USAGE
public static DamEvent damUpdateAssetWorkflowCompleted(java.lang.String assetPath)
DamEvent
that corresponds to the event that DAM update
asset workflow is completed.assetPath
- The path of the asset on which the DAM update asset workflow
executed.DamEvent
DamEvent.Type.DAM_UPDATE_ASSET_WORKFLOW_COMPLETED
public static DamEvent damMetadataWritebackWorkflowCompleted(java.lang.String assetPath)
DamEvent
that corresponds to the event that DAM metadata
writeback workflow is completed.assetPath
- The path of the asset on which the DAM metadata writeback
workflow executed.DamEvent
DamEvent.Type.DAM_METADATA_WRITEBACK_WORKFLOW_COMPLETED
Copyright © 2010 - 2020 Adobe. All Rights Reserved