+
+
++ * Helps reducing maintenance by automatically flushing the ACS commons memory cache by implementing ResourceChangeListener. + *
+ */ +@Component( + configurationPolicy = ConfigurationPolicy.OPTIONAL, + immediate = true, + property = { + ResourceChangeListener.PATHS + "=/apps/acs-samples/components/structure/page/layout", + ResourceChangeListener.PATHS + "=/content/acs-samples", + ResourceChangeListener.CHANGES + "=ADDED", + ResourceChangeListener.CHANGES + "=CHANGED", + ResourceChangeListener.CHANGES + "=REMOVED", + } +) +// @formatter:on +public class AutomatedLayoutPageInvalidator implements ResourceChangeListener { + + private static final Logger LOG = LoggerFactory.getLogger(AutomatedLayoutPageInvalidator.class); + private static final String PATH_SUFFIX = "/" + JcrConstants.JCR_CONTENT + ".content.html"; + + private static final Pattern PATTERN = Pattern.compile("((/content/acs-samples/(headers|footers)/[a-zA-Z0-9_-]{1,99}))(.*)/(.*)"); + + @Reference + private HttpCacheEngine engine; + + @Override + public void onChange(List+ * This extension on the HTTP cache allows for specific cookie combinations to create seperated cache entries. + * This so we can present a different header based on cookie values, which tell us if a user is logged in and what type of user it is. + *
+ */ +@Component(configurationPolicy = ConfigurationPolicy.REQUIRE , service = {HttpCacheConfigExtension.class, CacheKeyFactory.class}) +@Designate(ocd = CookieCacheExtensionConfig.class, factory = true) +public class CookieCacheExtension implements HttpCacheConfigExtension, CacheKeyFactory { + private static final Logger log = LoggerFactory.getLogger(CookieCacheExtension.class); + + private boolean emptyAllowed; + private String configName; + private Set+ * Simple cache extension to only create keys based on the resource path. + *
+ */ +@Component(configurationPolicy = ConfigurationPolicy.REQUIRE , service = {HttpCacheConfigExtension.class, CacheKeyFactory.class}) +@Designate(ocd = ResourcePathCacheExtensionConfig.class, factory = true) +public class ResourcePathCacheExtension implements HttpCacheConfigExtension, CacheKeyFactory { + + private List+ * Configuration OCD object for the CookiecCacheExtension + *
+ */ +@ObjectClassDefinition( + name = "CookieCacheExtensionConfig - Configuration OCD object for the CookiecCacheExtension", + description = "Extension for the ACS commons HTTP Cache. Leverages cookies." +) +public @interface CookieCacheExtensionConfig { + + @AttributeDefinition( + name = "Configuration Name", + description = "The unique identifier of this extension" + ) + String configName() default ""; + + @AttributeDefinition( + name = "Allowed Cookies", + description = "Cookie keys that will used to generate a cache key." + ) + String[] allowedCookieKeys() default {}; + + @AttributeDefinition( + name = "Empty is allowed", + description = "Cookie keys that will used to generate a cache key." + ) + boolean emptyAllowed() default false; + +} \ No newline at end of file diff --git a/bundle/src/main/java/com/adobe/acs/samples/httpcache/definitions/ResourcePathCacheExtensionConfig.java b/bundle/src/main/java/com/adobe/acs/samples/httpcache/definitions/ResourcePathCacheExtensionConfig.java new file mode 100644 index 0000000..5b28964 --- /dev/null +++ b/bundle/src/main/java/com/adobe/acs/samples/httpcache/definitions/ResourcePathCacheExtensionConfig.java @@ -0,0 +1,41 @@ +package com.adobe.acs.samples.httpcache.definitions; + +import org.osgi.service.metatype.annotations.AttributeDefinition; +import org.osgi.service.metatype.annotations.ObjectClassDefinition; + +/** + * ResourcePathCacheExtensionConfig + *+ * Configuration OCD object for the ResourcePathCacheExtension + *
+ */ +@ObjectClassDefinition( + name = "ResourcePathCacheExtensionConfig - Configuration OCD object for the ResourcePathCacheExtension", + description = "Extension for the ACS commons HTTP Cache. Based on resource paths, selectors and extensions." +) +public @interface ResourcePathCacheExtensionConfig { + + @AttributeDefinition( + name = "Configuration Name", + description = "The unique identifier of this extension" + ) + String configName() default ""; + + @AttributeDefinition( + name = "Resource path patterns", + description = "List of resource path patterns (regex) that will be valid for caching" + ) + String[] resourcePathPatterns(); + + @AttributeDefinition( + name = "Selector patterns", + description = "List of selector patterns (regex) that will be valid for caching" + ) + String[] selectors(); + + @AttributeDefinition( + name = "Extension patterns", + description = "List of extension patterns (regex) that will be valid for caching" + ) + String[] extensions(); +} \ No newline at end of file diff --git a/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieCacheKey.java b/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieCacheKey.java new file mode 100644 index 0000000..1df81e5 --- /dev/null +++ b/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieCacheKey.java @@ -0,0 +1,69 @@ +package com.adobe.acs.samples.httpcache.key; + +import com.adobe.acs.commons.httpcache.config.HttpCacheConfig; +import com.adobe.acs.commons.httpcache.exception.HttpCacheKeyCreationException; +import com.adobe.acs.commons.httpcache.keys.AbstractCacheKey; +import com.adobe.acs.commons.httpcache.keys.CacheKey; +import org.apache.commons.lang3.builder.EqualsBuilder; +import org.apache.commons.lang3.builder.HashCodeBuilder; +import org.apache.sling.api.SlingHttpServletRequest; + +/** + * CookieCacheKey + *+ * This class represents a cache key in the HTTP Cache that will be used to separate header cache entries. + *
+ */ +public class CookieCacheKey extends AbstractCacheKey implements CacheKey { + + + private final CookieKeyValueMap keyValueMap; + + public CookieCacheKey(SlingHttpServletRequest request, HttpCacheConfig cacheConfig, CookieKeyValueMap keyValueMap) throws + HttpCacheKeyCreationException { + + super(request, cacheConfig); + this.keyValueMap = keyValueMap; + } + + public CookieCacheKey(String uri, HttpCacheConfig cacheConfig, CookieKeyValueMap keyValueMap) throws HttpCacheKeyCreationException { + super(uri, cacheConfig); + + this.keyValueMap = keyValueMap; + } + + public CookieKeyValueMap getKeyValueMap() { + return keyValueMap; + } + + @Override + public boolean equals(Object o) { + if (!super.equals(o)) { + return false; + } + + CookieCacheKey that = (CookieCacheKey) o; + + return new EqualsBuilder() + .append(getUri(), that.getUri()) + .append(keyValueMap, that.keyValueMap) + .append(getAuthenticationRequirement(), that.getAuthenticationRequirement()) + .isEquals(); + } + + @Override + public int hashCode() { + return new HashCodeBuilder(17, 37) + .append(getUri()) + .append(keyValueMap) + .append(getAuthenticationRequirement()).toHashCode(); + } + + @Override + public String toString() { + StringBuilder formattedString = new StringBuilder(this.uri); + formattedString.append(keyValueMap.toString()); + formattedString.append("[AUTH_REQ:" + getAuthenticationRequirement() + "]"); + return formattedString.toString(); + } +} \ No newline at end of file diff --git a/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieKeyValueMap.java b/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieKeyValueMap.java new file mode 100644 index 0000000..7df582f --- /dev/null +++ b/bundle/src/main/java/com/adobe/acs/samples/httpcache/key/CookieKeyValueMap.java @@ -0,0 +1,52 @@ +package com.adobe.acs.samples.httpcache.key; + +import org.apache.commons.lang3.StringUtils; + +import java.util.HashMap; +import java.util.Iterator; + +/** + * CookieKeyValueMap + *+ * Basically a HashMap with a nice toString function for the CookieCacheKey to hold cookies into. + *
+ */ +public class CookieKeyValueMap extends HashMap+ * The purpose of the cookie key value map builder is to handle cookiekeyvaluemap instantation. + *
+ */ +public class CookieKeyValueMapBuilder { + + private final Set+ * A key that only contains a resource path + *
+ */ +public class ResourcePathCacheKey extends AbstractCacheKey implements CacheKey { + + + private final String selector; + private final String extension; + + public ResourcePathCacheKey(SlingHttpServletRequest request, HttpCacheConfig cacheConfig) { + super(request, cacheConfig); + + RequestPathInfo pathInfo = request.getRequestPathInfo(); + selector = pathInfo.getSelectorString(); + extension = pathInfo.getExtension(); + } + + public ResourcePathCacheKey(String uri, HttpCacheConfig cacheConfig){ + super(uri, cacheConfig); + RequestPathInfo pathInfo = new PathInfo(uri); + selector = pathInfo.getSelectorString(); + extension = pathInfo.getExtension(); + } + + @Override + public boolean equals(Object o) { + + if (o == null) { + return false; + } + + ResourcePathCacheKey that = (ResourcePathCacheKey) o; + return new EqualsBuilder() + .append(resourcePath, that.resourcePath) + .append(getExtension(), that.getExtension()) + .append(getSelector(), that.getSelector()) + .isEquals(); + } + + @Override + public int hashCode() { + return new HashCodeBuilder() + .append(resourcePath) + .toHashCode(); + } + + @Override + public String toString(){ + return resourcePath + "." + getSelector() + "." + getExtension(); + } + + + public String getSelector() { + return selector; + } + + public String getExtension() { + return extension; + } +} diff --git a/content/src/main/content/jcr_root/apps/acs-samples/components/structure/page/contentpage/.content.xml b/content/src/main/content/jcr_root/apps/acs-samples/components/structure/page/contentpage/.content.xml new file mode 100644 index 0000000..479a352 --- /dev/null +++ b/content/src/main/content/jcr_root/apps/acs-samples/components/structure/page/contentpage/.content.xml @@ -0,0 +1,7 @@ + +