com.bea.wcp.sip.management.runtime

Interface SipServerRuntimeMBean

All Superinterfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, weblogic.management.WebLogicMBean

public interface SipServerRuntimeMBean
extends weblogic.management.runtime.RuntimeMBean

SIP ServerRuntime MBean

Author:

Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.

Method Summary

Modifier and Type	Method and Description
void	activateBackup(byte site) Activates the backup records for the specified site.
void	deleteBackup(byte site) Deletes the backup records for the specified site.
long	getActiveServerAppSessionCount() Deprecated.
long	getActiveServerSipSessionCount() Deprecated.
long	getClusterId() Returns a hash value of the cluster this server belongs to.
String	getClusterIdHexString() Same as getClusterId but returns a string.
long	getDestroyedServerAppSessionCount() Returns the destroyed application session count.
long	getDestroyedServerSipSessionCount() Returns the destroyed SIP session count.
long	getMessagesProcessed() Returns the total number of messages that have been processed since the server was started.
long	getMessagesReceived() Returns the total number of messages received since the server was started.
long	getMessagesRejected() Returns the total number of messages rejected since the server was started.
long	getPeriodCountFailedSipTransactions()
long	getPeriodCountSipThroughput()
long	getPeriodCountSucceededSipTransactions()
long	getServerAppSessionCount() Return the total application session count
long	getServerSipSessionCount() Returns the total SIP session count.
SipPerformanceRuntimeMBean	getSipPerformanceRuntime()
SipServletSnmpTrapRuntimeMBean	getSipServletSnmpTrapRuntime()
long	getStartTime() Returns the absolute time when the SIP server was started.
void	sipSessionCreated()
void	sipTransactionCreated() Increments the total SIP transactions counter.
void	sipTransactionFailed() Increments the failed SIP transactions counter.
void	sipTransactionSucceeded() Increments the succeeded SIP transactions counter.

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, preDeregister, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

sipSessionCreated

void sipSessionCreated()

getStartTime

long getStartTime()

Returns the absolute time when the SIP server was started.

getServerAppSessionCount

long getServerAppSessionCount()

Return the total application session count

Returns:

application session count

getServerSipSessionCount

long getServerSipSessionCount()

Returns the total SIP session count.

Returns:

SIP session count

getActiveServerAppSessionCount

long getActiveServerAppSessionCount()

Deprecated.

Returns the active application session count.

Returns:

active application session count

getActiveServerSipSessionCount

long getActiveServerSipSessionCount()

Deprecated.

Returns the active SIP session count.

Returns:

active SIP session count

getDestroyedServerAppSessionCount

long getDestroyedServerAppSessionCount()

Returns the destroyed application session count.

Returns:

destroyed application session count

getDestroyedServerSipSessionCount

long getDestroyedServerSipSessionCount()

Returns the destroyed SIP session count.

Returns:

destroyed SIP session count

getMessagesReceived

long getMessagesReceived()

Returns the total number of messages received since the server was started.

getMessagesRejected

long getMessagesRejected()

Returns the total number of messages rejected since the server was started. This includes messages that were rejected because they were invalid or because the server was too busy to handle them.

getMessagesProcessed

long getMessagesProcessed()

Returns the total number of messages that have been processed since the server was started. The following can be used to obtain the current number of messages waiting to be processed:

public long getMessagesPending(SipPerformanceRuntimeMBean perf) { return perf.getMessagesReceived() - perf.getMessagesRejected() - perf.getMessagesProcessed(); }

getSipPerformanceRuntime

SipPerformanceRuntimeMBean getSipPerformanceRuntime()

getClusterId

long getClusterId()

Returns a hash value of the cluster this server belongs to. This value is encoded in system headers, and it allows WLSS engine that receives SIP message to determine if it is capable of processing this SIP message or if it should forward it onto another cluster using the "sideways" mechanism. See SidewaysTransport for more information.

getClusterIdHexString

String getClusterIdHexString()

Same as getClusterId but returns a string.

Returns:

string value of the cluster ID

getSipServletSnmpTrapRuntime

SipServletSnmpTrapRuntimeMBean getSipServletSnmpTrapRuntime()

activateBackup

void activateBackup(byte site)

Activates the backup records for the specified site. This will transfer ownership of all the records received from the specified backed up site and enable their timers.

Parameters:

site -

deleteBackup

void deleteBackup(byte site)

Deletes the backup records for the specified site. This will remove all the records received from the specified backed up site.

Parameters:

site -

sipTransactionSucceeded

void sipTransactionSucceeded()

Increments the succeeded SIP transactions counter.

getPeriodCountSucceededSipTransactions

long getPeriodCountSucceededSipTransactions()

Returns:

latest full window period counter for succeeded SIP transations

sipTransactionFailed

void sipTransactionFailed()

Increments the failed SIP transactions counter.

getPeriodCountFailedSipTransactions

long getPeriodCountFailedSipTransactions()

Returns:

latest full window period counter for failed SIP transations

sipTransactionCreated

void sipTransactionCreated()

Increments the total SIP transactions counter.

getPeriodCountSipThroughput

long getPeriodCountSipThroughput()

Returns:

latest full window period counter for total SIP transations