[SLING-7256] Sling Models injector for CAConfig

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: Models Context-Aware Configuration 1.0.0
• Component/s: Sling Models
• Assignee: Stefan Seifert
• Reporter: Henry Kuijpers
• Created: 20/Nov/17 17:39
• Updated: 07/Jan/22 07:27
• Resolved: 22/Dec/21 22:36

Description

It would be great to have a Sling Models injector for CAConfig.

An example could be:

@Component
public class ContextAwareConfigurationInjector implements Injector {
    public String getName() {
        return "ca-config";
    }

    public Object getValue(Object adaptable, String name, Type declaredType, AnnotatedElement element,
                           DisposalCallbackRegistry callbackRegistry) {
        if (isConfigurationObject(declaredType)) {
            final Resource resource;
            if (adaptable instanceof Resource) {
                resource = (Resource) adaptable;
            } else if (adaptable instanceof SlingHttpServletRequest) {
                // TODO: Is this always the correct resource? (Most often we want the one in /content)
                // So we do not want /conf/... for example
                final SlingHttpServletRequest request = (SlingHttpServletRequest)adaptable;
                final ResourceResolver resourceResolver = request.getResourceResolver();
                resource = resourceResolver.resolve(request, request.getRequestURI());
            } else {
                throw new IllegalArgumentException("Either a resource or the request should be used");
            }

            final ConfigurationBuilder builder = resource.adaptTo(ConfigurationBuilder.class);
            if (builder != null) {
                return builder.as((Class<?>) declaredType);
            }
        }
        return null;
    }

    private static boolean isConfigurationObject(Type type) {
        if (!(type instanceof Class<?>)) {
            return false;
        }

        Class<?> clazz = (Class<?>) type;
        return clazz.isAnnotation() && clazz.isAnnotationPresent(Configuration.class);
    }
}

+ annotation:

@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@InjectAnnotation
@Source("ca-config")
@Qualifier
public @interface CaConfig {
}

Issue Links

• depends upon: SLING-8849 CA Config HTL bindings value provider is too limited: Unable to influence the source of adaption
• is related to: SLING-9977 add context aware configurations in pipes bindings
• is related to: SLING-11033 caconfig-mock-plugin: Support Sling Models injector for CAConfig
• links to: GitHub Pull Request #1