javax.servlet.sip

Interface SessionKeepAlive.Preference

Enclosing interface:

SessionKeepAlive

public static interface SessionKeepAlive.Preference

Holds the preference data in the SIP message headers.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getEnabled() Return whether session keep alive is enabled or not.
int	getExpiration() Return the session expiration in seconds.
int	getMinimumExpiration() Return Minimum expiration time in seconds.
SessionKeepAlive.Refresher	getRefresher() Return the type of the refresher.
void	setEnabled(boolean enabled) Sets whether the session keep-alive is enabled or not.
void	setExpiration(int expiration) Set the session expiration.
void	setMinimumExpiration(int minSE) Minimum expiration possible.
void	setRefresher(SessionKeepAlive.Refresher refresher) Set the refresher type.

Method Detail

setRefresher

void setRefresher(SessionKeepAlive.Refresher refresher)

Set the refresher type. This maps to the refresher parameter in Session-Expires header.

Parameters:

refresher - Type of the refresher.

Throws:

IllegalArgumentException - If the argument conflicts with the rules specified by RFC 4028.

IllegalStateException - If session keep alive is not enabled.

getRefresher

SessionKeepAlive.Refresher getRefresher()

Return the type of the refresher. This maps to the refresher parameter in Session-Expires header.

Returns:

Type of refresher.

setMinimumExpiration

void setMinimumExpiration(int minSE)

Minimum expiration possible. This maps to Min-SE header.

Parameters:

minSE - Minimim session expiration time in seconds.

Throws:

IllegalArgumentException - If the argument conflicts with the rules specified by RFC 4028.

IllegalStateException - If session keep alive is not enabled.

getMinimumExpiration

int getMinimumExpiration()

Return Minimum expiration time in seconds. This maps to Min-SE header.

Returns:

Minimum expiration time.

setExpiration

void setExpiration(int expiration)

Set the session expiration. This maps to Session-Expires header.

Parameters:

expiration - Session expiration in seconds.

Throws:

IllegalArgumentException - If the argument conflicts with the rules specified by RFC 4028.

IllegalStateException - If session keep alive is not enabled.

getExpiration

int getExpiration()

Return the session expiration in seconds. This maps to Session-Expires header.

Returns:

Session expiration in seconds.

setEnabled

void setEnabled(boolean enabled)

Sets whether the session keep-alive is enabled or not. Indicate that the session keep alive is enabled. The container make sure that necessary headers to indicate that the servlet supports session timer. It updates or insert session timer related headers as specified in RFC 4028 for UAC, proxy and UAS.

Parameters:

enabled - Set the enabled flag.

getEnabled

boolean getEnabled()

Return whether session keep alive is enabled or not.

Returns:

True if the session keep alive is enabled, false otherwise.