| Oracle® Communications Service Broker Integration Guide Release 5.0 Part Number E15187-01 |
|
|
View PDF |
| Oracle® Communications Service Broker Integration Guide Release 5.0 Part Number E15187-01 |
|
|
View PDF |
This chapter describes how you use MBeans when integrating Oracle Communications Service Broker with an external management system.
Service Broker MBeans are used for creating, reading, updating, and deleting configuration data, for monitoring runtime aspects of modules, and for managing the life cycle of servers. These MBeans are categorized as either configuration MBeans or runtime MBeans:
You use configuration MBeans to configure Service Broker components. The MBeans provide get and set operations and are exposed by the Administration Console.
You use runtime MBeans to monitor the runtime state of components and to control the running state of Processing Servers and Signaling Servers. Runtime MBeans are exposed by the Processing Servers and Signaling Servers. The servers also expose a set of read-only configuration MBeans, used to read configuration values.
All MBeans can be accessed programmatically through JMX. Using JMX enables you to integrate Service Broker configuration, management, and monitoring with an external management system.
Information about Service Broker MBeans is described in different books, based on the type of MBean and the module to which it applies. The location of MBean documentation is provided later in this document.
The root MBeans are listed in this document. Each module has a root MBean and most root MBeans include below it a hierarchy of additional MBeans that relate to the same module. All Mbeans in the same hierarchy are documented in the same chapter.
There are two methods that Service Broker uses to derive MBean object names. Each method produces object names that have one of two common prefixes, which are also used in the package names:
com.convergin
oracle.axia
Both sets include runtime MBeans and configuration MBeans for various modules.
Information about the object names are located in different books:
For information about the naming convention of com.convergin MBean objects, see the following documents:
"Service Broker MBean Object Names" under "Understanding Service Broker Configuration" in Oracle Communications Service Broker Configuration Guide for information about configuration MBean object names.
"Service Broker Runtime MBean Object Names" under "Understanding Service Broker Runtime MBeans" in Oracle Communications Service Broker System Administrator's Guide for information about runtime MBean object names.
The object naming convention for oracle.axia MBeans is not described. Instead, the object name for each MBean is given in the MBean documentation in various chapters.
Runtime MBeans provide operations for monitoring runtime aspects of modules and managing the life cycle of individual servers.
Examples include monitoring internal queues, listing recently sent SNMP traps, changing the running state of server, and viewing traffic statistics for a server.
Oracle Communications Service Broker System Administrator's Guide includes information on these MBeans:
(oracle.axia) ManagementAgentMBean, in "Life cycle of Processing Servers and Signaling Servers"
(oracle.axia) DeploymentServiceMBean, in "Upgrading and Patching"
(oracle.axia) DomainServiceMBean, in "Managing Domains"
In "Monitoring Service Broker with JMX Runtime MBeans":
(com.convergin) All Interworking Module (IM) MBeans used to monitor IM traffic statistics
(com.convergin) All Signaling Server Unit (SSU) MBeans used to monitor SSU traffic statistics
(com.convergin) OeRuntimeMBean
Configuration MBeans provide create, read, update, and delete (CRUD) operations that apply to the configuration of a domain and of individual modules.
Examples of module configurations include reading and updating configuration settings for SMNP traps, Interworking Modules, Signaling Server Units.
Examples of domain configurations include adding servers to and removing servers from a domain configuration and deploying and undeploying OSGi bundles.
The configuration MBeans define set and get operations. The settings from these operations are persisted in the domain configuration. The configuration settings are propagated to Processing Servers and Signaling Servers. When the domain is online, the changes are immediately propagated to the servers using a two-way commit pattern. The configuration is always fetched by the servers when they start.
Each configurable module has a root MBean. Under this hierarchy, there can be a tree of MBeans all relating to the same module. All MBeans for a specific module belong to the same package.
Each MBean has one parent MBean and zero or more sibling MBeans. Several instances of an MBean can occur under a parent MBean. An instance of an MBean can exist under several different parent MBeans.
This section includes information about the conventions used when working with oracle.axia configuration MBeans.
Instances of oracle.axia configuration MBeans can be created and removed using the add and remove methods of the parent MBean. The naming syntax for these methods is:
void addMBean_name()
void removeMBean_name() or void removeMBean_name(int index)
where:
MBean_name is the name of the interface that defines the MBean to be added or removed. When specifying MBean_name, omit the suffix MBean, which is present in the MBean name.
index is the index number of the MBean instance to remove.
The remove method takes the index parameter when the parent MBean allows more than one sibling MBean.
For example, the MBean UnicastAddressesMBean can have zero or more instances of UnicastAddressMBean as siblings. Hence UnicastAddressesesMBean defines the methods void addUnicastAddress() and void removeUnicastAddress(int index).
When multiple instances of a sibling MBean are allowed, an index is appended to the object name. The index starts at 0 and is incremented automatically as MBeans are added. When an MBean is removed, the indexes of the remaining MBeans are re-calculated to retain an uninterrupted sequence.
If only one instance of an MBean is allowed, an exception is thrown if the add method is invoked when there is already a registered instance of that MBean.
An exception is also thrown if the remove method is invoked for an MBean when there are no registered instances of that MBean.
MBeans can also be created programmatically by using factory methods. Factory methods for all MBeans for a specific module are provided in a class named ObjectFactory. There is one ObjectFactory for each MBean hierarchy.
Configuration settings are applied either to all servers in the domain or to individual servers, as defined by the configuration scope. For the MBeans that can have a scope other than domain, the scope is expressed using the Target attribute. The target attribute is a string that is set to the name of the server to which the MBean applies. The server name is the name as defined in the domain configuration. Alternatively, if Target is empty, the configuration applies to all servers in the domain. When a target is set, the configuration applies to the MBean in which it is set and to all its sibling MBeans.
Each oracle.axia configuration MBean is defined by two interfaces: one defines set (write) operations for the MBean and the other defines get (read) operations:
The interface that defines get operations has the suffix ReadOnlyMBean. Read-only MBeans are available on each Processing Server and Signaling Server.
The interface that defines set operations has the suffix MBean and inherits from the corresponding interface that defines get operations, and so exposes the full set of get and set operations.
For example, the interface MulticastAddressMBean has MulticastAddressReadOnlyMBean as a Superinterface. MulticastAddressMBean defines all write operations whereas MulticastAddressReadOnlyMBean defines the corresponding read operations.
Both interfaces belong to the same package. For example, MulticastAddressMBean and MulticastAddressReadOnlyMBean both belong to the package oracle.axia.config.beans.storage.coherence.
For information about the conventions used when working with com.convergin configuration MBeans, see "Configuration MBeans Overview" in Oracle Communications Service Broker Configuration Guide.
Oracle Communications Service Broker Integration Guide includes information about these MBeans:
(oracle.axia) SnmpConfigTypeMBean, in "Monitoring Service Broker with SNMP"
Oracle Communications Service Broker Configuration Guide includes information about these MBeans (these are all com.convergin MBeans):
ChangeCenterMBean, in "Understanding Service Broker Configuration"
DeploymentMBean, in "Managing Service Broker Interworking Modules"
OeMBean, in "Configuring Service Broker Orchestration Engine"
All IM MBeans in the respective chapter on configuring each IM
All SSU MBeans in the respective chapter on configuring each SSU
All Supplementary Module (SM) MBeans in the respective chapter on configuring each SM
Oracle Communications Service Broker System Administrator's Guide includes information on these MBeans:
(oracle.axia) DeploymentServiceMBean, in "Upgrading and Patching"
(oracle.axia) DomainServiceMBean, in "Managing Domains"
|
 Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
