System Administrator’s Guide

Operation and Maintenance: General

The following sections give an overview of the mechanisms available for controlling Oracle Communications Services Gatekeeper.

Administration Console Overview

Oracle Communications Services Gatekeeper Administration Console provides a graphical user interface for configuring, managing, and provisioning Oracle Communications Services Gatekeeper. The console is an extension to the console available in WebLogic Server.

At least one Network Tier server must be started prior to logging in to WebLogic Server Administration Console. Oracle Communications Services Gatekeeper servers started after logging in to the Administration Console are not displayed in the Administration Console. To see them, you must login again.

Administration Console

Use a supported web browser to go to http://<server>:<port>/console where <server> is the instance you have set up as your Administration Server.

Login using your log-in credentials.

All Oracle Communications Services Gatekeeper configuration and monitoring is provided via the following nodes in the left pane of the console, in the Domain Structure group:

MBeans pane

The MBeans pane contains a tree-structure of all management objects applicable for the selected Oracle Communications Services Gatekeeper server.

By clicking on a management object, the corresponding Configuration and Provisioning page for the management object is displayed immediately below the MBean pane: see Configuration and Provisioning.

Configuration and Provisioning

The Configuration and Provisioning pane contains two tabs:

The Attributes tab displays a list of Attributes, either read-only or read-write for the managed object.

Read-write attributes have a check-box next to them.

To change an attribute:

The Operations tab contains a drop-down list with the operations for the managed object.

Operations either display data, set data, or perform an actual task.

To perform an operation:

WebLogic Oracle Communications Services Gatekeeper Alarms pane

The Oracle Communications Services Gatekeeper Alarms pane displays alarms emitted.

It is possible to filter the output to the page on a set of criteria, see Table 3-1.

The list is returned by clicking Get Alarms.

Oracle Communications Services Gatekeeper CDRs Pane

The Oracle Communications Services Gatekeeper CDRs pane displays CDRs that have been generated.

It is possible to filter the output to the page on a set of criteria, see Table 3-1.

The list is returned by clicking Get CDRs.

Oracle Communications Converged Application Server Management Console for SIP-based Communication Services

There is an administration console for the Oracle Communications Converged Application Server. This handles setting for the Oracle Communications Converged Application Server and the SIP Servlet parts of Oracle Communications Services Gatekeeper communication services.

Click <Domain name>SipServer to open the Oracle Communications Converged Application Server administration console.

Java Management Extensions (JMX)

Oracle Communications Services Gatekeeper exposes its management interfaces as JMX MBeans.

These MBeans come in two flavours:

Below is an example of connecting to the MBean server and performing an operation on the JMX interfaces.

The MBean object name is versioned. The MBean name includes the version number for the release. External JMX clients needs to be updated according to the release number.

import java.io.IOException;

import java.net.MalformedURLException;

import java.util.Hashtable;

import javax.management.MBeanServerConnection;

import javax.management.MalformedObjectNameException;

import javax.management.ObjectName;

import javax.management.remote.JMXConnector;

import javax.management.remote.JMXConnectorFactory;

import javax.management.remote.JMXServiceURL;

import javax.naming.Context;

public class TestMgmt {

  private static MBeanServerConnection connection;

  private static JMXConnector connector;

/*

  * Initialize connection to the Domain Runtime MBean Server

  */

  public static void initConnection(String hostname, String portString,

                                    String username, String password) throws IOException,

      MalformedURLException {

    String protocol = "t3";

    Integer portInteger = Integer.valueOf(portString);

    int port = portInteger.intValue();

    String jndiroot = "/jndi/";

    String mserver = "weblogic.management.mbeanservers.domainruntime";

    JMXServiceURL serviceURL = new JMXServiceURL(protocol, hostname,

        port, jndiroot + mserver);

    Hashtable h = new Hashtable();

    h.put(Context.SECURITY_PRINCIPAL, username);

    h.put(Context.SECURITY_CREDENTIALS, password);

    h.put(JMXConnectorFactory.PROTOCOL_PROVIDER_PACKAGES,

        "weblogic.management.remote");

    connector = JMXConnectorFactory.connect(serviceURL, h);

    connection = connector.getMBeanServerConnection();

  }

  public static void main(String[] args) throws Exception {

    String hostname = args[0];   //hostname of the admin server

    String portString = args[1]; //port of the admin server

    String username = args[2];

    String password = args[3];

    String mbserverName = args[4];  //NT server name

    String operationName = "addRoute";

    String id = "Plugin_px21_multimedia_messaging_mm7";

    String addressExpression = ".*";

    String[] params = new String[]{id, addressExpression};

    String[] signature = new String[]{"java.lang.String", "java.lang.String"};

    ObjectName on;

    try {

      on = new ObjectName("com.bea.wlcp.wlng:Name=wlng,InstanceName=PluginManager,Type= com.bea.wlcp.wlng.plugin.PluginManagerMBean,Location=" + mbserverName);

    } catch (MalformedObjectNameException e) {

      throw new AssertionError(e.getMessage());

    }

    initConnection(hostname, portString, username, password);

    //invoke the operation

    Object result = connection.invoke(on, operationName, params, signature);

    System.out.println(result.toString());  //displays the result

    connector.close();

  }

}

If setting an attribute or calling an operation fails, a com.bea.wlcp.wlng.api.management.ManagementException, or a subclass of this exception is thrown. The following subclasses are defined:

DuplicateKeyException - Thrown when the operation results in creating a duplicate key

InputManagementException - Thrown for invalid user input

KeyNotFoundException - Thrown when the operation cannot find the specified key

A JMX client must have the same version of exception classes available; otherwise the client will throw ClassNotFoundException.

$BEA_Home/ocsg_pds4.1/lib/wlng/oam.jar contains custom classes for OAM and return types.

$BEA_Home/ocsg_pds4.1/doc/javadoc_oam contains JavDoc for OAM.

WebLogic Scripting Tool (WSLT)

The following section gives examples of how to use the WebLogic Scripting Tool (WLST) in both interactive and script mode when configuring and managing Oracle Communications Services Gatekeeper.

For information about WebLogic Server and WLST, see Oracle WebLogic Server WebLogic Scripting Tool at http://download.oracle.com/docs/cd/E12840_01/wls/docs103/config_scripting/index.html.

The following topics are covered:

Working in Interactive Mode

Starting WLST and connecting to Oracle Communications Services Gatekeeper

Exiting WLST

Changing an attribute

Invoking an operation

For example, to invoke the displayStatistics method in the EDRService MBean:

cd('com.bea.wlcp.wlng:Name=wlng,InstanceName=EdrService,Type=com.bea.wlcp.wlng.edr.management.EdrServiceMBean')

objs = jarray.array([],java.lang.Object)

strs = jarray.array([],java.lang.String)

print(invoke('displayStatistics',objs,strs))

This operation has no arguments.

Another example: to add a route using the MBean for the Plug-in Manager:

cd(‘com.bea.wlcp.wlng:Name=wlng,InstanceName=PluginManager,Type=com.bea.wlcp.wlng.plugin.PluginManagerMBean ‘)

objs=jarray.array(['Plugin_px21_multimedia_messaging_mm7','.*'],Object)

strs=jarray.array(['java.lang.String', 'java.lang.String'],String)

invoke('addRoute', objs, strs)

The method addRoute takes two arguments, and the values of the parameters are stated in the same order as the parameters are defined in the signature of the method.

objs = jarray.array([java.lang.String('stringInput1'),java.lang.String(‘stringInput2’), java.lang.String(‘StringInput3’)],java.lang.Object)

strs = jarray.array(['java.lang.String', 'java.lang.String’, 'java.lang.String’],java.lang.String)

invoke('methodName',objs,strs)

Scripting WLST

When using WLST together with scripts, WLST is invoked as follows:

java weblogic.WLST <script name>.py <argument 1> <argument 2> ...<argument n>

The arguments can be retrieved from within the scripts in the array sys.argv[], where sys.argv[0] is the script name, sys.argv[1] is the second argument and so on. It may be useful to specify login information and connection information as arguments to the scripts.

Below is a script that connects to Oracle Communications Services Gatekeeper and changes to an MBean defined by argument.

userName = sys.argv[1]

passWord = sys.argv[2]

url="t3://"+sys.argv[3]+":"+sys.argv[4]

objectName = sys.argv[5]

objectName = "com.bea.wlcp.wlng:Name=nt,Type=" + sys.argv[5] 

print objectName

connect(userName, passWord, url)

custom()

cd('com.bea.wlcp.wlng')

cd(objectName)

For example: To invoke the script:

java weblogic.WLST script1.py weblogic weblogic localhost 7001 com.bea.wlcp.wlng:Name=wlng,InstanceName=PluginManager,Type=com.bea.wlcp.wlng.plugin.PluginManagerMBean