com.sixdimensions.wcm.cq.component.bindings.impl.ComponentBindingsValuesProvider.java Source code

Introduction

Here is the source code for com.sixdimensions.wcm.cq.component.bindings.impl.ComponentBindingsValuesProvider.java

Source

/*
 * Copyright 2013 - Six Dimensions
 *
 * 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.sixdimensions.wcm.cq.component.bindings.impl;

import java.util.Collection;

import javax.script.Bindings;

import org.apache.commons.collections.BoundedCollection;
import org.apache.commons.collections.buffer.CircularFifoBuffer;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.scripting.api.BindingsValuesProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sixdimensions.wcm.cq.component.bindings.CQVariables;
import com.sixdimensions.wcm.cq.component.bindings.CQVariablesService;
import com.sixdimensions.wcm.cq.component.bindings.ComponentBindingsExceptionData;
import com.sixdimensions.wcm.cq.component.bindings.ComponentBindingsProvider;
import com.sixdimensions.wcm.cq.component.bindings.ComponentBindingsProviderFactory;

/**
 * Initializes all components using the ComponentBindingsProviderFactory to
 * retrieve the correct component bindings provider based on the resource type
 * for the resource.
 * 
 * @author dklco
 * 
 */
@Component
@Service(value = { ComponentBindingsValuesProvider.class, BindingsValuesProvider.class })
public class ComponentBindingsValuesProvider implements BindingsValuesProvider {

    /**
     * The SLF4J Logger
     */
    private static final Logger log = LoggerFactory.getLogger(ComponentBindingsValuesProvider.class);

    /**
     * A reference to the component bindings providers factory.
     */
    @Reference
    private ComponentBindingsProviderFactory cif;

    /**
     * A collection for holding the recent Exceptions from invoking Component
     * Binding Providers
     */
    private final BoundedCollection recentExceptions = new CircularFifoBuffer(100);

    /**
     * @return the recentExceptions
     */
    public BoundedCollection getRecentExceptions() {
        return recentExceptions;
    }

    /**
     * A reference to the bindings service
     */
    @Reference
    private CQVariablesService variablesService;

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.apache.sling.scripting.api.BindingsValuesProvider#addBindings(javax
     * .script.Bindings)
     */
    @SuppressWarnings("unchecked")
    // Suppressing warnings since Commons Collections is gangster...
    @Override
    public void addBindings(Bindings bindings) {
        try {
            SlingHttpServletRequest request = (SlingHttpServletRequest) bindings.get("request");
            String resourceType = request.getResource().getResourceType();
            Collection<ComponentBindingsProvider> cis = cif.getComponentBindingsProviders(resourceType);
            if (cis != null && cis.size() > 0) {
                CQVariables variables = variablesService.getVariables(bindings);
                for (ComponentBindingsProvider ci : cis) {
                    try {
                        log.debug("Invoking component bindings provider {}", ci);
                        ci.addBindings(variables, bindings);
                    } catch (Exception e) {
                        log.error("Exception invoking component bindings provider " + ci, e);
                        recentExceptions.add(new ComponentBindingsExceptionData(ci, e));
                    }
                }
            }
        } catch (Exception e) {
            log.error("Exception invoking component binding providers", e);
        }
    }
}