https://github.com/icfnext/akamai-purge-replication-event-handler
OSGi bundle for Adobe Experience Manager (AEM) providing a replication event handler and Akamai Fast Purge API client to purge content from Akamai when content is replicated.
https://github.com/icfnext/akamai-purge-replication-event-handler
Last synced: 9 months ago
JSON representation
OSGi bundle for Adobe Experience Manager (AEM) providing a replication event handler and Akamai Fast Purge API client to purge content from Akamai when content is replicated.
- Host: GitHub
- URL: https://github.com/icfnext/akamai-purge-replication-event-handler
- Owner: icfnext
- License: other
- Created: 2019-03-15T19:47:50.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2020-02-03T18:24:32.000Z (over 6 years ago)
- Last Synced: 2025-03-30T09:31:33.713Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 16.6 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Akamai Purge Replication Event Handler
[ICF Next](http://www.icfnext.com)
## Overview
The Akamai Purge Replication Event Handler is an OSGi bundle for the Adobe Experience Manager (AEM) platform that uses the [Akamai Fast Purge API](https://developer.akamai.com/api/core_features/fast_purge/v3.html) to purge content from Akamai when content is replicated.
The included event handler listens to replication events for a configurable set of content paths. When content is activated, deactivated, or deleted, the event handler creates a Sling job that sends a request using the Akamai Fast Purge API to invalidate or delete the externalized page/asset URL.
## Compatibility
Bundle Version | AEM Version(s)
------------ | -------------
0.x.x | 6.3, 6.4, 6.5
## Installation
1. Add the bundle as a dependency to an existing AEM project:
```xml
com.icfolson.aem.akamai
akamai-purge-replication-event-handler
0.0.1
provided
```
2. Add a [service user mapping](https://helpx.adobe.com/experience-manager/6-4/sites/administering/using/security-service-users.html#ServiceUsersandMappings) for the `akamai-purge-replication-event-handler` bundle.
3. Configure the Akamai services as outlined below.
## Configuration
### Akamai Purge Replication Event Handler Configuration
Enable/disable the Akamai replication event handler and configure which resource paths should be purged.
### Akamai Edge Grid Client Configuration
Configure the Akamai network, hostname, and credentials (access token, client token, client secret).
## Job Cancellation Event Handlers
If the Akamai purge request fails, the underlying Sling job will be cancelled and an event will be generated containing the job topic and affected page/asset path.
Applications using this bundle may register services implementing the `com.icfolson.aem.akamai.purge.job.delegate.AkamaiPurgeJobCancelledEventHandlerDelegate` interface to provide additional error/failure handling behavior (e.g. email notification). These services will be automatically bound to the default
Akamai purge job cancellation event handler by the framework.
## Versioning
Follows [Semantic Versioning](http://semver.org/) guidelines.