Skip navigation links

com.bea.wlcp.wlng.plugin.tpc.sip.management
Interface TPCMBean

public interface TPCMBean

Runtime MBean used to configure the third party call control plug-in.

Field Summary

static boolean	chargingAllowed Specifies if charging is allowed or not, meaning that the charging parameter is allowed to be present in a request from an application.
static String	controllerURI Specifies the Controller SIP URI that is used to establish the third party call.
static int	DEFAULT_TIMER_INTERVAL
static boolean	initialEmptySDP If the initial SDP to the first callleg should be empty.
static String	ISCRouteURI Specifies the IMS service control route URI.
static int	maximumCallLength Specifies the maximum call duration allowed, in minutes.
static int	statusRetentionTime Specifies the length of time, in minutes, to retain status after the termination of the call.

Method Summary

boolean	getChargingAllowed() Returns true if charging is allowed.
String	getControllerURI() Gets the Controller URI
int	getEraseTimerInterval() Gets the Erase TimerInterval.
boolean	getInitialEmptySDP() If this is true the first call leg will use no SDP (empty SDP).
String	getISCRouteURI() Gets the ISC RouteURI
int	getMaximumCallLength() Gets the maximum length of a call.
int	getStatusRetentionTime() Gets the status Retention Time.
void	setChargingAllowed(boolean allowed) If true, charging is allowed.
void	setControllerURI(String name) Sets the Controller URI
void	setEraseTimerInterval(int interval) Sets the Erase TimerInterval.
void	setInitialEmptySDP(boolean pInitialEmptySDP) If this is true the first call leg will use no SDP (empty SDP).
void	setISCRouteURI(String s) Sets the ISC RouteURI
void	setMaximumCallLength(int minutes) Sets the maximum call length.
void	setStatusRetentionTime(int t) Sets the status Retention Time.

Field Detail

chargingAllowed

public static final boolean chargingAllowed

Specifies if charging is allowed or not, meaning that the charging parameter is allowed to be present in a request from an application.

Scope: Cluster

See Also:

Constant Field Values

controllerURI

public static final String controllerURI

Specifies the Controller SIP URI that is used to establish the third party call. If this value is set, a call appears to the callee to come from this URI. By default, the value is None, where no controller URI is used to establish the call. In this case, the call appears to the callee to come from the caller.

Scope: Cluster

See Also:

Constant Field Values

DEFAULT_TIMER_INTERVAL

public static final int DEFAULT_TIMER_INTERVAL

See Also:

Constant Field Values

initialEmptySDP

public static final boolean initialEmptySDP

If the initial SDP to the first callleg should be empty. If this is false an SDP with owner, but no media will be used.

Scope: Cluster

See Also:

Constant Field Values

ISCRouteURI

public static final String ISCRouteURI

Specifies the IMS service control route URI.

Scope: Cluster

See Also:

Constant Field Values

maximumCallLength

public static final int maximumCallLength

Specifies the maximum call duration allowed, in minutes. If this time expires, the call is terminated. Format: int.

Scope: Cluster

See Also:

Constant Field Values

statusRetentionTime

public static final int statusRetentionTime

Specifies the length of time, in minutes, to retain status after the termination of the call.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

getChargingAllowed

public boolean getChargingAllowed()
                           throws ManagementException

Returns true if charging is allowed.

Scope: Cluster

Returns:

boolean True if charging is allowed.

Throws:

ManagementException.

ManagementException

getControllerURI

public String getControllerURI()
                        throws ManagementException

Gets the Controller URI

Scope: Cluster

Returns:

the controller URI.

Throws:

ManagementException.

ManagementException

getEraseTimerInterval

public int getEraseTimerInterval()
                          throws ManagementException

Gets the Erase TimerInterval. At each interval, the Timer will check and remove expired call sessions from the StorageService tpc_sip_callsession_info. The Callsession data also will be deletes from database table.

Scope: Cluster

Returns:

seconds Erase timer interval in seconds.

Throws:

ManagementException.

ManagementException

getInitialEmptySDP

public boolean getInitialEmptySDP()
                           throws ManagementException

If this is true the first call leg will use no SDP (empty SDP). If it is false, an SDP with owner but no media will be used.

Scope: Cluster

Throws:

ManagementException

getISCRouteURI

public String getISCRouteURI()
                      throws ManagementException

Gets the ISC RouteURI

Scope: Cluster

Returns:

Route URI.

Throws:

ManagementException.

ManagementException

getMaximumCallLength

public int getMaximumCallLength()
                         throws ManagementException

Gets the maximum length of a call.

Scope: Cluster

Returns:

minutes Maximum call length in minutes.

Throws:

ManagementException

getStatusRetentionTime

public int getStatusRetentionTime()
                           throws ManagementException

Gets the status Retention Time. During this time, the call session status will be retained.

Scope: Cluster

Returns:

Status Retention time in seconds.

Throws:

ManagementException.

ManagementException

setChargingAllowed

public void setChargingAllowed(boolean allowed)
                        throws ManagementException

If true, charging is allowed.

Scope: Cluster

Parameters:

allowed - True if charging is allowed.

Throws:

ManagementException.

ManagementException

setControllerURI

public void setControllerURI(String name)
                      throws ManagementException

Sets the Controller URI

Scope: Cluster

Parameters:

name - The controller URL.

Throws:

ManagementException.

ManagementException

setEraseTimerInterval

public void setEraseTimerInterval(int interval)
                           throws ManagementException

Sets the Erase TimerInterval. Refer to the getEraseTimerInterval() method.

Scope: Cluster

Parameters:

interval - time in seconds.

Throws:

ManagementException.

ManagementException

setInitialEmptySDP

public void setInitialEmptySDP(boolean pInitialEmptySDP)
                        throws ManagementException

If this is true the first call leg will use no SDP (empty SDP). If it is false, an SDP with owner but no media will be used.

Scope: Cluster

Throws:

ManagementException

setISCRouteURI

public void setISCRouteURI(String s)
                    throws ManagementException

Sets the ISC RouteURI

Scope: Cluster

Parameters:

s - Sets the ISC route URI

Throws:

ManagementException

setMaximumCallLength

public void setMaximumCallLength(int minutes)
                          throws ManagementException

Sets the maximum call length. Upon reaching the maximum call length, the call will be terminated automatically.

Scope: Cluster

Parameters:

minutes - Max length of call in minutes.

Throws:

ManagementException.

ManagementException

setStatusRetentionTime

public void setStatusRetentionTime(int t)
                            throws ManagementException

Sets the status Retention Time. During this time, call session status will be retained.

Scope: Cluster

Parameters:

t - Time the status will be retained, in seconds.

Throws:

ManagementException.

ManagementException

Skip navigation links