org.fcrepo.server.security.xacml.pep.ContextHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fcrepo-security-pep Show documentation
The newest version!
/*
 * File: ContextHandler.java
 *
 * Copyright 2007 Macquarie E-Learning Centre Of Excellence
 *
 * 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.fcrepo.server.security.xacml.pep;

import java.net.URI;
import java.util.List;
import java.util.Map;

import org.fcrepo.server.security.RequestCtx;
import org.jboss.security.xacml.sunxacml.attr.AttributeValue;
import org.jboss.security.xacml.sunxacml.ctx.ResponseCtx;

/**
 * This interface represents the bridge between the PEP and the PDP. It is
 * responsible for building requests and passing them to the PDP. It then
 * receives the response and passes it to the PEP.
 *
 * @author [email protected]
 */
public interface ContextHandler {

    /**
     * Creates a new Request.
     *
     * @param subjects
     *        a list of Map<URI, AttributeValue> containing the attributes for a
     *        set of subjects.
     * @param actions
     *        the URI of the requested Action.
     * @param resources
     *        a Map<URI, AttributeValue> containing the attributes for a
     *        resource.
     * @param environment
     *        Map<URI, AttributeValue> containing the attributes for the
     *        environment.
     * @return a request context for a PDP to handle.
     * @throws PEPException
     */
    public RequestCtx buildRequest(List>> subjects,
                                   Map actions,
                                   Map resources,
                                   Map environment)
            throws PEPException;

    /**
     * @param reqCtx
     *        an XACML request context for resolution.
     * @return an XACML response context based on the evaluation of the request
     *         context.
     * @throws PEPException
     */
    public ResponseCtx evaluate(RequestCtx reqCtx) throws PEPException;

    /**
     * @param req
     *        an XACML request as a string for resolution.
     * @return an XACML response as a string based on the evaluation of the
     *         request context.
     * @throws PEPException
     */
    public String evaluate(String req) throws PEPException;

    /**
     * @param requests
     *        an array of XACML requests as strings for resolution.
     * @return an XACML response as a string based on the evaluation of the
     *         request context.
     * @throws PEPException
     */
    public String evaluateBatch(String[] requests) throws PEPException;

    public ResponseCtx evaluateBatch(RequestCtx[] requests) throws PEPException;

}