Package com.ibm.security.access.extension.authz

Interface RequestContext

  • public interface RequestContext
    A request context object.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<Attribute> getActionAttribute​(java.lang.String attributeId, java.lang.String dataType, java.lang.String issuer)
      Called to get action attributes in the current XACML request.
      java.util.List<Attribute> getEnvironmentAttribute​(java.lang.String attributeId, java.lang.String dataType, java.lang.String issuer)
      Called to get environment attributes in the current XACML request.
      java.lang.Object getParameter​(java.lang.String parameterName)
      Retrieve a parameter of the given name in the XACML request.
      java.util.List<Attribute> getResourceAttribute​(java.lang.String attributeId, java.lang.String dataType, java.lang.String issuer)
      Called to get resources attributes in the current XACML request.
      org.w3c.dom.Node[] getResourceContents()
      Retrieve the resource contents in the XACML request.
      java.util.List<Attribute> getSubjectAttributes​(java.lang.String attributeId, java.lang.String dataType, java.lang.String issuer)
      Called to get subject attributes in the current XACML request.
      java.util.List<Attribute> getSubjectAttributes​(java.lang.String subjectCategory, java.lang.String attributeId, java.lang.String dataType, java.lang.String issuer)
      Called to get subject attributes in the current XACML request.

    • Method Detail

      • getSubjectAttributes

        java.util.List<Attribute> getSubjectAttributes​(java.lang.String attributeId,
                                               java.lang.String dataType,
                                               java.lang.String issuer)
        Called to get subject attributes in the current XACML request.
        Parameters:
        attributeId - the id of the attribute to get.
        dataType - the data type of the attribute.
        issuer - the name of the issuer associated with the attributeId.
        Returns:
        list of attributes to return. If multiple values exist for an attribute, then multiple Attribute objects with the same name are created and returned in the list.

      • getSubjectAttributes

        java.util.List<Attribute> getSubjectAttributes​(java.lang.String subjectCategory,
                                               java.lang.String attributeId,
                                               java.lang.String dataType,
                                               java.lang.String issuer)
        Called to get subject attributes in the current XACML request.
        Parameters:
        subjectCategory - the subject category.
        attributeId - the id of the attribute to get.
        dataType - the data type of the attribute.
        issuer - the name of the issuer associated with the attributeId.
        Returns:
        list of attributes to return. If multiple values exist for an attribute, then multiple Attribute objects with the same name are created and returned in the list.

      • getResourceAttribute

        java.util.List<Attribute> getResourceAttribute​(java.lang.String attributeId,
                                               java.lang.String dataType,
                                               java.lang.String issuer)
        Called to get resources attributes in the current XACML request.
        Parameters:
        attributeId - the id of the attribute to get.
        dataType - the data type of the attribute.
        issuer - the name of the issuer associated with the attributeId.
        Returns:
        list of attributes to return. If multiple values exist for an attribute, then multiple Attribute objects with the same name are created and returned in the list.

      • getActionAttribute

        java.util.List<Attribute> getActionAttribute​(java.lang.String attributeId,
                                             java.lang.String dataType,
                                             java.lang.String issuer)
        Called to get action attributes in the current XACML request.
        Parameters:
        attributeId - the id of the attribute to get.
        dataType - the data type of the attribute.
        issuer - the name of the issuer associated with the attributeId.
        Returns:
        list of attributes to return. If multiple values exist for an attribute, then multiple Attribute objects with the same name are created and returned in the list.

      • getEnvironmentAttribute

        java.util.List<Attribute> getEnvironmentAttribute​(java.lang.String attributeId,
                                                  java.lang.String dataType,
                                                  java.lang.String issuer)
        Called to get environment attributes in the current XACML request.
        Parameters:
        attributeId - the id of the attribute to get.
        dataType - the data type of the attribute.
        issuer - the name of the issuer associated with the attributeId.
        Returns:
        list of attributes to return. If multiple values exist for an attribute, then multiple Attribute objects with the same name are created and returned in the list.

      • getParameter

        java.lang.Object getParameter​(java.lang.String parameterName)
        Retrieve a parameter of the given name in the XACML request.
        Parameters:
        parameterName - the parameter name.
        Returns:
        value of parameter.

      • getResourceContents

        org.w3c.dom.Node[] getResourceContents()
        Retrieve the resource contents in the XACML request.
        Returns:
        a dom node.