NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class Expires

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
                    |
                    +--gov.nist.javax.sip.header.Expires
All Implemented Interfaces:
Cloneable, ExpiresHeader, Header, Serializable, SIPHeaderNames

public class Expires
extends SIPHeader
implements ExpiresHeader

Expires SIP Header.

Version:
JAIN-SIP-1.1
Author:
M. Ranganathan
This code is in the public domain.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.ExpiresHeader
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
Expires()
          default constructor
 
Method Summary
 String encodeBody()
          Return canonical form.
 int getExpires()
          Gets the expires value of the ExpiresHeader.
 void setExpires(int expires)
          Sets the relative expires value of the ExpiresHeader.
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, setMatcher
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, toString
 

Constructor Detail

Expires

public Expires()
default constructor

Method Detail

encodeBody

public String encodeBody()
Return canonical form.

Overrides:
encodeBody in class SIPHeader
Returns:
String

getExpires

public int getExpires()
Gets the expires value of the ExpiresHeader. This expires value is relative time.

Specified by:
getExpires in interface ExpiresHeader
Returns:
the expires value of the ExpiresHeader.
Since:
JAIN SIP v1.1

setExpires

public void setExpires(int expires)
                throws InvalidArgumentException
Sets the relative expires value of the ExpiresHeader. The expires value MUST be greater than zero and MUST be less than 2**31.

Specified by:
setExpires in interface ExpiresHeader
Parameters:
expires - - the new expires value of this ExpiresHeader
Throws:
InvalidArgumentException - if supplied value is less than zero.
Since:
JAIN SIP v1.1

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.