Request
element is the top-level element in the XACML
* context scehema. Its an abstraction layer used by the policy language.
* It contains Subject
, Resource
, Action
*
and Environment elements.
*
*
* <xs:complexType name="RequestType">
* <xs:sequence>
* <xs:element ref="xacml-context:Subject" maxOccurs="unbounded"/>
* <xs:element ref="xacml-context:Resource" maxOccurs="unbounded"/>
* <xs:element ref="xacml-context:Action"/>
* <xs:element ref="xacml-context:Environment"/>
* <xs:sequence>
* <xs:complexType>
*
*@supported.all.api
*/
public interface Request {
/**
* Returns the one to many Subject
elements of this object
*
* @return the Subject
elements of this object
*/
public List getSubjects();
/**
* Sets the one to many Subject
elements of this object
*
* @param subjects the one to many Subject
elements of this
* object
*
* @exception XACMLException if the object is immutable
* An object is considered immutable
if
* makeImmutable()
has been invoked on it. It can
* be determined by calling isMutable
on the object.
*/
public void setSubjects(List subjects) throws XACMLException;
/**
* Returns the one to many Resource
elements of this object
*
* @return the Resource
elements of this object
*/
public List getResources();
/**
* Sets the one to many Resource
elements of this object
*
* @param resources the one to many Resource
elements of this
* object
*
* @exception XACMLException if the object is immutable
* An object is considered immutable
if
* makeImmutable()
has been invoked on it. It can
* be determined by calling isMutable
on the object.
*/
public void setResources(List resources) throws XACMLException;
/**
*
* Returns the instance of Action
*
* @return instance of Action
*/
public Action getAction();
/**
* Sets the instance of Action
*
* @param action instance of Action
*
* @exception XACMLException if the object is immutable
* An object is considered immutable
if
* makeImmutable()
has been invoked on it. It can
* be determined by calling isMutable
on the object.
*/
public void setAction(Action action) throws XACMLException;
/**
* Returns the instance of Environment
*
* @return the instance of Environment
*/
public Environment getEnvironment();
/**
* Sets the instance of Environment
*
* @param env instance of Environment
*
* @exception XACMLException if the object is immutable
* An object is considered immutable
if
* makeImmutable()
has been invoked on it. It can
* be determined by calling isMutable
on the object.
*/
public void setEnvironment(Environment env) throws XACMLException;
/**
* Returns a String
representation of this object
* @param includeNSPrefix Determines whether or not the namespace qualifier
* is prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return a string representation of this object
* @exception XACMLException if conversion fails for any reason
*/
public String toXMLString(boolean includeNSPrefix, boolean declareNS)
throws XACMLException;
/**
* Returns a string representation of this object
*
* @return a string representation of this object
* @exception XACMLException if conversion fails for any reason
*/
public String toXMLString() throws XACMLException;
/**
* Makes the object immutable
*/
public void makeImmutable();
/**
* Checks if the object is mutable
*
* @return true
if the object is mutable,
* false
otherwise
*/
public boolean isMutable();
}