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 Wangimport gov.nist.core.HostPort; 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport gov.nist.javax.sip.address.AddressImpl; 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport gov.nist.javax.sip.parser.Parser; 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport javax.sip.header.ToHeader; 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.text.ParseException; 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * To SIP Header. 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.11 $ $Date: 2009/07/17 18:57:39 $ 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author M. Ranganathan <br/> 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author Olivier Deruelle <br/> 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic final class To extends AddressParametersHeader implements 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang javax.sip.header.ToHeader { 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Comment for <code>serialVersionUID</code> 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = -4057413800584586316L; 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * default Constructor. 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public To() { 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(TO,true); 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Generate a TO header from a FROM header 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public To(From from) { 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(TO); 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setAddress(from.address); 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setParameters(from.parameters); 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Encode the header into a String. 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @since 1.0 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String encode() { 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return headerName + COLON + SP + encodeBody() + NEWLINE; 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Encode the header content into a String. 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String encodeBody() { 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encodeBody(new StringBuffer()).toString(); 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected StringBuffer encodeBody(StringBuffer buffer) { 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address != null) { 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) { 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(LESS_THAN); 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang address.encode(buffer); 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) { 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(GREATER_THAN); 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (!parameters.isEmpty()) { 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(SEMICOLON); 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang parameters.encode(buffer); 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Conveniance accessor function to get the hostPort field from the address. 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Warning -- this assumes that the embedded URI is a SipURL. 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return hostport field 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public HostPort getHostPort() { 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address == null) 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return null; 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return address.getHostPort(); 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Get the display name from the address. 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return Display name 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getDisplayName() { 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address == null) 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return null; 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return address.getDisplayName(); 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Get the tag parameter from the address parm list. 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return tag field 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getTag() { 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (parameters == null) 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return null; 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return getParameter(ParameterNames.TAG); 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 147600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Boolean function 148600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 149600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return true if the Tag exist 150600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 151600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public boolean hasTag() { 152600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (parameters == null) 153600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 154600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return hasParameter(ParameterNames.TAG); 155600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 156600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 157600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 158600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 159600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * remove Tag member 160600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 161600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void removeTag() { 162600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (parameters != null) 163600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang parameters.delete(ParameterNames.TAG); 164600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 165600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 166600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 167600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 168600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the tag member. This should remain empty for the initial request in 169600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * a dialog. 170600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 171600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param t - tag String to set. 172600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 173600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setTag(String t) throws ParseException { 174600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // JvB: check that it is a valid token 175600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang Parser.checkToken(t); 176600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.setParameter(ParameterNames.TAG, t); 177600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 178600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 179600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 180600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Get the user@host port string. 181600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 182600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getUserAtHostPort() { 183600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (address == null) 184600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return null; 185600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return address.getUserAtHostPort(); 186600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 187600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 188600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public boolean equals(Object other) { 189600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return (other instanceof ToHeader) && super.equals(other); 190600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 191600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 192