trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/UserInfoAttributesService.java

/*
 * Copyright 2003-2006 The Apache Software Foundation.
 *
 * 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 org.apache.pluto.spi.optional;

import java.util.Map;

import javax.portlet.PortletRequest;

import org.apache.pluto.PortletContainerException;
import org.apache.pluto.spi.ContainerService;

/**
 * Used to access user information attributes as described in
 * PLT.17.2 of the JSR-168 specificiation. Attribute persistence is
 * not covered by the spec so it is not done here.
 * 
 * @author <a href="cdoremus@apache.org">Craig Doremus</a>
 */
public interface UserInfoAttributesService extends ContainerService  {

	/**
	 * To access user information attributes as defined in PLT.17
	 * of JSR-168.
	 * 
	 * @param request Used to extract the authenticated user name.
	 * @return A map of names and values of user information attributes
	 * for a particular authenticated user.
	 */
    Map getAttributes(PortletRequest request) 
    	throws PortletContainerException ;
    
	/**
	 * Persists user information attributes. 
	 *  
	 * @param attributes The attributes to persist.
    void store(UserInfoAttribute[] attributes)
    	throws PortletContainerException;
	 */

}