com.att.research.xacml.api.pdp.ScopeResolver Maven / Gradle / Ivy

Go to download
/*
 *                        AT&T - PROPRIETARY
 *          THIS FILE CONTAINS PROPRIETARY INFORMATION OF
 *        AT&T AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN
 *             ACCORDANCE WITH APPLICABLE AGREEMENTS.
 *
 *          Copyright (c) 2013 AT&T Knowledge Ventures
 *              Unpublished and Not for Publication
 *                     All Rights Reserved
 */
package com.att.research.xacml.api.pdp;

import com.att.research.xacml.api.Attribute;

/**
 * ScopeResolver is the interface that objects implement that can be used to resolve attribute scopes to individual
 * identifiers.
 * 
 * @author car
 * @version $Revision$
 */
public interface ScopeResolver {
	/**
	 * Examines the given {@link com.att.research.xacml.api.Attribute} representing a resource identifier for a hierarchical
	 * resource and returns an Iterator over a set of Attributes representing individual resource identifiers
	 * that are part of the requested hierarchy as specified by the {@link com.att.research.xacml.api.pdp.ScopeQualifier}.
	 * 
	 * @param attributeResourceId the Attribute for the resource identifier
	 * @param scopeQualifier the ScopeQualifier determining which nodes are returned
	 * @return a {@link com.att.research.xacml.api.pdp.ScopeResolverResult} with the results of the request
	 * @throws ScopeResolverException if there is an error resolving the resource identifier to a scope.
	 */
	public ScopeResolverResult resolveScope(Attribute attributeResourceId, ScopeQualifier scopeQualifier) throws ScopeResolverException;
}