/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.sling.models.impl.injectors;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Type;
import javax.servlet.ServletRequest;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.scripting.SlingBindings;
import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
import org.apache.sling.models.spi.DisposalCallbackRegistry;
import org.apache.sling.models.spi.Injector;
import org.apache.sling.models.spi.injectorspecific.AbstractInjectAnnotationProcessor;
import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor;
import org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessorFactory;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Component
@Service
@Property(name = Constants.SERVICE_RANKING, intValue = 1000)
public class BindingsInjector implements Injector, InjectAnnotationProcessorFactory {
private static final Logger log = LoggerFactory.getLogger(BindingsInjector.class);
@Override
public String getName() {
return "script-bindings";
}
private static Object getValue(SlingBindings bindings, String name, Class<?> type) {
return bindings.get(name);
}
public Object getValue(Object adaptable, String name, Type type, AnnotatedElement element,
DisposalCallbackRegistry callbackRegistry) {
SlingBindings bindings = getBindings(adaptable);
if (bindings == null) {
return null;
}
if (type instanceof Class<?>) {
return getValue(bindings, name, (Class<?>) type);
} else {
log.debug("BindingsInjector doesn't support non-class type {}", type);
return null;
}
}
private SlingBindings getBindings(Object adaptable) {
if (adaptable instanceof ServletRequest) {
ServletRequest request = (ServletRequest) adaptable;
return (SlingBindings) request.getAttribute(SlingBindings.class.getName());
} else {
return null;
}
}
@Override
public InjectAnnotationProcessor createAnnotationProcessor(Object adaptable, AnnotatedElement element) {
// check if the element has the expected annotation
ScriptVariable annotation = element.getAnnotation(ScriptVariable.class);
if (annotation != null) {
return new ScriptVariableAnnotationProcessor(annotation);
}
return null;
}
private static class ScriptVariableAnnotationProcessor extends AbstractInjectAnnotationProcessor {
private final ScriptVariable annotation;
public ScriptVariableAnnotationProcessor(ScriptVariable annotation) {
this.annotation = annotation;
}
@Override
public Boolean isOptional() {
return annotation.optional();
}
@Override
public String getName() {
// since null is not allowed as default value in annotations, the empty string means, the default should be
// used!
if (annotation.name().isEmpty()) {
return null;
}
return annotation.name();
}
}
}