BEA WebLogic SIP Server 2.2 API Reference

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

Copyright © 2006 BEA Systems, Inc. All Rights Reserved.

Method Summary

long	getActiveServerAppSessionCount() Return the active application session count
long	getActiveServerSipSessionCount() Return the active SIP session count
long	getClusterId() Returns hash value of the cluster this server belongs to.
java.lang.String	getClusterIdHexString() Same as getClusterId but returns a string
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	getServerAppSessionCount() Return the total application session count
long	getServerSipSessionCount() Return the total SIP session count
SipServletSnmpTrapRuntimeMBean	getSipServletSnmpTrapRuntime()
long	getStartTime() Returns the absolute time when the SIP server was started.

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

preDeregister

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

getActiveServerAppSessionCount

public long getActiveServerAppSessionCount()

Return the active application session count

Returns:

active application session count

getActiveServerSipSessionCount

public long getActiveServerSipSessionCount()

Return the active SIP session count

Returns:

active SIP session count

getClusterId

public long getClusterId()

Returns 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

public java.lang.String getClusterIdHexString()

Same as getClusterId but returns a string

Returns:

string value of the cluster ID

getMessagesProcessed

public 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(); }

getMessagesReceived

public long getMessagesReceived()

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

getMessagesRejected

public 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.

getServerAppSessionCount

public long getServerAppSessionCount()

Return the total application session count

Returns:

application session count

getServerSipSessionCount

public long getServerSipSessionCount()

Return the total SIP session count

Returns:

SIP session count

getSipServletSnmpTrapRuntime

public SipServletSnmpTrapRuntimeMBean getSipServletSnmpTrapRuntime()

getStartTime

public long getStartTime()

Returns the absolute time when the SIP server was started.