1600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/* 2600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Conditions Of Use 3600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 4600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software was developed by employees of the National Institute of 5600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Standards and Technology (NIST), an agency of the Federal Government. 6600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Pursuant to title 15 Untied States Code Section 105, works of NIST 7600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* employees are not subject to copyright protection in the United States 8600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* and are considered to be in the public domain. As a result, a formal 9600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* license is not needed to use the software. 10600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 11600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software is provided by NIST as a service and is expressly 12600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED 13600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF 14600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT 15600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* AND DATA ACCURACY. NIST does not warrant or make any representations 16600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* regarding the use of the software or the results thereof, including but 17600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* not limited to the correctness, accuracy, reliability or usefulness of 18600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* the software. 19600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 20600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Permission to use this software is contingent upon your acceptance 21600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* of the terms of this agreement 22600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 23600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* . 24600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 25600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*/ 26600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/******************************************************************************* 27600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). * 28600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*******************************************************************************/ 29600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpackage gov.nist.javax.sip.header; 30600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 31600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * The call identifer that goes into a callID header and a in-reply-to header. 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author M. Ranganathan <br/> 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.7 $ $Date: 2009/12/16 02:38:35 $ 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @see CallID 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @see InReplyTo 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @since 1.1 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic final class CallIdentifier extends SIPObject { 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Comment for <code>serialVersionUID</code> 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = 7314773655675451377L; 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * localId field 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String localId; 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * host field 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String host; 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Default constructor 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public CallIdentifier() { 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Constructor 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param localId id is the local id. 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param host is the host. 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public CallIdentifier(String localId, String host) { 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.localId = localId; 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.host = host; 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * constructor 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param cid String to set 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws IllegalArgumentException if cid is null or is not a token, 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * or token@token 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public CallIdentifier(String cid) throws IllegalArgumentException { 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setCallID(cid); 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Get the encoded version of this id. 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String to set 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String encode() { 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encode(new StringBuffer()).toString(); 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public StringBuffer encode(StringBuffer buffer) { 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(localId); 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (host != null) { 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(AT).append(host); 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Compare two call identifiers for equality. 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param other Object to set 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return true if the two call identifiers are equals, false 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * otherwise 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public boolean equals(Object other) { 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (other == null ) return false; 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (!other.getClass().equals(this.getClass())) { 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang CallIdentifier that = (CallIdentifier) other; 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.localId.compareTo(that.localId) != 0) { 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.host == that.host) 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return true; 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if ((this.host == null && that.host != null) 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang || (this.host != null && that.host == null)) 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (host.compareToIgnoreCase(that.host) != 0) { 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return true; 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang @Override 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public int hashCode() { 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.localId == null ) { 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new UnsupportedOperationException("Hash code called before id is set"); 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return this.localId.hashCode(); 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** get the LocalId field 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getLocalId() { 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return localId; 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** get the host field 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return host member String 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getHost() { 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return host; 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 147600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 148600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the localId member 149600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param localId String to set 150600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 151600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setLocalId(String localId) { 152600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.localId = localId; 153600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 154600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 155600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** set the callId field 156600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param cid Strimg to set 157600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws IllegalArgumentException if cid is null or is not a token or 158600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * token@token 159600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 160600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setCallID(String cid) throws IllegalArgumentException { 161600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (cid == null) 162600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new IllegalArgumentException("NULL!"); 163600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang int index = cid.indexOf('@'); 164600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (index == -1) { 165600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang localId = cid; 166600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang host = null; 167600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } else { 168600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang localId = cid.substring(0, index); 169600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang host = cid.substring(index + 1, cid.length()); 170600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (localId == null || host == null) { 171600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new IllegalArgumentException("CallID must be token@token or token"); 172600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 173600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 174600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 175600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 176600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 177600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the host member 178600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param host String to set 179600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 180600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setHost(String host) { 181600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.host = host; 182600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 183600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 184