Interface RequestSecurityToken


  • public interface RequestSecurityToken
    Represents the interface for the input RequestSecurityToken type.
    Version:
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAuditTrailID()
      Gets the auditTrialID This allows for the case where a client may have included the id in the RST
      org.w3c.dom.Element getBase()
      Returns the base Element of this RequestSecurityToken.
      org.w3c.dom.Element getBase​(java.lang.String tokenTypeURI)
      Returns the base Element of this RequestSecurityToken that matches the specified token URI.
      org.w3c.dom.Element getCancelTarget()
      Returns the cancel target of this RequestSecurityToken as an Element object.
      org.w3c.dom.Element getRenewTarget()
      Returns the renew target of this RequestSecurityToken as an Element object.
      org.w3c.dom.Element getSecondaryParameters()
      Returns the secondary parameters of this RequestSecurityToken as an Element object.
      org.w3c.dom.Element getValidateTarget()
      Returns the validate target of this RequestSecurityToken as an Element object.
      void setAuditTrailID​(java.lang.String id)
      Sets the auditTrialID This could be automatically determined, however it is not always needed so the caller must explicitly set the ID in order to have it included in the request
      void setBase​(org.w3c.dom.Element value)
      Sets the base Element of this RequestSecurityToken.
      void setBase_0401​(org.w3c.dom.Element value)
      setBase_0401 Use to set the Base token ala the 2004/01 specification.
      void setCancelTarget​(org.w3c.dom.Element target)
      Sets the cancel target of this RquestSecurityToken based on the target Element provided.
      void setRenewTarget​(org.w3c.dom.Element target)
      Sets the renew target of this RquestSecurityToken based on the target Element provided.
      void setSecondaryParameters​(org.w3c.dom.Element target)
      Sets the secondary parameters of this RquestSecurityToken based on the target Element provided.
      void setValidateTarget​(org.w3c.dom.Element target)
      Sets the validate target of this RquestSecurityToken based on the target Element provided.
    • Method Detail

      • getBase

        org.w3c.dom.Element getBase()
        Returns the base Element of this RequestSecurityToken.
        Returns:
        the base Element of this RequestSecurityToken.
      • getBase

        org.w3c.dom.Element getBase​(java.lang.String tokenTypeURI)
        Returns the base Element of this RequestSecurityToken that matches the specified token URI.
        Returns:
        the base Element of this RequestSecurityToken.
      • setBase

        void setBase​(org.w3c.dom.Element value)
        Sets the base Element of this RequestSecurityToken.
        Parameters:
        value - element to be set as the base of this RequestSecurityToken.
      • setBase_0401

        void setBase_0401​(org.w3c.dom.Element value)
        setBase_0401 Use to set the Base token ala the 2004/01 specification. The Base element will be inserted into the RequestSecurityToken. This method is to be used only if the server is a legacy server and does not support the 2005/02 specification.
        Parameters:
        value -
      • getValidateTarget

        org.w3c.dom.Element getValidateTarget()
        Returns the validate target of this RequestSecurityToken as an Element object.
        Returns:
        the validate target of this RequestSecurityToken as an Element object.
      • setValidateTarget

        void setValidateTarget​(org.w3c.dom.Element target)
        Sets the validate target of this RquestSecurityToken based on the target Element provided.
        Parameters:
        target - the element to be set as the validate target.
      • getCancelTarget

        org.w3c.dom.Element getCancelTarget()
        Returns the cancel target of this RequestSecurityToken as an Element object.
        Returns:
        the cancel target of this RequestSecurityToken as an Element object.
      • setCancelTarget

        void setCancelTarget​(org.w3c.dom.Element target)
        Sets the cancel target of this RquestSecurityToken based on the target Element provided.
        Parameters:
        target - the element to be set as the cancel target.
      • getRenewTarget

        org.w3c.dom.Element getRenewTarget()
        Returns the renew target of this RequestSecurityToken as an Element object.
        Returns:
        the renew target of this RequestSecurityToken as an Element object.
      • setRenewTarget

        void setRenewTarget​(org.w3c.dom.Element target)
        Sets the renew target of this RquestSecurityToken based on the target Element provided.
        Parameters:
        target - the element to be set as the renew target.
      • getSecondaryParameters

        org.w3c.dom.Element getSecondaryParameters()
        Returns the secondary parameters of this RequestSecurityToken as an Element object.
        Returns:
        the secondary parameters of this RequestSecurityToken as an Element object.
      • setSecondaryParameters

        void setSecondaryParameters​(org.w3c.dom.Element target)
        Sets the secondary parameters of this RquestSecurityToken based on the target Element provided.
        Parameters:
        target - the element to be set as the secondary parameters.
      • setAuditTrailID

        void setAuditTrailID​(java.lang.String id)
        Sets the auditTrialID This could be automatically determined, however it is not always needed so the caller must explicitly set the ID in order to have it included in the request
        Parameters:
        id - the id as a String object.
      • getAuditTrailID

        java.lang.String getAuditTrailID()
        Gets the auditTrialID This allows for the case where a client may have included the id in the RST
        Returns:
        the auditTrailID of this RequestSecurityToken.