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-2016 UnboundID Corp.
026 */
027
028package com.unboundid.directory.sdk.broker.types;
029
030import javax.servlet.http.HttpServletRequest;
031import java.util.List;
032
033/**
034 * Interface which provides access to the request context for the XACML request
035 * currently being processed.
036 */
037public interface RequestContext
038{
039  /**
040   * Get the value of the subject attribute of the current request.
041   * @return  Subject string.
042   */
043  String getSubject();
044
045  /**
046   * Get the value of the action attribute of the current request.
047   * @return  Action string.
048   */
049  String getAction();
050
051  /**
052   * Get the values of the resource attributes of the current request.
053   * @return Resource strings
054   */
055  List<String> getResources();
056
057  /**
058   * Get the specified attribute from the current request.
059   * @param categoryId the XACML category URI
060   * @param attributeId the XACML attribute Id
061   * @return RequestAttribute object, or null if the attribute could not
062   * be found in the request context.
063   * @throws AttributeRetrievalException if an error occurs retrieving
064   * the attribute
065   */
066  RequestAttribute getAttribute(String categoryId, String attributeId)
067      throws AttributeRetrievalException;
068
069  /**
070   * Get the HttpServletRequest associated with the current request.
071   * @return HttpServletRequest object
072   */
073  HttpServletRequest getHttpRequest();
074}