-
Notifications
You must be signed in to change notification settings - Fork 732
/
CaConfigReferenceProvider.java
122 lines (108 loc) · 4.47 KB
/
CaConfigReferenceProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright 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.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
package com.adobe.cq.wcm.core.components.internal.services;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.List;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.caconfig.management.ConfigurationManager;
import org.apache.sling.caconfig.resource.ConfigurationResourceResolver;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;
import com.day.cq.wcm.api.reference.Reference;
import com.day.cq.wcm.api.reference.ReferenceProvider;
import static com.adobe.cq.wcm.core.components.util.ComponentUtils.NN_SLING_CONFIGS;
/**
* Provides Context Aware Configuration references for a given resource.
*/
@Designate(ocd = CaConfigReferenceProvider.Config.class)
@Component(
service = ReferenceProvider.class
)
public class CaConfigReferenceProvider implements ReferenceProvider {
@ObjectClassDefinition(
name = "Core Components Context-Aware Configuration Reference Provider"
)
@interface Config {
@AttributeDefinition(
name = "Enabled",
description = "Enable this reference provider"
)
boolean enabled() default true;
}
private static final String CA_CONFIG_REFERENCE_TYPE = "caconfig";
/**
* The {@link ConfigurationManager} service;
*/
@org.osgi.service.component.annotations.Reference
private ConfigurationManager configurationManager;
/**
* The @{@link ConfigurationResourceResolver} service.
*/
@org.osgi.service.component.annotations.Reference
private ConfigurationResourceResolver configurationResourceResolver;
private boolean enabled;
@Activate
protected void activate(Config config) {
enabled = config.enabled();
}
@Deactivate
protected void deactivate() {
enabled = false;
}
@Override
public List<Reference> findReferences(Resource resource) {
if (!enabled) {
return Collections.emptyList();
}
List<Reference> references = new ArrayList<>();
// If the resource is not part of a page: stop the processing
PageManager pageManager = resource.getResourceResolver().adaptTo(PageManager.class);
if (pageManager == null) {
return references;
}
Page page = pageManager.getContainingPage(resource);
if (page == null) {
return references;
}
for (String config : configurationManager.getConfigurationNames()) {
addCaConfigReference(config, resource, references);
}
return references;
}
private void addCaConfigReference(String configName, Resource resource, List<Reference> references) {
Resource configResource = configurationResourceResolver.getResource(resource, NN_SLING_CONFIGS, configName);
if (configResource != null) {
references.add(new Reference(CA_CONFIG_REFERENCE_TYPE, configName, configResource, getLastModificationTime(configResource)));
}
}
private long getLastModificationTime(Resource configResource) {
Page configPage = configResource.adaptTo(Page.class);
if (configPage != null) {
Calendar lastModified = configPage.getLastModified();
return lastModified != null ? lastModified.getTimeInMillis() : -1L;
} else {
return configResource.getResourceMetadata().getModificationTime();
}
}
}