Package 

Class UsernameAttribute

  • All Implemented Interfaces:

    
    public class UsernameAttribute
    extends Attribute
                        

    The USERNAME attribute is used for message integrity. The value of USERNAME is a variable length value.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final static String NAME
      private Array<byte> username
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      Array<byte> getUsername() Returns a (cloned) byte array containing the data value of the username attribute.
      void setUsername(Array<byte> username) Copies the specified binary array into the the data value of the username attribute.
      Array<byte> encode() Returns a binary representation of this attribute.
      char getDataLength() Returns the length of this attribute's body.
      String getName() Returns the human readable name of this attribute.
      boolean equals(Object obj) Compares two STUN Attributes.
      • Methods inherited from class org.ice4j.attribute.Attribute

        getAttributeType, getLocationInMessage, setLocationInMessage
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getUsername

         Array<byte> getUsername()

        Returns a (cloned) byte array containing the data value of the username attribute.

      • setUsername

         void setUsername(Array<byte> username)

        Copies the specified binary array into the the data value of the username attribute.

        Parameters:
        username - the binary array containing the username.
      • encode

         Array<byte> encode()

        Returns a binary representation of this attribute.

      • getDataLength

         char getDataLength()

        Returns the length of this attribute's body.

      • getName

         String getName()

        Returns the human readable name of this attribute.

      • equals

         boolean equals(Object obj)

        Compares two STUN Attributes. Two attributes are considered equal when they have the same type length and value.

        Parameters:
        obj - the object to compare this attribute with.