/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.portlet.container.properties;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apereo.portal.portlet.om.IPortletWindow;
import org.apereo.portal.utils.Populator;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.core.OrderComparator;
import org.springframework.stereotype.Service;

/**
 * Delegates properties related calls to a {@link List} of {@link IRequestPropertiesManager}s in
 * order. No exception handling is done so any exception in a child IRequestPropertiesManager will
 * cause the call to fail. <br>
 * <br>
 * When {@link #getRequestProperties(HttpServletRequest, IPortletWindow)} is called the returned
 * Maps are overlayed in order to produce the final Map that is returned. This means
 * IRequestPropertiesManagers lower in the propertiesManagers List can over-write properties from
 * IRequestPropertiesManagers higher in the list.
 *
 */
@Service("requestPropertiesManager")
@Qualifier("main")
public class RequestPropertiesManagerBroker implements IRequestPropertiesManager {
    protected final Log logger = LogFactory.getLog(this.getClass());
    private List<IRequestPropertiesManager> propertiesManagers = Collections.emptyList();

    @Autowired
    public void setPropertiesManagers(
            Collection<? extends IRequestPropertiesManager> propertiesManagers) {
        this.propertiesManagers = new ArrayList<IRequestPropertiesManager>(propertiesManagers);
        Collections.sort(this.propertiesManagers, OrderComparator.INSTANCE);
    }

    @Override
    public boolean setResponseProperty(
            HttpServletRequest portletRequest,
            IPortletWindow portletWindow,
            String property,
            String value) {

        for (final IRequestPropertiesManager propertiesManager : this.propertiesManagers) {
            if (propertiesManager.setResponseProperty(
                    portletRequest, portletWindow, property, value)) {
                return true;
            }
        }

        return false;
    }

    @Override
    public boolean addResponseProperty(
            HttpServletRequest portletRequest,
            IPortletWindow portletWindow,
            String property,
            String value) {

        for (final IRequestPropertiesManager propertiesManager : this.propertiesManagers) {
            if (propertiesManager.addResponseProperty(
                    portletRequest, portletWindow, property, value)) {
                return true;
            }
        }

        return false;
    }

    @Override
    public <P extends Populator<String, String>> void populateRequestProperties(
            HttpServletRequest portletRequest,
            IPortletWindow portletWindow,
            P propertiesPopulator) {

        for (final IRequestPropertiesManager propertiesManager : this.propertiesManagers) {
            propertiesManager.populateRequestProperties(
                    portletRequest, portletWindow, propertiesPopulator);
        }
    }
}