com.opencloud.javax.sip.sessiontimer

Interface SessionExpiresHeader

All Superinterfaces:

Cloneable, Header, Parameters, Serializable

public interface SessionExpiresHeader
extends Header, Parameters

Session-Expires header from the Session Timers Draft RFC.
The Session-Expires header field conveys the session interval for a SIP session. It is placed only in INVITE or UPDATE requests, as well as in any 2xx response to an INVITE or UPDATE. Like the SIP Expires header field, it contains a delta-time.

The syntax of the Session-Expires header field is:

  Session-Expires  = ('Session-Expires' / 'x') HCOLON delta-seconds
                       *(SEMI se-params)
  se-params        = refresher-param / generic-param
  refresher-param  = 'refresher' EQUAL  ('uas' / 'uac')
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPACT_NAME
static String	NAME

Method Summary

Methods

Modifier and Type	Method and Description
int	getInterval() Gets the session refresh interval requested by this Session-Expires header.
SessionRefresher	getRefresher() Get the refresher parameter, which determines the party responsible for sending session refresh requests (none, uac or uas).
void	setInterval(int interval) Set the session refresh interval time.
void	setRefresher(SessionRefresher refresher) Set the refresher for this session.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

COMPACT_NAME

static final String COMPACT_NAME

See Also:

Constant Field Values

Method Detail

getInterval

int getInterval()

Gets the session refresh interval requested by this Session-Expires header.

Returns:

the session refresh interval, in seconds.

setInterval

void setInterval(int interval)
                 throws IllegalArgumentException

Set the session refresh interval time.

Parameters:

interval - the requested session refresh interval.

Throws:

IllegalArgumentException - if interval is less than 90 seconds, the minimum refresh interval permitted by the spec.

getRefresher

SessionRefresher getRefresher()

Get the refresher parameter, which determines the party responsible for sending session refresh requests (none, uac or uas).

Returns:

the value of the refresher parameter, which will be either SessionRefresher.UAC, SessionRefresher.UAS or SessionRefresher.NONE (no refresher specified).

setRefresher

void setRefresher(SessionRefresher refresher)

Set the refresher for this session.

Parameters:

refresher - the party who will perform session refresh requests for the session, either SessionRefresher.UAC, SessionRefresher.UAS or SessionRefresher.NONE (no refresher specified).