gov.nist.javax.sip.header

Class AcceptEncoding

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.ParametersHeader

gov.nist.javax.sip.header.AcceptEncoding

All Implemented Interfaces:

HeaderExt, ParametersExt, SIPHeaderNames, Serializable, Cloneable, AcceptEncodingHeader, Encoding, Header, Parameters

public final class AcceptEncoding
extends ParametersHeader
implements AcceptEncodingHeader

Accept-Encoding SIP (HTTP) Header.

Since:

1.1

  From HTTP RFC 2616


    The Accept-Encoding request-header field is similar to Accept, but
    restricts the content-codings (section 3.5) that are acceptable in
    the response.


        Accept-Encoding  = "Accept-Encoding" ":"


                           1#( codings [ ";" "q" "=" qvalue ] )
        codings          = ( content-coding | "*" )

    Examples of its use are:

        Accept-Encoding: compress, gzip
        Accept-Encoding:
        Accept-Encoding: *
        Accept-Encoding: compress;q=0.5, gzip;q=1.0
        Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
 

Version:

1.2 $Revision: 1.8 $ $Date: 2010-05-06 14:07:54 $

Author:

M. Ranganathan, Olivier Deruelle

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	contentCoding contentEncoding field

Fields inherited from class gov.nist.javax.sip.header.ParametersHeader

duplicates, parameters

Fields inherited from class gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface javax.sip.header.AcceptEncodingHeader

NAME

Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
AcceptEncoding() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected String	encodeBody() Encode the value of this header.
protected StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
String	getEncoding() get ContentEncoding field
float	getQValue() get QValue field
void	setEncoding(String encoding) Sets the encoding of an EncodingHeader.
void	setQValue(float q) Set the qvalue member

Methods inherited from class gov.nist.javax.sip.header.ParametersHeader

clone, equalParameters, getMultiParameter, getMultiParameterNames, getMultiParameters, getMultiParameterValue, getNameValue, getParameter, getParameter, getParameterAsBoolean, getParameterAsFloat, getParameterAsHexInt, getParameterAsInt, getParameterAsLong, getParameterAsURI, getParameterNames, getParameters, getParameterValue, hasMultiParameter, hasMultiParameters, hasParameter, hasParameters, removeMultiParameter, removeMultiParameters, removeParameter, removeParameters, setMultiParameter, setMultiParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameters, setQuotedParameter

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

encode, encode, getHeaderName, getHeaderValue, getName, getValue, hashCode, isHeaderList, setHeaderName, toString

Methods inherited from class gov.nist.javax.sip.header.SIPObject

dbgPrint, debugDump, debugDump, equals, match

Methods inherited from class gov.nist.core.GenericObject

dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

contentCoding

protected String contentCoding

contentEncoding field

Constructor Detail

AcceptEncoding

public AcceptEncoding()

default constructor

Method Detail

encodeBody

protected String encodeBody()

Encode the value of this header.

Returns:

the value of this header encoded into a string.

encodeBody

protected StringBuilder encodeBody(StringBuilder buffer)

Description copied from class: SIPHeader

Encode the body of this header (the stuff that follows headerName). A.K.A headerValue.

Specified by:

encodeBody in class ParametersHeader

getQValue

public float getQValue()

get QValue field

Specified by:

getQValue in interface AcceptEncodingHeader

Returns:

float

getEncoding

public String getEncoding()

get ContentEncoding field

Specified by:

getEncoding in interface Encoding

Returns:

String

setQValue

public void setQValue(float q)
               throws InvalidArgumentException

Set the qvalue member

Specified by:

setQValue in interface AcceptEncodingHeader

Parameters:

q - double to set

Throws:

InvalidArgumentException - if the q parameter value is not -1 or between 0 and 1.

setEncoding

public void setEncoding(String encoding)
                 throws ParseException

Sets the encoding of an EncodingHeader.

Specified by:

setEncoding in interface Encoding

Parameters:

encoding - - the new string value defining the encoding.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the encoding value.