NIST SIP Parser and Stack (v1.2) API

javax.sip.header
Interface ExpiresHeader

All Superinterfaces:
Cloneable, Header, Serializable
All Known Subinterfaces:
MinExpiresHeader
All Known Implementing Classes:
Expires, MinExpires

public interface ExpiresHeader
extends Header

The Expires header field gives the relative time after which the message (or content) expires. The precise meaning of this is method dependent. The expiration time in an INVITE does not affect the duration of the actual session that may result from the invitation. Session description protocols may offer the ability to express time limits on the session duration, however. The value of this field is an integral number of seconds (in decimal) between 0 and (2**32)-1, measured from the receipt of the request. Malformed values SHOULD be treated as equivalent to 3600.

This interface represents the Expires entity-header. The ExpiresHeader is optional in both REGISTER and INVITE Requests.

Example:
Expires: 5

Version:
1.1
Author:
Sun Microsystems

Field Summary
static String NAME
          Name of ExpiresHeader
 
Method Summary
 int getExpires()
          Gets the expires value of the ExpiresHeader.
 void setExpires(int expires)
          Sets the relative expires value of the ExpiresHeader.
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, toString
 

Field Detail

NAME

public static final String NAME
Name of ExpiresHeader

See Also:
Constant Field Values
Method Detail

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.

Parameters:
expires - - the new expires value of this ExpiresHeader
Throws:
InvalidArgumentException - if supplied value is less than zero.
Since:
v1.1

getExpires

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

Returns:
the expires value of the ExpiresHeader.
Since:
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.