-
Notifications
You must be signed in to change notification settings - Fork 596
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
162 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
...va/com/adobe/acs/commons/http/headers/impl/ResourceBasedDispatcherMaxAgeHeaderFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| * #%L | ||
| * ACS AEM Commons Bundle | ||
| * %% | ||
| * Copyright (C) 2013 - 2020 Adobe | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package com.adobe.acs.commons.http.headers.impl; | ||
|
|
||
| import org.apache.jackrabbit.JcrConstants; | ||
| import org.apache.sling.api.SlingHttpServletRequest; | ||
| import org.apache.sling.api.resource.Resource; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public abstract class ResourceBasedDispatcherMaxAgeHeaderFilter extends DispatcherMaxAgeHeaderFilter { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(ResourceBasedDispatcherMaxAgeHeaderFilter.class); | ||
|
|
||
| protected Resource getResource(SlingHttpServletRequest slingRequest) { | ||
| if (slingRequest.getResource().isResourceType("cq:Page")) { | ||
| log.trace("Found page resource, checking page content resource type"); | ||
| return slingRequest.getResource().getChild(JcrConstants.JCR_CONTENT); | ||
| } | ||
| log.trace("Found non-page resource, checking request resource type"); | ||
| return slingRequest.getResource(); | ||
| } | ||
|
|
||
| } |
113 changes: 113 additions & 0 deletions
113
...om/adobe/acs/commons/http/headers/impl/ResourceTypeBasedDispatcherMaxAgeHeaderFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * #%L | ||
| * ACS AEM Commons Bundle | ||
| * %% | ||
| * Copyright (C) 2013 - 2020 Adobe | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package com.adobe.acs.commons.http.headers.impl; | ||
|
|
||
| import org.apache.felix.scr.annotations.Component; | ||
| import org.apache.felix.scr.annotations.ConfigurationPolicy; | ||
| import org.apache.felix.scr.annotations.Properties; | ||
| import org.apache.felix.scr.annotations.Property; | ||
| import org.apache.sling.api.SlingHttpServletRequest; | ||
| import org.apache.sling.api.resource.Resource; | ||
| import org.apache.sling.commons.osgi.PropertiesUtil; | ||
| import org.osgi.service.cm.ConfigurationException; | ||
| import org.osgi.service.component.ComponentContext; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.servlet.http.HttpServletRequest; | ||
| import java.util.Arrays; | ||
| import java.util.Dictionary; | ||
|
|
||
| import static com.adobe.acs.commons.http.headers.impl.AbstractDispatcherCacheHeaderFilter.PROP_DISPATCHER_FILTER_ENGINE; | ||
| import static com.adobe.acs.commons.http.headers.impl.AbstractDispatcherCacheHeaderFilter.PROP_DISPATCHER_FILTER_ENGINE_SLING; | ||
|
|
||
| @Component( | ||
| label = "ACS AEM Commons - Dispacher Cache Control Header Resource Type Based - Max Age", | ||
| description = "Adds a Cache-Control max-age header to content based on resource type to enable Dispatcher TTL support.", | ||
| metatype = true, | ||
| configurationFactory = true, | ||
| policy = ConfigurationPolicy.REQUIRE) | ||
| @Properties({ | ||
| @Property( | ||
| name = "webconsole.configurationFactory.nameHint", | ||
| value = "Max Age: {max.age} for Resource Types: [{resource.types}]", | ||
| propertyPrivate = true), | ||
| @Property( | ||
| name = PROP_DISPATCHER_FILTER_ENGINE, | ||
| value = PROP_DISPATCHER_FILTER_ENGINE_SLING, | ||
| propertyPrivate = true) | ||
| }) | ||
| public class ResourceTypeBasedDispatcherMaxAgeHeaderFilter extends ResourceBasedDispatcherMaxAgeHeaderFilter { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(ResourceTypeBasedDispatcherMaxAgeHeaderFilter.class); | ||
|
|
||
| @Property(label = "Resource types", | ||
| description = "Resource types the page should have to use this filter.", | ||
| cardinality = Integer.MAX_VALUE) | ||
| public static final String PROP_RESOURCE_TYPES = "resource.types"; | ||
|
|
||
| private String[] resourceTypes; | ||
|
|
||
| @Override | ||
| @SuppressWarnings("unchecked") | ||
| protected boolean accepts(final HttpServletRequest request) { | ||
| if (!super.accepts(request)) { | ||
| log.debug("Not accepting request because it is not coming from the dispatcher."); | ||
| return false; | ||
| } | ||
| if (request instanceof SlingHttpServletRequest) { | ||
| SlingHttpServletRequest slingRequest = (SlingHttpServletRequest) request; | ||
| Resource resource = getResource(slingRequest); | ||
| if (resource == null) { | ||
| log.debug("Could not find resource for request, not accepting"); | ||
| return false; | ||
| } else { | ||
| return verifyResourceType(resource); | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private boolean verifyResourceType(Resource resource) { | ||
| for (String resourceType : resourceTypes) { | ||
| if (resource.isResourceType(resourceType)) { | ||
| log.debug("Accepting request for resource: {} with resource type: {}.", resource.getPath(), resourceType); | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| @SuppressWarnings("squid:S1149") | ||
| protected final void doActivate(ComponentContext context) throws Exception { | ||
| super.doActivate(context); | ||
| Dictionary<?, ?> properties = context.getProperties(); | ||
|
|
||
| resourceTypes = PropertiesUtil.toStringArray(properties.get(PROP_RESOURCE_TYPES)); | ||
| if (resourceTypes == null || resourceTypes.length == 0) { | ||
| throw new ConfigurationException(PROP_RESOURCE_TYPES, "At least one resource type must be specified."); | ||
| } | ||
| } | ||
|
|
||
| public String toString() { | ||
| return this.getClass().getName() + "[resource-types:" + Arrays.asList(resourceTypes) + ",fallback-max-age:" + super.getHeaderValue(null) + "]"; | ||
| } | ||
| } |