管理クライアント・プログラムの開発
WebSphere® Application Server 管理アプリケーション・プログラミング・インターフェース (API) および Java™ Management Extensions (JMX) を使用する管理クライアント・プログラムを開発できます。
このタスクの概要
製品管理 API は、分散システムの操作面の制御、および構成の更新機能を提供します。 AdminClient インターフェースについては、アプリケーション・プログラミング・インターフェースの資料を参照してください。
MBean オペレーションの例を参照してください。 MBean プログラミングについては、MBean Java API の資料を参照してください。 この資料で、「 」をクリックします。
この例は NodeAgent MBean の入手方法と使用方法を示していますが、これはご使用の製品には使用不可です。 ただし、NodeAgent MBean を入手し、使用する方法の説明は、ご使用の製品に使用可能なその他の MBeans に対して行うものと類似しています。
手順
- AdminClient インスタンスを作成します。
管理クライアント・プログラムは、基本インストール内のアプリケーション・サーバーで稼働している AdminService オブジェクトでメソッドを呼び出す必要があります。
AdminClient クラスは、サポートされている Java Management Extensions (JMX) コネクターのいずれかを介して、リモート AdminService オブジェクトにプロキシーを提供します。- 以下の例は、Simple Object Access Protocol (SOAP) コネクターの AdminClient インスタンスの作成方法を示しています。
Properties connectProps = new Properties(); connectProps.setProperty( AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP); connectProps.setProperty(AdminClient.CONNECTOR_HOST, "localhost"); connectProps.setProperty(AdminClient.CONNECTOR_PORT, "8879"); connectProps.setProperty(AdminClient.USERNAME, "test2"); connectProps.setProperty(AdminClient.PASSWORD, "user24test"); AdminClient adminClient = null; try { adminClient = AdminClientFactory.createAdminClient(connectProps); } catch (ConnectorException e) { System.out.println("Exception creating admin client: " + e); }- Properties オブジェクトをセットアップします。
この例では、ご使用のサーバーにアクセスするために必要なプロパティーで、Properties オブジェクトをセットアップします。 この場合、SOAP コネクターを使用してサーバーにアクセスします。コネクター・タイプに対して、値 AdminClient.CONNECTOR_TYPE_SOAP を使用します。
![[AIX Solaris HP-UX Linux Windows]](../images/ngdist.svg)
![[IBM i]](../images/ngibmi.svg)
簡単にするために、サーバーと同じマシン上でクライアント・プログラムを実行します。ホスト名には localhostを使用します。ローカル・ホストの代わりにリモート・ホストにアクセスするには、そのホストのネットワーク解決可能名を使用します。
- サーバー SOAP コネクターが listen しているポート番号を設定します。
単一サーバー・インストールでは、アプリケーション・サーバー SOAP コネクターのデフォルト・ポート番号は 8880 です。
- 接続プロパティーを設定後、AdminClientFactory クラスおよび Properties オブジェクトを使用して、選択済みサーバーに接続される AdminClient オブジェクトを作成します。
必要なプロトコルおよびセキュリティー環境などの要因に応じて、他のプロパティーを設定する必要がある場合があります。 例えば、アプリケーション・クライアント・プログラムのセキュリティーを使用可能にする場合は、 javax.net.ssl.* を組み込みます。 properties. AdminClient インターフェースについて詳しくは、 javax.net.ssl.* を参照してください。 プロパティー、および追加の作成例については、アプリケーション・プログラミング・インターフェース資料の AdminClient インターフェースを参照してください。
- Properties オブジェクトをセットアップします。
- 以下の例は、リモート・メソッド呼び出し (RMI) コネクターの AdminClient インスタンスの作成方法を示しています。 一部のコマンドは印刷目的のために複数行に分割されています。
Properties connectProps = new Properties(); connectProps.setProperty(AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_RMI); connectProps.setProperty(AdminClient.CONNECTOR_HOST, "localhost"); connectProps.setProperty(AdminClient.CONNECTOR_PORT, "2809"); connectProps.setProperty(AdminClient.USERNAME, "test2"); connectProps.setProperty(AdminClient.PASSWORD, "user24test"); System.setProperty("com.ibm.CORBA.ConfigURL", "file:C:/AA/cf010839.26/profiles/AppSrv02/properties/sas.client.props"); System.setProperty("com.ibm.SSL.ConfigURL", "file:C:/AA/cf010839.26/profiles/AppSrv02/properties/ssl.client.props"); AdminClient adminClient = null; try { adminClient = AdminClientFactory.createAdminClient(connectProps); } catch (ConnectorException e) { System.out.println("Exception creating admin client: " + e); }サポートされる構成: サーブレットや JavaServer Pages (JSP) ファイルなど、アプリケーション・サーバー上で実行されるアプリケーション・コード内で createAdminクライアント・メソッドを使用する場合は、CACHE_DISABLED プロパティーを true に設定する必要があります。 以下に例を示します。connectProps.setProperty(AdminClient.CACHE_DISABLED, "true");- Properties オブジェクトをセットアップします。
この例では、ご使用のサーバーにアクセスするために必要なプロパティーで、Properties オブジェクトをセットアップします。 この場合、リモート・メソッド呼び出しコネクターを使用して、サーバーにアクセスします。コネクター・タイプに対して、値 AdminClient.CONNECTOR_TYPE_RMI を使用します。
- 簡単にするために、サーバーと同じマシン上でクライアント・プログラムを実行します。ホスト名には
localhostを使用します。ローカル・ホストの代わりにリモート・ホストにアクセスするには、そのホストのネットワーク解決可能名を使用します。
- サーバー RMI コネクターが listen しているポート番号を設定します。
単一サーバー・インストールでは、アプリケーション・サーバー RMI コネクターのデフォルト・ポート番号は 2809 です。 WebSphere Application Server Network Deployment インストール済み環境では、デプロイメント・マネージャー RMI コネクターのデフォルト・ポート番号は 9809 です。
- 接続プロパティーを設定後、AdminClientFactory クラスおよび Properties オブジェクトを使用して、選択済みサーバーに接続される AdminClient オブジェクトを作成します。
必要なプロトコルおよびセキュリティー環境などの要因に応じて、他のプロパティーを設定する必要がある場合があります。 例えば、アプリケーション・クライアント・プログラムでセキュリティーを有効にする場合、ssl.client.props ファイルおよび sas.client.props ファイルをポイントするようにシステム・プロパティーを設定する必要があります。 ローカル・マシン上で実行する場合、実際のロケーションをポイントできます。 リモート・マシン上で実行する場合、これらのプロパティー・ファイルをサーバー・マシンからコピーして、任意の場所に配置し、ファイルを配置したパスを指定できます。
ユーザー名およびパスワードは sas.client.props ファイル内に指定できます。その場合、
com.ibm.CORBA.loginSource=propertiesを指定します。 ユーザー名およびパスワードをクライアント・プログラム内に設定する場合、sas.client.props ファイルにcom.ibm.CORBA.loginSource=noneを指定します。
- Properties オブジェクトをセットアップします。
- 以下の例は、Simple Object Access Protocol (SOAP) コネクターの AdminClient インスタンスの作成方法を示しています。
結果
管理クライアントは、MBean から送出されたイベント通知を処理することができます。
System.exit() ステートメントをクライアント・プログラムに追加します。 ORB は、クライアントへの通知伝搬を処理するスレッドを開始します。 このスレッドは、クライアントのメイン・スレッドに System.exit() ステートメントが含まれないと、メイン・スレッドで自動的に終了しません。 クライアント・プログラム内の場所に、ORB スレッドとメイン・スレッドが処理を停止できるようにする
System.exit() ステートメントを入れてください。 例えば、クライアント・プログラムのメインの try ブロックの catch または finally 節に、
System.exit() ステートメントを入れます。例: 管理クライアント・プログラム
この例では、ノード・エージェント・サーバーへの接続方法を紹介しますこの方法は、ご使用の製品では使用できません。 ただし、ホストとポートの値を変更することにより、サーバーに接続することができます。 ご使用のサーバーを、ノード・エージェント・サーバー参照の代わりにしてください。 NodeAgent MBean は、この製品には使用できないため、queryNames ストリングを代わりに使用して、別の MBean を検索してください。
import java.util.Date;
import java.util.Properties;
import java.util.Set;
import javax.management.InstanceNotFoundException;
import javax.management.MalformedObjectNameException;
import javax.management.Notification;
import javax.management.NotificationListener;
import javax.management.ObjectName;
import com.ibm.websphere.management.AdminClient;
import com.ibm.websphere.management.AdminClientFactory;
import com.ibm.websphere.management.exception.ConnectorException;
public class AdminClientExample implements NotificationListener
{
private AdminClient adminClient;
private ObjectName nodeAgent;
private long ntfyCount = 0;
public static void main(String[] args)
{
AdminClientExample ace = new AdminClientExample();
// Create an AdminClient
ace.createAdminClient();
// Find a NodeAgent MBean
ace.getNodeAgentMBean("ellington");
// Invoke launchProcess
ace.invokeLaunchProcess("server1");
// Register for NodeAgent events
ace.registerNotificationListener();
// Run until interrupted
ace.countNotifications();
}
private void createAdminClient()
{
// Set up a Properties object for the JMX connector attributes
Properties connectProps = new Properties();
connectProps.setProperty(
AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP);
connectProps.setProperty(AdminClient.CONNECTOR_HOST, "localhost");
connectProps.setProperty(AdminClient.CONNECTOR_PORT, "8879");
// Get an AdminClient based on the connector properties
try
{
adminClient = AdminClientFactory.createAdminClient(connectProps);
}
catch (ConnectorException e)
{
System.out.println("Exception creating admin client: " + e);
System.exit(-1);
}
System.out.println("Connected to DeploymentManager");
}
private void getNodeAgentMBean(String nodeName)
{
// Query for the ObjectName of the NodeAgent MBean on the given node
try
{
String query = "WebSphere:type=NodeAgent,node=" + nodeName + ",*";
ObjectName queryName = new ObjectName(query);
Set s = adminClient.queryNames(queryName, null);
if (!s.isEmpty())
nodeAgent = (ObjectName)s.iterator().next();
else
{
System.out.println("Node agent MBean was not found");
System.exit(-1);
}
}
catch (MalformedObjectNameException e)
{
System.out.println(e);
System.exit(-1);
}
catch (ConnectorException e)
{
System.out.println(e);
System.exit(-1);
}
System.out.println("Found NodeAgent MBean for node " + nodeName);
}
private void invokeLaunchProcess(String serverName)
{
// Use the launchProcess operation on the NodeAgent MBean to start
// the given server
String opName = "launchProcess";
String signature[] = { "java.lang.String" };
String params[] = { serverName };
boolean launched = false;
try
{
Boolean b = (Boolean)adminClient.invoke(
nodeAgent, opName, params, signature);
launched = b.booleanValue();
if (launched)
System.out.println(serverName + " was launched");
else
System.out.println(serverName + " was not launched");
}
catch (Exception e)
{
System.out.println("Exception invoking launchProcess: " + e);
}
}
private void registerNotificationListener()
{
// Register this object as a listener for notifications from the
// NodeAgent MBean. Don't use a filter and don't use a handback
// object.
try
{
adminClient.addNotificationListener(nodeAgent, this, null, null);
System.out.println("Registered for event notifications");
}
catch (InstanceNotFoundException e)
{
System.out.println(e);
e.printStackTrace();
}
catch (ConnectorException e)
{
System.out.println(e);
e.printStackTrace();
}
}
public void handleNotification(Notification ntfyObj, Object handback)
{
// Each notification that the NodeAgent MBean generates will result in
// this method being called
ntfyCount++;
System.out.println("***************************************************");
System.out.println("* Notification received at " + new Date().toString());
System.out.println("* type = " + ntfyObj.getType());
System.out.println("* message = " + ntfyObj.getMessage());
System.out.println("* source = " + ntfyObj.getSource());
System.out.println(
"* seqNum = " + Long.toString(ntfyObj.getSequenceNumber()));
System.out.println("* timeStamp = " + new Date(ntfyObj.getTimeStamp()));
System.out.println("* userData = " + ntfyObj.getUserData());
System.out.println("***************************************************");
}
private void countNotifications()
{
// Run until killed
try
{
while (true)
{
Thread.currentThread().sleep(60000);
System.out.println(ntfyCount + " notification have been received");
}
}
catch (InterruptedException e)
{
}
}
}