gov.nist.javax.sip.header
Class CSeq

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.CSeq

All Implemented Interfaces:

Cloneable, CSeqHeader, Header, Serializable, SIPHeaderNames

public class CSeq

extends SIPHeader

implements CSeqHeader

CSeq SIP Header.

Version:

JAIN-SIP-1.1

Author:

M. Ranganathan NIST/ITL/ANTD
This code is in the public domain.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.sip.header.CSeqHeader

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, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

CSeq()
Constructor.

CSeq(int seqno, String method)
Constructor given the sequence number and method.

Method Summary

String	encode() Return canonical encoded header.
String	encodeBody() Return canonical header content.
boolean	equals(Object other) Compare two cseq headers for equality.
String	getMethod() Get the method.
int	getSequenceNumber() Gets the sequence number of this CSeqHeader.
void	setMethod(String meth) Set the method member
void	setSequenceNumber(int sequenceNumber) Sets the sequence number of this CSeqHeader.

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

getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

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

clone, dbgPrint, debugDump, debugDump, match, merge, replace, replace, replace, replace, toString

Methods inherited from class gov.nist.core.GenericObject

getClassFromName, getMatcher, isMySubclass, match, setMatcher

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Header

clone, getName, toString

Constructor Detail

CSeq

public CSeq()

Constructor.

CSeq

public CSeq(int seqno,
            String method)

Constructor given the sequence number and method.

Parameters:

seqno - is the sequence number to assign.

method - is the method string.

Method Detail

equals

public boolean equals(Object other)

Compare two cseq headers for equality.

Specified by:

equals in interface Header

Overrides:

equals in class SIPObject

Parameters:

other - Object to compare against.

Returns:

true if the two cseq headers are equals, false otherwise.

encode

public String encode()

Return canonical encoded header.

Overrides:

encode in class SIPHeader

Returns:

String with canonical encoded header.

encodeBody

public String encodeBody()

Return canonical header content. (encoded header except headerName:)

Returns:

encoded string.

getMethod

public String getMethod()

Get the method.

Specified by:

getMethod in interface CSeqHeader

Returns:

String the method.

setSequenceNumber

public void setSequenceNumber(int sequenceNumber)
                       throws InvalidArgumentException

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

Specified by:

setSequenceNumber in interface CSeqHeader

Parameters:

sequenceNumber - - the sequence number to set.

Throws:

InvalidArgumentException - -- if the seq number is <= 0

setMethod

public void setMethod(String meth)
               throws ParseException

Set the method member

Specified by:

setMethod in interface CSeqHeader

Parameters:

meth - -- String to set

Throws:

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

getSequenceNumber

public int getSequenceNumber()

Gets the sequence number of this CSeqHeader.

Specified by:

getSequenceNumber in interface CSeqHeader

Returns:

sequence number of the CSeqHeader