All files from Digizuite are served using the media pipelines. From DFS 9.0.0 the media pipeline has been redesigned, however, the old is still there for compatibility reasons.
It is configurable which one is used and this is controlled by a config parameter in DFS.Settings.config:
| Code Block | ||
|---|---|---|
| ||
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
<sitecore>
<settings>
<setting name="DFS.MediaPipeline" value="dfsmedia"/>
</settings>
</sitecore>
</configuration> |
There are two options
- dfsmedia - the new implementation
- media - the old implementation
The default value is dfsmedia.
This section describes the new dfsmedia pipeline and its capabilities.
Understanding the request
The new dfsmedia pipeline is accessible on the following endpoint: http(s)://<sitecore>/dfsmedia
...
The new dfsmedia pipeline is implemented as a httphandler, using a pipeline in Sitecore. This pipeline is located in the DFS.ServicesPipelines.config file:
| Code Block | ||
|---|---|---|
| ||
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"> <sitecore> <pipelines> <DFS.Services.DFSMedia> <processor type="DFS.Client.Services.Pipelines.DFSMedia.CheckSecuritySynchronizeAsset, DFS.Client.Services" /> role:require="Standalone or ContentManagement" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.GetMediaFromCacheLoadAssetEntity, DFS.Client.Services" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.GetMediaPrerequisitesGetMediaFromCache, DFS.Client.Services" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.GetMediaFromDigizuite, DFS.Client.Services" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.ResizeImage, DFS.Client.Services" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.SaveToCache, DFS.Client.Services" /> <processor type="DFS.Client.Services.Pipelines.DFSMedia.ResolveFilename, DFS.Client.Services" /> </DFS.Services.DFSMedia> </pipelines> </sitecore> </configuration> |
Each step is explained as follows:
| Pipeline name | Description | |
|---|---|---|
| DFS.Client.Services.Pipelines.DFSMedia. | CheckSecuritySynchronizeAsset | This is only running in role:require="Standalone or ContentManagement". Will sync the asset into the asset silo if it does not exist. |
| DFS.Client.Services.Pipelines.DFSMedia.LoadAssetEntity | This pipeline looks up the asset in the index using the context user. If the user does not have access, the asset is not returned and the pipeline is stopped. | |
| DFSDFS.Client.Services.Pipelines.DFSMedia.GetMediaFromCache | This pipelines constructs a unique name based on the request and checks if the requested asset exists in the cache. | |
| DFS.Client.Services.Pipelines.DFSMedia.GetMediaPrerequisites | If the asset is not cached, it needs to be requested from Digizuite. This pipeline gets all the prerequisites for requiring the asset in Digizuite | |
| DFS.Client.Services.Pipelines.DFSMedia.GetMediaFromDigizuite | This pipeline executes the request towards Digizuite | |
| DFS.Client.Services.Pipelines.DFSMedia.ResizeImage | If a resize or #compres?? is requested, the bytes are processed here | |
| DFS.Client.Services.Pipelines.DFSMedia.SaveToCache | This pipeline saves the asset to the cache | |
| DFS.Client.Services.Pipelines.DFSMedia.ResolveFilename | Set the donwload filename header, if a download is requested. |
This pipeline may be modified according to customer needs.
| Info | ||
|---|---|---|
| ||
Commenting out the security part of the pipeline increases performance of the cost of security, but for content delivery servers for public websites, this is typically not important and therefore it may be beneficial to comment out this step. |
Extending the pipeline
If the pipeline is to be extended, for instance if some custom processing needs to be done to the image, then this may be done in between any of the steps above.
...
| Parameter | type | Description |
|---|---|---|
| ResultPath | string | Path to the directory in which the asset is cached |
| FileName | string | Name of the cached asset |
| Cached | bool | Boolean to indicate whether the asset is cached |
| ResultStream | Task<Stream> | Handle for the result stream used to get the asset from Digizuite |
| ResizeBytes | byte[] | If the image is resized and/or compressed, this array contains the result bytes |
| DownloadUrl | string | Redirect URL for download requests |
| StopPipeline | bool | If the pipeline should be aborted, for instance due to security violation, then this is true |
| Asset | AssetIndexable | Asset model from the index |
| StatusCode | HttpStatusCode | Status code used to indicate the request status. |
Changing the URL
...
| . |
...
- Change setting: DFS.MediaPipeline to new prefix (e.g. company name) in config file DFS.Settings.config
- Change path in httphandler section in web.config (See DFS 11.0 - 3 Setting up Sitecore section 3.1) to be the new prefix
- Change trigger in customHandlers section in DFS.Services.config to be the new prefix
- Resynchronize the silo
...
Manually deleting cache entries
...