xpertss.sdp.Origin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdp Show documentation
Session Description Protocol implementation
The newest version!
/*
 * Origin.java
 *
 * Created on December 20, 2001, 2:30 PM
 */

package xpertss.sdp;


import xpertss.lang.Numbers;
import xpertss.lang.Objects;
import xpertss.lang.Strings;

/**
 * An Origin represents the o= fields contained within a SessionDescription and
 * identifies the originator of the session.
 * 
 * {@code
 *    o=     
 * }

 * This is not necessarily the same entity who is involved in the session.
 * 

 * The Origin contains:
 * 

 *    the name of the user originating the session,
 *    a unique session identifier, and
 *    a unique version for the session.
 * 

 * These fields should uniquely identify the session.
 * 

 * The Origin also includes:
 * 

 *    the network type,
 *    address type, and
 *    address of the originator.
 * 
 * Please refer to IETF RFC 4566 for a description of SDP.
 *
 * @version 1.0
 */
public final class Origin extends Field {

   private String username;
   private String address;
   private String addressType;
   private String networkType;
   private String sessionId;
   private long version;


   Origin(String username, String sessionId, long version, String address, String addressType, String networkType)
   {
      this.username = Strings.notEmpty(Strings.trim(username), "username may not be empty");
      this.sessionId = Strings.notEmpty(Strings.trim(sessionId), "sessionId may not be empty");
      this.address = Strings.notEmpty(Strings.trim(address), "address may not be empty");
      this.addressType = Strings.notEmpty(Strings.trim(addressType), "addressType may not be empty");
      this.networkType = Strings.notEmpty(Strings.trim(networkType), "networkType may not be empty");

      this.version = Numbers.gte(0L, version, "session version must not be negative");
   }

   /**
    * Returns the name of the session originator.
    */
   public String getUsername()
   {
      return username;
   }

   /**
    * Returns the unique identity of the session.
    */
   public String getSessionId()
   {
      return sessionId;
   }

   /**
    * Returns the unique version of the session.
    */
   public long getSessionVersion()
   {
      return version;
   }

   /**
    * Returns the address for this session.
    */
   public String getAddress()
   {
      return address;
   }

   /**
    * Returns the type of the address for this Connection.
    *
    * @see SdpConstants#ADDRESS_TYPE_IP4
    * @see SdpConstants#ADDRESS_TYPE_IP6
    */
   public String getAddressType()
   {
      return addressType;
   }

   /**
    * Returns the type of the network for this Connection
    *
    * @see SdpConstants#NETWORK_TYPE_INTERNET
    */
   public String getNetworkType()
   {
      return networkType;
   }


   @Override
   public char getTypeChar()
   {
      return 'o';
   }

   @Override
   public Origin clone() {
      try {
         return (Origin) super.clone();
      } catch(CloneNotSupportedException e) {
         throw new Error(e);
      }
   }


   @Override
   public int hashCode()
   {
      return Objects.hash(username, sessionId, version, address, addressType, networkType);
   }

   @Override
   public boolean equals(Object obj)
   {
      if(obj instanceof Origin) {
         Origin o = (Origin) obj;
         return Objects.equal(o.getUsername(), username) &&
               Objects.equal(o.getSessionId(), sessionId) &&
               Objects.equal(o.getSessionVersion(), version) &&
               Objects.equal(o.getAddress(), address) &&
               Objects.equal(o.getAddressType(), addressType) &&
               Objects.equal(o.getNetworkType(), networkType);
      }
      return false;
   }



   @Override
   public String toString()
   {
      StringBuilder buf = new StringBuilder();
      buf.append(getTypeChar()).append("=").append(username).append(" ");
      buf.append(sessionId).append(" ").append(version).append(" ");
      buf.append(networkType).append(" ").append(addressType).append(" ");
      buf.append(address);
      return buf.toString();
   }
}