/
AbstractComponentImpl.java
189 lines (168 loc) · 6.11 KB
/
AbstractComponentImpl.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright 2019 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.util;
import java.util.Calendar;
import java.util.Optional;
import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import com.adobe.cq.wcm.core.components.internal.ContentFragmentUtils;
import com.adobe.cq.wcm.core.components.models.Component;
import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
import com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder;
import com.adobe.cq.wcm.style.ComponentStyleInfo;
import com.day.cq.commons.jcr.JcrConstants;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.components.ComponentContext;
import org.osgi.annotation.versioning.ConsumerType;
/**
* Abstract class that can be used as a base class for {@link Component} implementations.
*/
@ConsumerType
public abstract class AbstractComponentImpl implements Component {
/**
* The current request.
*/
@Self
protected SlingHttpServletRequest request;
/**
* The current resource.
*/
@SlingObject
protected Resource resource;
/**
* The component.
*/
@ScriptVariable(injectionStrategy = InjectionStrategy.OPTIONAL)
@Nullable
protected com.day.cq.wcm.api.components.Component component;
/**
* The component context.
*/
@ScriptVariable(injectionStrategy = InjectionStrategy.OPTIONAL)
@Nullable
protected ComponentContext componentContext;
/**
* The current page.
*/
@ScriptVariable(injectionStrategy = InjectionStrategy.OPTIONAL)
@Nullable
private Page currentPage;
/**
* The ID for this component.
*/
private String id;
/**
* Flag indicating if the data layer is enabled.
*/
private Boolean dataLayerEnabled;
/**
* The data layer component data.
*/
private ComponentData componentData;
/**
* Getter for current page.
*
* @return The current {@link Page}
*/
protected Page getCurrentPage() {
return currentPage;
}
/**
* Setter for current page.
* @param currentPage The {@link Page} to set
*/
protected void setCurrentPage(Page currentPage) {
this.currentPage = currentPage;
}
@NotNull
@Override
public String getId() {
if (id == null) {
String resourceCallerPath = (String)request.getAttribute(ContentFragmentUtils.ATTR_RESOURCE_CALLER_PATH);
this.id = ComponentUtils.getId(this.resource, this.currentPage, resourceCallerPath, this.componentContext);
}
return id;
}
@NotNull
@Override
public String getExportedType() {
return resource.getResourceType();
}
/**
* See {@link Component#getData()}
*
* @return The component data
*/
@Override
@Nullable
public ComponentData getData() {
if (componentData == null) {
if (this.dataLayerEnabled == null) {
if (this.currentPage != null ) {
// Check at page level to allow components embedded via containers in editable templates to inherit the setting
this.dataLayerEnabled = ComponentUtils.isDataLayerEnabled(this.request, this.currentPage.getContentResource());
} else {
this.dataLayerEnabled = ComponentUtils.isDataLayerEnabled(this.request, this.resource);
}
}
if (this.dataLayerEnabled) {
componentData = getComponentData();
}
}
return componentData;
}
/**
* See {@link Component#getAppliedCssClasses()}
*
* @return The component styles/css class names
*/
@Override
@Nullable
public String getAppliedCssClasses() {
return Optional.ofNullable(this.resource.adaptTo(ComponentStyleInfo.class))
.map(ComponentStyleInfo::getAppliedCssClasses)
.filter(StringUtils::isNotBlank)
.orElse(null); // Returning null so sling model exporters don't return anything for this property if not configured
}
/**
* Override this method to provide a different data model for your component. This will be called by
* {@link AbstractComponentImpl#getData()} in case the datalayer is activated.
*
* @return The component data.
*/
@NotNull
protected ComponentData getComponentData() {
return DataLayerBuilder.forComponent()
.withId(this::getId)
.withLastModifiedDate(() ->
// Note: this can be simplified in JDK 11
Optional.ofNullable(resource.getValueMap().get(JcrConstants.JCR_LASTMODIFIED, Calendar.class))
.map(Calendar::getTime)
.orElseGet(() ->
Optional.ofNullable(resource.getValueMap().get(JcrConstants.JCR_CREATED, Calendar.class))
.map(Calendar::getTime)
.orElse(null)))
.withType(() -> this.resource.getResourceType())
.build();
}
}