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.*; 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.text.ParseException; 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding SIP (HTTP) Header. 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author M. Ranganathan 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author Olivier Deruelle <br/> 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:24 $ 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @since 1.1 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * <pre> 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * From HTTP RFC 2616 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * The Accept-Encoding request-header field is similar to Accept, but 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * restricts the content-codings (section 3.5) that are acceptable in 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * the response. 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding = "Accept-Encoding" ":" 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 1#( codings [ ";" "q" "=" qvalue ] ) 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * codings = ( content-coding | "*" ) 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Examples of its use are: 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding: compress, gzip 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding: 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding: * 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding: compress;q=0.5, gzip;q=1.0 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * </pre> 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic final class AcceptEncoding extends ParametersHeader implements 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang AcceptEncodingHeader { 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Comment for <code>serialVersionUID</code> 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = -1476807565552873525L; 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * contentEncoding field 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String contentCoding; 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * default constructor 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public AcceptEncoding() { 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(NAME); 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Encode the value of this header. 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the value of this header encoded into a string. 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String encodeBody() { 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encode(new StringBuffer()).toString(); 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected StringBuffer encodeBody(StringBuffer buffer) { 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (contentCoding != null) { 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(contentCoding); 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (parameters != null && !parameters.isEmpty()) { 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(SEMICOLON).append(parameters.encode()); 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * get QValue field 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return float 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public float getQValue() { 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return getParameterAsFloat("q"); 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * get ContentEncoding field 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getEncoding() { 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return contentCoding; 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Set the qvalue member 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param q 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * double to set 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setQValue(float q) throws InvalidArgumentException { 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (q < 0.0 || q > 1.0) 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new InvalidArgumentException("qvalue out of range!"); 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super.setParameter("q", q); 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the encoding of an EncodingHeader. 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param encoding - 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * the new string value defining the encoding. 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws ParseException 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * which signals that an error has been reached unexpectedly 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * while parsing the encoding value. 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 147600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setEncoding(String encoding) throws ParseException { 148600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (encoding == null) 149600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new NullPointerException(" encoding parameter is null"); 150600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang contentCoding = encoding; 151600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 152600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 153600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 154