/**
 * 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.services;

import javax.servlet.http.HttpServletRequest;
import org.apache.pluto.container.PortletRequestContext;
import org.apache.pluto.container.PortletWindow;

/**
 * This interface hooks into the {@link PortletRequestContext} implementation for uPortal and
 * provides a mechanism for finding additional attributes.
 *
 */
public interface RequestAttributeService {

    /**
     * @param httpServletRequest
     * @param plutoPortletWindow
     * @param name
     * @return the corresponding request attribute, or null if none found
     */
    public Object getAttribute(
            HttpServletRequest httpServletRequest, PortletWindow plutoPortletWindow, String name);
}