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 javax.sip.InvalidArgumentException; 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport javax.sip.header.SubscriptionStateHeader; 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.text.ParseException; 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang *SubscriptionState header 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:39 $ 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author Olivier Deruelle <br/> 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic class SubscriptionState 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang extends ParametersHeader 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang implements SubscriptionStateHeader { 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Comment for <code>serialVersionUID</code> 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = -6673833053927258745L; 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected int expires; 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected int retryAfter; 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String reasonCode; 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String state; 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** Creates a new instance of SubscriptionState */ 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public SubscriptionState() { 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(SIPHeaderNames.SUBSCRIPTION_STATE); 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang expires = -1; 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang retryAfter = -1; 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the relative expires value of the SubscriptionStateHeader. The 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * expires value MUST be greater than zero and MUST be less than 2**31. 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param expires - the new expires value of this SubscriptionStateHeader. 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws InvalidArgumentException if supplied value is less than zero. 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setExpires(int expires) throws InvalidArgumentException { 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (expires < 0) 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new InvalidArgumentException( 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "JAIN-SIP " 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang + "Exception, SubscriptionState, setExpires(), the expires parameter is < 0"); 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.expires = expires; 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the expires value of the SubscriptionStateHeader. This expires value is 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * relative time. 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the expires value of the SubscriptionStateHeader. 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public int getExpires() { 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return expires; 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the retry after value of the SubscriptionStateHeader. The retry after value 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * MUST be greater than zero and MUST be less than 2**31. 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param retryAfter - the new retry after value of this SubscriptionStateHeader 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws InvalidArgumentException if supplied value is less than zero. 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setRetryAfter(int retryAfter) throws InvalidArgumentException { 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (retryAfter <= 0) 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new InvalidArgumentException( 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "JAIN-SIP " 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang + "Exception, SubscriptionState, setRetryAfter(), the retryAfter parameter is <=0"); 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.retryAfter = retryAfter; 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the retry after value of the SubscriptionStateHeader. This retry after 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * value is relative time. 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the retry after value of the SubscriptionStateHeader. 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public int getRetryAfter() { 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return retryAfter; 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the reason code of SubscriptionStateHeader. 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the comment of this SubscriptionStateHeader, return null if no reason code 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * is available. 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getReasonCode() { 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return reasonCode; 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the reason code value of the SubscriptionStateHeader. 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param reasonCode - the new reason code string value of the SubscriptionStateHeader. 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws ParseException which signals that an error has been reached 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * unexpectedly while parsing the reason code. 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setReasonCode(String reasonCode) throws ParseException { 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (reasonCode == null) 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new NullPointerException( 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "JAIN-SIP " 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang + "Exception, SubscriptionState, setReasonCode(), the reasonCode parameter is null"); 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.reasonCode = reasonCode; 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the state of SubscriptionStateHeader. 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the state of this SubscriptionStateHeader. 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getState() { 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return state; 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 147600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 148600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 149600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the state value of the SubscriptionStateHeader. 150600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 151600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param state - the new state string value of the SubscriptionStateHeader. 152600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws ParseException which signals that an error has been reached 153600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * unexpectedly while parsing the state. 154600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 155600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setState(String state) throws ParseException { 156600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (state == null) 157600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new NullPointerException( 158600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "JAIN-SIP " 159600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang + "Exception, SubscriptionState, setState(), the state parameter is null"); 160600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.state = state; 161600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 162600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 163600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** Just the encoded body of the header. 164600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the string encoded header body. 165600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 166600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String encodeBody() { 167600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encodeBody(new StringBuffer()).toString(); 168600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 169600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 170600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected StringBuffer encodeBody(StringBuffer buffer) { 171600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (state != null) 172600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(state); 173600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (reasonCode != null) 174600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(";reason=").append(reasonCode); 175600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (expires != -1) 176600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(";expires=").append(expires); 177600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (retryAfter != -1) 178600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(";retry-after=").append(retryAfter); 179600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 180600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (!parameters.isEmpty()) { 181600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(SEMICOLON); 182600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang parameters.encode(buffer); 183600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 184600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 185600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 186600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 187600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 188