JAIN-SIP 2.0 API

javax.sip.header
Interface SessionExpiresHeader

All Superinterfaces:
Cloneable, ExtensionHeader, Header, Parameters, Serializable

public interface SessionExpiresHeader
extends Parameters, Header, ExtensionHeader

Header interface for the Sesison-Expires SIP header as defined in RFF 4028. The Session-Expires header field establishes the upper bound for the session refresh interval; i.e., the time period after processing a request for which any session-stateful proxy must retain its state for this session. Any proxy servicing this request can lower this value, but it is not allowed to decrease it below the value specified in the Min-SE header field.

Since:
2.0
Version:
2.0
See Also:
MinSEHeader

Field Summary
static String NAME
           
static String REFRESHER_UAC
           
static String REFRESHER_UAS
           
 
Method Summary
 int getExpires()
          Get the expires parameter.
 String getRefresher()
          Get the Refresher.
 void setExpires(int expires)
          Set the expires parameter.
 void setRefresher(String refresher)
          Set the Refresher parameter.
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.ExtensionHeader
getValue, setValue
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Field Detail

REFRESHER_UAS

static final String REFRESHER_UAS
See Also:
Constant Field Values

REFRESHER_UAC

static final String REFRESHER_UAC
See Also:
Constant Field Values

NAME

static final String NAME
See Also:
Constant Field Values
Method Detail

getExpires

int getExpires()
Get the expires parameter.

Returns:
the expires parameter.

setExpires

void setExpires(int expires)
                throws InvalidArgumentException
Set the expires parameter.

Parameters:
expires - - the expires parameter to set.
Throws:
InvalidArgumentException

getRefresher

String getRefresher()
Get the Refresher.

Returns:
the Refresher

setRefresher

void setRefresher(String refresher)
                  throws ParseException
Set the Refresher parameter.

Parameters:
refresher - - the Refresher to set. Must be "uas" or "uac".
Throws:
ParseException

JAIN-SIP 2.0 API


See conditions of use.
Submit a bug report or feature request.