Interface PrivacyHeader

  • All Superinterfaces:
    Cloneable, javax.sip.header.Header, Serializable

    public interface PrivacyHeader
    extends javax.sip.header.Header
    RFC 3323 Privacy header.

     Privacy-hdr  =  "Privacy" HCOLON priv-value *(";" priv-value)
       priv-value   =   "header" / "session" / "user" / "none" / "critical"
                        / token
     
    • Method Detail

      • isNoPrivacyRequested

        boolean isNoPrivacyRequested()
        Determine if privacy value "none" has been requested.
      • isHeaderPrivacyRequested

        boolean isHeaderPrivacyRequested()
        Determine if privacy value "header" has been requested.
      • isSessionPrivacyRequested

        boolean isSessionPrivacyRequested()
        Determine if privacy value "session" has been requested.
      • isUserPrivacyRequested

        boolean isUserPrivacyRequested()
        Determine if privacy value "user" has been requested.
      • isCriticalPrivacyRequested

        boolean isCriticalPrivacyRequested()
        Determine if privacy value "critical" has been requested.
      • isIDPrivacyRequested

        boolean isIDPrivacyRequested()
        Determine if privacy value "id" has been requested (RFC 3325).
      • isPrivacyRequested

        boolean isPrivacyRequested​(String value)
        Determine if the particular privacy value has been requested.
        Returns:
        true if the value has been set in the header, false otherwise.
      • setPrivacyValue

        void setPrivacyValue​(String value)
        Reset the privacy value to a new value, erasing all current values
      • addPrivacyValue

        void addPrivacyValue​(String value)
        Add another privacy value to the header. If the current privacy value is "none", this method throws an IllegalArgumentException
      • removePrivacyValue

        void removePrivacyValue​(String value)
        Remove the privacy value from the header. If the value is not present, the method returns silently.
      • getPrivacyValues

        Iterator getPrivacyValues()
        Convenience method to get all the privacy values currently set in this header.
        Returns:
        an immutable Iterator of Strings.