IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

com.ibm.websphere.objectgrid.management
Interface DynamicServerMBean

All Superinterfaces:
ServerMBean
All Known Subinterfaces:
Server

public interface DynamicServerMBean
extends ServerMBean

This MBean interface allows a client process to access different attributes about a specific server process in a dynamic environment. The object name pattern for this MBean is:

 com.ibm.websphere.objectgrid:type=ObjectGridServer,name=<server>,host=<host>,ogServerName=<server>
 
If ObjectGrid is running in a WebSphere Application Server process, more key=value pairs may be added to the object name.

Since:
WAS XD 6.1 FIX3, XC10

Field Summary
static String SERVER_COREGROUP_MEMBERSHIP_CHANGE
           
 
Method Summary
 int getAvailableProcessors()
          Returns the number of available processors for the JVM hosting this server.
 CompositeData getEnvironmentInfo()
          Retrieve the environment information for the server (host name, WebSphere eXtreme Scale version, and additional information).
 long getFreeMemory()
          Returns the available memory in bytes for the JVM hosting this server.
 String getHostName()
          Returns the host name for this process.
 long getMaxMemory()
          Returns the maximum memory in bytes for the JVM hosting this server.
 boolean getSafeToShutdown()
          Returns true if a replica exists for each primary hosted on this server.
 String getStatsSpec()
          Retrieve the current statistics specification for the server.
 long getTotalMemory()
          Returns the total memory in bytes for the JVM hosting this server.
 String getTraceSpec()
          Retrieve the current trace specification for the server.
 String getZoneName()
          Returns the zone name for this process
 void setStatsSpec(String statsSpec)
          Set the statistics specification for the server.
 void setTraceSpec(String traceSpec)
          Set the trace specification for the server.
 
Methods inherited from interface com.ibm.websphere.objectgrid.management.ServerMBean
getServerName, modifyServerTraceSpec, stopServer
 

Field Detail

SERVER_COREGROUP_MEMBERSHIP_CHANGE

static final String SERVER_COREGROUP_MEMBERSHIP_CHANGE
See Also:
Constant Field Values
Method Detail

getAvailableProcessors

int getAvailableProcessors()
Returns the number of available processors for the JVM hosting this server.

Returns:
The answer from the Runtime call on the JVM hosting this server.
See Also:
Runtime.availableProcessors()

getFreeMemory

long getFreeMemory()
Returns the available memory in bytes for the JVM hosting this server.

Returns:
The answer from the Runtime call on the JVM hosting this server.
See Also:
Runtime.freeMemory()

getMaxMemory

long getMaxMemory()
Returns the maximum memory in bytes for the JVM hosting this server.

Returns:
The answer from the Runtime call on the JVM hosting this server.
See Also:
Runtime.maxMemory()

getTotalMemory

long getTotalMemory()
Returns the total memory in bytes for the JVM hosting this server.

Returns:
The answer from the Runtime call on the JVM hosting this server.
See Also:
Runtime.totalMemory()

getHostName

String getHostName()
Returns the host name for this process.

Returns:
The answer from the Runtime call on the JVM hosting this server.
See Also:
InetAddress.getHostName()

getZoneName

String getZoneName()
Returns the zone name for this process

Returns:
the zone name that was included in the properties used to start the server or DefaultZone if no zone name was used

getSafeToShutdown

boolean getSafeToShutdown()
Returns true if a replica exists for each primary hosted on this server. Returns false if the server has the only copy of data.

Returns:
If server is safe to shutdown.

getStatsSpec

String getStatsSpec()
Retrieve the current statistics specification for the server.

Returns:
a string representation of the statistics specification.
Since:
7.1
See Also:
StatsSpec

setStatsSpec

void setStatsSpec(String statsSpec)
Set the statistics specification for the server.

Parameters:
statsSpec - the statistics specification string.
Since:
7.1
See Also:
StatsSpec

getTraceSpec

String getTraceSpec()
Retrieve the current trace specification for the server.

Returns:
the trace specification string.
Since:
7.1

setTraceSpec

void setTraceSpec(String traceSpec)
Set the trace specification for the server.

Parameters:
traceSpec - the statistics specification string.
Since:
7.1
See Also:
ObjectGridManager.setTraceSpecification(String)

getEnvironmentInfo

CompositeData getEnvironmentInfo()
Retrieve the environment information for the server (host name, WebSphere eXtreme Scale version, and additional information). The CompositeData contains the following items:
Item NameTypeDescription
JMXServicePortStringJMX Service Port
WASServerNameStringWebSphere Application Server Full Server Name
JVMVersionStringJAVA Version
JMXConnectorPortStringJMX Connector Port
IPAddressStringIP Address
JavaVMStringJVM Version
WASInstallRootStringWebSphere Application Server Product Directory
OSGIFrameworkVersionStringOSGi Version
ClientPortStringClient Port
HostNameStringHost name
TimestampStringTime Stamp from Server
WASBaseVersionStringIBM WebSphere Application Server Version
OSNameStringOperating System
XSInstallRootStringWebSphere eXtreme Scale Product Directory
OSArchStringOS Architecture
PeerPortStringPeer Port
ServerTypeStringServer Type
HAManagerPortStringHAManager Port
JVMInstallPathStringJAVA Directory
XC10ModelStringMachine Type and Model
JavaRuntimeInfoStringJVM Runtime Version
xioContainerTCPNonSecureStringXIO TCP/IP Port
JMXServiceURLStringJMX Service Port
listenerPortStringListener Port (ORB)
ServerNameStringServer Name
WASXDVersionStringIBM WebSphere Application Server - XD Version
WASExpressVersionStringIBM WebSphere Application Server - ND Version
JavaBitModeStringJAVA Bit Mode
XSVersionStringWebSphere eXtreme Scale Version
JVMVendorStringJAVA Vendor
OSVersionStringOperating System Version
xioContainerTCPSecureStringXIO TCP/IP SSL Port
PIDStringProcess ID
WASNDVersionStringIBM WebSphere Application Server - ND Version
ORB VersionStringORB Version

Returns:
CompositeData containing the environment information
Since:
8.5

IBM WebSphereTM eXtreme Scale, Release 8.5
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.