001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2013 UnboundID Corp.
026     */
027    
028    package com.unboundid.directory.sdk.broker.types;
029    
030    import java.util.List;
031    
032    /**
033     * Interface which provides access to the request context for the XACML request
034     * currently being processed.
035     */
036    public interface RequestContext
037    {
038      /**
039       * Get the value of the subject attribute of the current request.
040       * @return  Subject string.
041       */
042      String getSubject();
043    
044      /**
045       * Get the value of the action attribute of the current request.
046       * @return  Action string.
047       */
048      String getAction();
049    
050      /**
051       * Get the values of the resource attributes of the current request.
052       * @return Resource strings
053       */
054      List<String> getResources();
055    
056      /**
057       * Get the specified attribute from the current request.
058       * @param categoryId the XACML category URI
059       * @param attributeId the XACML attribute Id
060       * @return RequestAttribute object, or null if the attribute could not
061       * be found in the request context.
062       * @throws AttributeRetrievalException if an error occurs retrieving
063       * the attribute
064       */
065      RequestAttribute getAttribute(String categoryId, String attributeId)
066          throws AttributeRetrievalException;
067    }