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 * Acknowledgement -- Lamine Brahimi 28600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Submitted a bug fix for a this class. 29600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 30600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/******************************************************************************* 31600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Product of NIST/ITL Advanced Networking Technologies Division (ANTD). * 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang *******************************************************************************/ 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpackage gov.nist.javax.sip.address; 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * User information part of a URL. 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:23 $ 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author M. Ranganathan <br/> 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic final class UserInfo extends NetObject { 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = 7268593273924256144L; 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** user field 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String user; 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** password field 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String password; 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** userType field 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected int userType; 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** Constant field 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public final static int TELEPHONE_SUBSCRIBER = 1; 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** constant field 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public final static int USER = 2; 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** Default constructor 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public UserInfo() { 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(); 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Compare for equality. 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param obj Object to set 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return true if the two headers are equals, false otherwise. 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public boolean equals(Object obj) { 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (getClass() != obj.getClass()) { 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang UserInfo other = (UserInfo) obj; 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.userType != other.userType) { 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (!this.user.equalsIgnoreCase(other.user)) { 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.password != null && other.password == null) 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (other.password != null && this.password == null) 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.password == other.password) 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return true; 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return (this.password.equals(other.password)); 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Encode the user information as a string. 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String encode() { 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encode(new StringBuffer()).toString(); 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public StringBuffer encode(StringBuffer buffer) { 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (password != null) 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(user).append(COLON).append(password); 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang else 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(user); 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** Clear the password field. 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void clearPassword() { 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.password = null; 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the user type (which can be set to TELEPHONE_SUBSCRIBER or USER) 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the type of user. 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public int getUserType() { 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return userType; 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** get the user field. 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getUser() { 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return user; 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** get the password field. 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getPassword() { 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return password; 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 147600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the user member 148600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param user String to set 149600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 150600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setUser(String user) { 151600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.user = user; 152600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // BUG Fix submitted by Lamine Brahimi 153600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // add this (taken form sip_messageParser) 154600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // otherwise comparison of two SipUrl will fail because this 155600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // parameter is not set (whereas it is set in sip_messageParser). 156600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (user != null 157600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang && (user.indexOf(POUND) >= 0 || user.indexOf(SEMICOLON) >= 0)) { 158600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setUserType(TELEPHONE_SUBSCRIBER); 159600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } else { 160600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setUserType(USER); 161600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 162600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 163600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 164600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 165600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the password member 166600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param p String to set 167600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 168600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setPassword(String p) { 169600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang password = p; 170600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 171600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 172600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 173600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the user type (to TELEPHONE_SUBSCRIBER or USER). 174600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param type int to set 175600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws IllegalArgumentException if type is not in range. 176600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 177600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setUserType(int type) throws IllegalArgumentException { 178600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (type != TELEPHONE_SUBSCRIBER && type != USER) { 179600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new IllegalArgumentException("Parameter not in range"); 180600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 181600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang userType = type; 182600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 183600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 184