com.sun.identity.xacml.context

Interface Resource

All Known Implementing Classes:

ResourceImpl

public interface Resource

The Resource element specifies information about the resource to which access is requested by listing a sequence of Attribute elements associated with the resource. it may include ResourceContent

 <xs:element name="Resource" type="xacml-context:ResourceType"/>
   <xs:complexType name="ResourceType">
     <xs:sequence>
       <xs:element ref="xacml-context:ResourceContent" minOccurs="0"/>
       <xs:element ref="xacml-context:Attribute" minOccurs="0" 
          maxOccurs="unbounded"/>
    <xs:sequence>
  <xs:complexType>
 

Method Summary

Modifier and Type	Method and Description
List	getAttributes() Returns zero to many Attribute elements of this object If no attributes and present, empty List will be returned.
Element	getResourceContent() Returns the resource content of the Resource
boolean	isMutable() Checks if the object is mutable
void	makeImmutable() Makes the object immutable
void	setAttributes(List attributes) Sets the Attribute elements of this object
void	setResourceContent(Element resourceContent) Sets the resource content of this object
String	toXMLString() Returns a string representation of this object
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation of this object

Method Detail

getResourceContent

Element getResourceContent()

Returns the resource content of the Resource

Returns:

String representing the contents of the Resource.

setResourceContent

void setResourceContent(Element resourceContent)
                 throws XACMLException

Sets the resource content of this object

Parameters:

resourceContent - Resource Content of this resource resource content is optional so could be null.

Throws:

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.

getAttributes

List getAttributes()

Returns zero to many Attribute elements of this object If no attributes and present, empty List will be returned. Typically a Resource element will contain an Attribute with an AttributeId of "urn:oasis:names:tc:xacml:1.0:resource:resource-id". Each such Attribute SHALL be an absolute abd fully resolved representation of the identity of the single resource to which access is requested.

Returns:

List containing the Attribute elements of this object

setAttributes

void setAttributes(List attributes)
            throws XACMLException

Sets the Attribute elements of this object

Parameters:

attributes - Attribute elements of this object attributes could be an empty List, if no attributes are present.

Throws:

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.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws XACMLException

Returns a String representation of this object

Parameters:

includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

a string representation of this object

Throws:

XACMLException - if conversion fails for any reason

toXMLString

String toXMLString()
            throws XACMLException

Returns a string representation of this object

Returns:

a string representation of this object

Throws:

XACMLException - if conversion fails for any reason

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Checks if the object is mutable

Returns:

true if the object is mutable, false otherwise