/**
 * 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.cxf.rt.security.xacml;

import java.security.Principal;
import java.util.List;

import org.apache.cxf.message.Message;
import org.opensaml.xacml.ctx.RequestType;


/**
 * This interface defines a way to create an XACML Request.
 */
public interface XACMLRequestBuilder {
    
    /**
     * Create an XACML Request given a Principal, list of roles and Message.
     * 
     * @param principal The principal to insert into the Subject of the Request
     * @param roles The list of roles associated with the principal
     * @param message The Message from which to retrieve the resource
     * @return An OpenSAML RequestType object
     * @throws Exception
     */
    RequestType createRequest(
        Principal principal, List<String> roles, Message message
    ) throws Exception;
    
    /**
     * Return the list of Resources that have been inserted into the Request.
     * 
     * @param message The Message from which to retrieve the resource
     * @return the list of Resources that have been inserted into the Request
     */
    @Deprecated
    List<String> getResources(Message message);
    
    /**
     * Return the Resource that has been inserted into the Request.
     * 
     * @param message The Message from which to retrieve the resource
     * @return the Resource that has been inserted into the Request
     */
    @Deprecated
    String getResource(Message message);
}
