reference/src/main/java/org/apache/sling/cms/reference/impl/SearchServiceImpl.java

/*
 * 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.cms.reference.impl;

import java.util.Collections;

import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.request.SlingRequestEvent;
import org.apache.sling.api.request.SlingRequestListener;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.cms.reference.SearchService;
import org.apache.sling.cms.reference.impl.SearchServiceImpl.Config;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of the SearchService
 */
@Component(service = { SearchService.class, SlingRequestListener.class })
@Designate(ocd = Config.class)
public class SearchServiceImpl implements SearchService, SlingRequestListener {

    private static final Logger log = LoggerFactory.getLogger(SearchServiceImpl.class);

    private final ResourceResolverFactory factory;

    private final Config config;

    private static final String RESOURCE_RESOLVER_ATTR = SearchServiceImpl.class.getName() + ":ResourceResolver";

    @ObjectClassDefinition(name = "%cms.reference.search.name", description = "%cms.reference.search.description", localization = "OSGI-INF/l10n/bundle")
    public @interface Config {

        @AttributeDefinition(name = "%searchServiceUsername.name", description = "%searchServiceUsername.description")
        String searchServiceUsername();
    }

    @Activate
    public SearchServiceImpl(@Reference ResourceResolverFactory factory, Config config) {
        this.factory = factory;
        this.config = config;
    }

    @Override
    public ResourceResolver getResourceResolver(SlingHttpServletRequest request) {

        if (config != null && StringUtils.isNotBlank(config.searchServiceUsername())) {
            try {
                log.debug("Retrieving Service User {}", config.searchServiceUsername());
                ResourceResolver resolver = factory.getServiceResourceResolver(
                        Collections.singletonMap(ResourceResolverFactory.SUBSERVICE, config.searchServiceUsername()));
                request.setAttribute(RESOURCE_RESOLVER_ATTR, resolver);
                return resolver;
            } catch (LoginException e) {
                log.warn("Failed to retrieve Service User {}, falling back to request user",
                        config.searchServiceUsername(), e);
                return request.getResourceResolver();
            }
        } else {
            log.debug("Using request user");
            return request.getResourceResolver();
        }
    }

    @Override
    public void onEvent(SlingRequestEvent sre) {
        if (sre.getType() == SlingRequestEvent.EventType.EVENT_DESTROY
                && sre.getServletRequest().getAttribute(RESOURCE_RESOLVER_ATTR) != null
                && sre.getServletRequest().getAttribute(RESOURCE_RESOLVER_ATTR) instanceof ResourceResolver) {
            ResourceResolver resolver = (ResourceResolver) sre.getServletRequest().getAttribute(RESOURCE_RESOLVER_ATTR);
            resolver.close();
        }

    }

}