Package com.sun.identity.xacml.policy

Interface Obligation

All Superinterfaces:
XmlSerializable
All Known Implementing Classes:
ObligationImpl
@SupportedAll public interface Obligation extends XmlSerializable
The Obligation element is a container of one or more AttributeAssignments issuded by authorization authority.

  • Method Summary

    Modifier and Type
    Method
    Description
    List
    getAttributeAssignments()
    Returns XML elements corresponding to AttributeAssignment elements for this obligation.
    String
    getFulfillOn()
    Returns the FullFillOn effect type of this obligation
    URI
    getObligationId()
    Returns the ObligationId of this Obligation
    boolean
    isMutable()
    Checks if this object is mutable
    void
    makeImmutable()
    Makes this object immutable
    void
    setAttributeAssignments(List attributeAssignments)
    Sets XML elements corresponding to AttributeAssignment elements for this obligation.
    void
    setFulfillOn(String fulfillOn)
    Sets the FullFillOn effect type of this obligation
    void
    setObligationId(URI obligationId)
    Sets the ObligationId of the Obligation
    default String
    toXMLString()
    Returns a string representation of this object
    default String
    toXMLString(boolean includeNSPrefix, boolean declareNS)
    Returns a string representation of this object

    Methods inherited from interface com.sun.identity.saml2.common.XmlSerializable

    toDocumentFragment

  • Method Details

    • getObligationId

      URI getObligationId()
      Returns the ObligationId of this Obligation
      Returns:
      the URI representing ObligationId of this Obligation

    • setObligationId

      void setObligationId(URI obligationId) throws XACMLException
      Sets the ObligationId of the Obligation
      Parameters:
      obligationId - URI representing the ObligationId.
      Throws:
      XACMLException - if the object is immutable

    • getFulfillOn

      String getFulfillOn()
      Returns the FullFillOn effect type of this obligation
      Returns:
      the FullFillOn effect type of this obligation

    • setFulfillOn

      void setFulfillOn(String fulfillOn) throws XACMLException
      Sets the FullFillOn effect type of this obligation
      Parameters:
      fulfillOn - FullFillOn effect type of this obligation
      Throws:
      XACMLException

    • getAttributeAssignments

      List getAttributeAssignments()
      Returns XML elements corresponding to AttributeAssignment elements for this obligation.
      Returns:
      the XML elements corresponding to AttributeAssignment elements for this obligation.

    • setAttributeAssignments

      void setAttributeAssignments(List attributeAssignments) throws XACMLException
      Sets XML elements corresponding to AttributeAssignment elements for this obligation.
      Parameters:
      attributeAssignments - XML elements corresponding to AttributeAssignment elements for this obligation.
      Throws:
      XACMLException

    • toXMLString

      default String toXMLString(boolean includeNSPrefix, boolean declareNS) throws XACMLException
      Returns a string representation of this object
      Specified by:
      toXMLString in interface XmlSerializable
      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
      Throws:
      XACMLException - if conversion fails for any reason

    • toXMLString

      default String toXMLString() throws XACMLException
      Returns a string representation of this object
      Specified by:
      toXMLString in interface XmlSerializable
      Returns:
      a string representation
      Throws:
      XACMLException - if conversion fails for any reason

    • makeImmutable

      void makeImmutable()
      Makes this object immutable

    • isMutable

      boolean isMutable()
      Checks if this object is mutable
      Returns:
      true if the object is mutable, false otherwise