gov.nist.javax.sip.header

Class RAck

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.RAck

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, RAckHeader

public class RAck
extends SIPHeader
implements RAckHeader

RAck SIP Header implementation

Version:

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

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cSeqNumber
protected String	method
protected long	rSeqNumber

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.RAckHeader

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
RAck() Creates a new instance of RAck

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
int	getCSeqNumber() Deprecated.
long	getCSeqNumberLong() Gets the CSeq sequence number of this RAckHeader.
long	getCSequenceNumber()
String	getMethod() Gets the method of RAckHeader
int	getRSeqNumber() Deprecated.
long	getRSequenceNumber()
void	setCSeqNumber(int cSeqNumber) Deprecated.
void	setCSequenceNumber(long cSeqNumber)
void	setMethod(String method) Sets the method of RAckHeader, which correlates to the method of the CSeqHeader of the provisional response being acknowledged.
void	setRSeqNumber(int rSeqNumber) Deprecated.
void	setRSequenceNumber(long rSeqNumber)

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

cSeqNumber

protected long cSeqNumber

rSeqNumber

protected long rSeqNumber

method

protected String method

Constructor Detail

RAck

public RAck()

Creates a new instance of RAck

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder buffer)

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

Specified by:

encodeBody in class SIPHeader

getCSeqNumber

public int getCSeqNumber()

Deprecated.

Gets the CSeq sequence number of this RAckHeader.

Specified by:

getCSeqNumber in interface RAckHeader

Returns:

the integer value of the cSeq number of the RAckHeader

getCSeqNumberLong

public long getCSeqNumberLong()

Gets the CSeq sequence number of this RAckHeader.

Returns:

the integer value of the cSeq number of the RAckHeader

getMethod

public String getMethod()

Gets the method of RAckHeader

Specified by:

getMethod in interface RAckHeader

Returns:

method of RAckHeader

getRSeqNumber

public int getRSeqNumber()

Deprecated.

Gets the RSeq sequence number of this RAckHeader.

Specified by:

getRSeqNumber in interface RAckHeader

Returns:

the integer value of the RSeq number of the RAckHeader

setCSeqNumber

public void setCSeqNumber(int cSeqNumber)
                   throws InvalidArgumentException

Deprecated.

Description copied from interface: RAckHeader

Sets the sequence number value of the CSeqHeader of the provisional response being acknowledged. The sequence number MUST be expressible as a 32-bit unsigned integer and MUST be less than 2**31.

Specified by:

setCSeqNumber in interface RAckHeader

Parameters:

cSeqNumber - - the new cSeq number of this RAckHeader.

Throws:

InvalidArgumentException - if supplied value is less than zero.

See Also:

RAckHeader.setCSeqNumber(int)

setMethod

public void setMethod(String method)
               throws ParseException

Description copied from interface: RAckHeader

Sets the method of RAckHeader, which correlates to the method of the CSeqHeader of the provisional response being acknowledged.

Specified by:

setMethod in interface RAckHeader

Parameters:

method - - the new string value of the method of the RAckHeader

Throws:

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

getCSequenceNumber

public long getCSequenceNumber()

getRSequenceNumber

public long getRSequenceNumber()

setCSequenceNumber

public void setCSequenceNumber(long cSeqNumber)
                        throws InvalidArgumentException

Throws:

InvalidArgumentException

setRSeqNumber

public void setRSeqNumber(int rSeqNumber)
                   throws InvalidArgumentException

Deprecated.

Description copied from interface: RAckHeader

Sets the sequence number value of the RSeqHeader of the provisional response being acknowledged. The sequence number MUST be expressible as a 32-bit unsigned integer and MUST be less than 2**31.

Specified by:

setRSeqNumber in interface RAckHeader

Parameters:

rSeqNumber - - the new rSeq number of this RAckHeader.

Throws:

InvalidArgumentException - if supplied value is less than zero.

See Also:

RAckHeader.setRSeqNumber(int)

setRSequenceNumber

public void setRSequenceNumber(long rSeqNumber)
                        throws InvalidArgumentException

Throws:

InvalidArgumentException