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 2018 Ping Identity Corporation
026 */
027
028package com.unboundid.directory.sdk.broker.types;
029
030/**
031 * Object passed to Obligation and Advice implementations containing
032 * information about the policy request that triggered the return of
033 * the Obligation or Advice.
034 */
035public interface PolicyRequestDetails {
036
037  /**
038   * Get the action for which authorization was requested.
039   * @return the action string that was passed in the policy request.
040   */
041  String getAction();
042
043  /**
044   * Get the path to the resource for which authorization was requested.
045   * @return the resource path.
046   */
047  String getResourcePath();
048
049  /**
050   * Get the type of resource to which authorization was requested.
051   * @return a string representing the resource type, as defined by
052   * the Policy Enforcement Point that made the authorization request.
053   */
054  String getResourceType();
055
056  /**
057   * Get the decision returned from the authorization request.
058   * @return PolicyDecision enum represeting either Permit or Deny.
059   */
060  PolicyDecision getDecision();
061}