Cisco SCA BB Service Configuration API プログラマ ガイド Rel. 3.1
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年6月4日
章のタイトル： SCA BB Service Configuration API を使用したプログラミング
- Class ServiceConfig 方式
- getCalendarList
- getClassificationCfg
- getDynamicSignatureScript
- getPackageList
- getPolicySettings
- getProtocolRedirectIndexNameArray
- getProtocolRedirectString
- getRealTimeFrameName
- getServiceList
- getSubNotifications
- getTimeFrameNames
- getProtocolRedirectString
- getZoneList
- isProtocolRedirectable
- setProtocolRedirectString
- setProtocolRedirectString
- setTimeFrameName
- setTimeFrameName
- setTimeFrameNames
SCA BB Service Configuration API を使用したプログラミング
この章では、Cisco SCA BB Service Configuration API（Service Configuration API）の主なクラスおよび方式について説明します。プログラミングに関するガイドラインおよびコードの例も示します。
•
「Service Configuration API パッケージ」
• 「Package com.cisco.scabb.servconf.mgmt」
• 「Class ServiceConfigApi の概要」
Service Configuration API パッケージ
Service Configuration API には次のパッケージが含まれています。
• Service Configuration Management API
–com.cisco.scabb.servconf.mgmt
• Service Configuration Editing API
–com.cisco.scasbb.backend.classification -- さまざまなモデルの説明を提供します。
–com.pcube.apps.engage.common -- Policy および Subscriber クラスで使用されるクラスを提供します。
–com.pcube.apps.engage.policy -- サービス コンフィギュレーションを定義するクラスを提供します。
ここでは、com.cisco.scabb.servconf.mgmt についてのみ説明します。その他のパッケージの詳細については、Service Configuration API ディストリビューション（ インストール内容を参照）の一部である Javadoc を参照してください。
Package com.cisco.scabb.servconf.mgmt
• SCABB -- SCE プラットフォームとの接続方法、動作の適用と取得に使用する方式を提供
• ConnectionApi -- SCE プラットフォームとの接続
• ImportExportApi -- PQB ファイルに対するサービス コンフィギュレーションの保存方法、読み取り方法を提供。また、CSV ファイルに対するサービス コンフィギュレーションの部分インポート方法、部分エクスポート方法を提供
• ServiceConfigApi -- 新しいサービス コンフィギュレーションの作成方法、および SCE プラットフォームに対するサービス コンフィギュレーションの適用方法、取得方法を提供
• ServiceConfig -- このクラスのインスタンスは、SCE プラットフォームに適用される場合、サービス コントロール アプリケーションのネットワーク トラフィックに対する分類方法、アカウンティングとレポートの方法、および制御方法を決定するコンフィギュレーション パラメータのコンテナです。
Class SCABB の概要
Class SCABB 方式の概要
• 「ログイン」
• 「ログイン」
• 「ログアウト」
ログイン
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
String userName,
String password,
byte deviceType)
throws ConnectionFailedException
SCE プラットフォームに接続します。この方式は、デバイスに影響を与えるすべての API 方式で使用されるハンドルを返します。すべてのログイン操作は、 logout(ConnectionApi) 操作で終了する必要があります。
• deviceType -- デバイスのタイプ。デバイス タイプ Connection.SE_DEVICE を使用して SCE プラットフォームに接続します。
ログイン
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
既存の SessionObject を使用してデバイスに接続します。この方式は、デバイスに影響を与えるすべての API 方式で使用されるハンドルを返します。
すべてのログイン操作は、 logout(ConnectionApi) 操作で終了する必要があります。
ログアウト
• 「構文」
• 「説明」
• 「パラメータ」
addNotificationListener
• 「構文」
• 「説明」
• 「パラメータ」
SCABB API で実行されたすべての操作に関する通知を受信するため、指定された SCABB 通知リスナーを承認します。
removeNotificationListener
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
SCABB API 操作に関する通知の受信を SCABB リスナー上で解除します。
getDefaultProtocolFamilies
• 「構文」
• 「説明」
• 「戻り値」
• 「参照先」
Class ConnectionApi の概要
Class ConnectionApi は、すべての Service Configuration API 方式および Subscriber API 方式で使用される SCE への接続用ハンドルです。
Class ConnectionApi 方式については、次のセクションで説明します。
Class ConnectionApi 方式の概要
isConnected
• 「構文」
• 「説明」
• 「戻り値」
Class ImportExportApi の概要
Class ImportExportApi は、操作のインポートおよびエクスポート用の API です。サービス コンフィギュレーションのエレメントは CSV 形式でインポートおよびエクスポートされます。サービス コンフィギュレーションは XML 形式でインポートおよびエクスポートされます。
Class ImportExportApi 方式については、次のセクションで説明します。
• 「Class ImportExportApi Constructor の概要」
• 「Class ImportExportApi 方式の概要」
Class ImportExportApi Constructor の概要
ImportExportApi
• 「構文」
• 「説明」
Class ImportExportApi 方式の概要
• 「exportServiceConfiguration」
exportServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File f)
throws FileNotFoundException,
ImportExportException
サービス コンフィギュレーションをファイルにエクスポートします。
• servConf -- エクスポートするサービス コンフィギュレーション
importServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws ImportExportException,
IOException
指定されたファイルからサービス コンフィギュレーションをインポートします。
• f -- インポートするサービス コンフィギュレーションを格納するファイル
importFlavors
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
FlavorType flavorType,
File file)
throws ImportExportException
指定された CSV ファイルから特定のフレーバ タイプをインポートします。
• servConf -- フレーバのインポート先となるサービス コンフィギュレーション
importFlavors
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
FlavorType flavorType,
InputStream inStream)
throws ImportExportException
指定された入力ストリームから特定のフレーバ タイプをインポートします。
• servConf -- フレーバのインポート先となるサービス コンフィギュレーション
importZones
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
importZones
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
InputStream inStream)
throws ImportExportException
importProtocols
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
指定された CSV ファイルからプロトコルをインポートします。
importProtocols
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
InputStream inStream)
throws ImportExportException
importServices
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
指定された CSV ファイルからサービスをインポートします。
importServices
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
InputStream inStream)
throws ImportExportException
exportProtocols
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
プロトコルを指定されたファイルへ CSV 形式でエクスポートします。
exportProtocols
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
OutputStream outStream)
throws ImportExportException
プロトコルを指定された出力ストリームへ CSV 形式でエクスポートします。
• protocols -- エクスポートするプロトコルのリスト
exportZones
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
exportZones
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
OutputStream outStream)
throws ImportExportException
ゾーンを指定された出力ストリームへ CSV 形式でエクスポートします。
exportFlavors
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
FlavorType flavorType,
File file)
throws ImportExportException
特定のフレーバ タイプを指定されたファイルへ CSV 形式でエクスポートします。
exportFlavors
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
FlavorType flavorType,
OutputStream outStream)
throws ImportExportException
特定のフレーバ タイプを指定された出力ストリームへ CSV 形式でエクスポートします。
• flavorType -- エクスポートされたフレーバのタイプ
exportServices
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File file)
throws ImportExportException
サービスをサービス コンフィギュレーションからファイルへ CSV 形式でエクスポートします。
exportServices
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
OutputStream outStream)
throws ImportExportException
サービスをサービス コンフィギュレーションから出力ストリームへ CSV 形式でエクスポートします。
• servConf -- サービスのエクスポート元となるサービス コンフィギュレーション
loadListArray
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
InputStream inStream)
throws ImportExportException
Deprecated -- 2.57 ホストおよび IP リストでのみ使用します。
• 2.57 CSV ホスト リスト ファイルを 3.0 CSV HTTP URL フレーバ ファイルに変換します。
• 2.57 CSV IP リスト ファイルを 3.0 CSV ゾーン ファイルに変換します。
3.0 CSV ファイルをロードするには、importFlavors（ServiceConfig、FlavorType、File）および importZones（ServiceConfig、File）を使用します。
Class ServiceConfigApi の概要
Class ServiceConfigApi では、Service Configuration API 方式を公開します。これらのすべての方式では、SCE に格納されたデータの取得または設定を行います。このため、SCE プラットフォームへの接続が必要です。
Class ServiceConfigApi 方式については、次のセクションで説明します。
Class ServiceConfigApi 方式
• 「retrieveServiceConfiguration」
applyServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
ServiceConfig servConf)
throws ElementManagementException,
ApplyException
サービス コンフィギュレーションを指定された SCE に適用します。
• connectionApi -- SCE への接続用ハンドルを保持する ConnectionApi
applyServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
ServiceConfig servConf,
Properties applySettings)
throws ElementManagementException,
ApplyException
サービス コンフィギュレーションを指定された SCE に適用します。
• connectionApi -- SCE への接続用ハンドルを保持する ConnectionApi
applyServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
• 「参照先」
ServiceConfig servConf,
boolean updateCm,
Properties cmIpRemap,
int cmUpdateMethod,
int rpcPort)
throws ElementManagementException,
ApplyException
サービス コンフィギュレーションを指定された SCE に適用します。
• connectionApi -- SCE への接続用ハンドルを保持する ConnectionApi
• servConf -- 適用するサービス コンフィギュレーション
• updateCm -- 指定された SCE 用の Collection Manager が指定されたサービス コンフィギュレーション値を使用してアップデートされたかどうか
• cmIpRemap -- SCE に設定された Collection Manager の IP アドレスから実際の Collection Manager のアドレスへのマップ
• cmUpdateMethod -- Collection Manager への接続に使用する方式
• rpcPort -- Collection Manager の RPC 接続に使用するポート番号
PolicyAPI.DC_UPDATE_METHOD_RPC , PolicyAPI.DC_DEFAULT_RPC_PORT
retrieveServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws IOException,
ElementManagementException,
ApplyException
指定された SCE にロードされたサービス コンフィギュレーションを取得します。
• connectionApi -- SCE への接続用ハンドルを保持する ConnectionApi
updateValuesIni
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
String sceAddress,
ServiceConfig servConf)
throws ApplyException
SCE プラットフォームのサービス コンフィギュレーションから取得したデータを使用して Collection Manager をアップデートします。
• cmAddress -- アップデートする Collection Manager のアドレス
• sceAddress -- 特定のサービス コンフィギュレーションを実行する SCE プラットフォームのアドレス
updateValuesIni
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
String sceAddress,
ServiceConfig servConf,
int cmUpdateMethod,
int rpcPort)
throws ApplyException
SCE プラットフォームのサービス コンフィギュレーションから取得したデータを使用して Collection Manager をアップデートします。
• cmAddress -- アップデートする Collection Manager のアドレス
• sceAddress -- 特定のサービス コンフィギュレーションを実行する SCE プラットフォームのアドレス
validateServiceConfiguration
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「参照先」
• servConf -- 検証するサービス コンフィギュレーション
エラーになる可能性のあるルールに対する警告メッセージを持つベクトル
PolicyValidator.validatePolicy(com.pcube.apps.engage.policy.Policy)
importServConf
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws ImportExportException,
IOException
exportServConf
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
File pqbfile)
throws FileNotFoundException,
ImportExportException
サービス コンフィギュレーションを PQB ファイルに保存します。
• servConf -- 保存するサービス コンフィギュレーション
importDefaultServConf
• 「構文」
• 「説明」
• 「戻り値」
• 「例外」
throws ImportExportException
Class ServiceConfig の概要
Class ServiceConfig は、ISP が定義したリスト、プロトコル、サービス、およびパッケージの包括的なセットです。サービス コンフィギュレーションは ServiceConfig ドメインの SCE プラットフォームに適用されます。また、アプリケーション パラメータを設定して加入者フローの調整を行います。
Class ServiceConfig 方式については、次のセクションで説明します。
Class ServiceConfig 方式
getCalendarList
• 「構文」
• 「説明」
• 「戻り値」
getClassificationCfg
• 「構文」
• 「説明」
• 「戻り値」
getDynamicSignatureScript
• 「構文」
• 「説明」
• 「戻り値」
getPackageList
• 「構文」
• 「説明」
• 「戻り値」
getPolicySettings
• 「構文」
• 「説明」
• 「戻り値」
サービス コンフィギュレーションの設定を取得します。これらの設定は、このサービス コンフィギュレーションのドメイン内にある SCE プラットフォーム用の一般的なシステム設定です。
getProtocolRedirectIndexNameArray
• 「構文」
• 「説明」
• 「戻り値」
getProtocolRedirectString
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
int redirectIndex)
throws ItemNotFoundException
リダイレクト ストリング アレイ内の特定のインデックス上にあるプロトコルに使用するリダイレクト アドレスを取得します。
リダイレクションはプロトコルの仕様の一部であり、少数の事前定義されたプロトコル用としてのみ存在します。
• protocolName -- クエリーされたプロトコル
• redirectIndex -- リダイレクト ストリング アレイのインデックス
• ItemNotFoundException -- このサービス コンフィギュレーションの ProtocolArray 内に該当する事前定義プロトコルが存在しない場合、またはリダイレクト インデックスが範囲外の場合
getRealTimeFrameName
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws ItemNotFoundException
特定の TimeFrame 用に事前定義された API 名を取得します。
• name -- TimeFrame 用のこのサービス コンフィギュレーションのエイリアス
• ItemNotFoundException -- このサービス コンフィギュレーションに該当するエイリアスが存在しない場合
getServiceList
• 「構文」
• 「説明」
• 「戻り値」
getSubNotifications
• 「構文」
• 「説明」
• 「戻り値」
getTimeFrameNames
• 「構文」
• 「説明」
• 「戻り値」
このサービス コンフィギュレーションによって異なる TimeFrame に割り当てられたタイムフレーム名を取得します。
これらのエイリアスでは、タイムフレームに意味のある名前を付けることができます。
getProtocolRedirectString
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws ItemNotFoundException
プロトコル用のデフォルトのリダイレクト アドレスを取得します。
リダイレクションはプロトコルの仕様の一部であり、少数の事前定義されたプロトコル用としてのみ存在します。
• protocolName -- クエリーされたプロトコル
• ItemNotFoundException -- このサービス コンフィギュレーションの ProtocolArray 内に該当する事前定義プロトコルが存在しない場合
getZoneList
• 「構文」
• 「説明」
• 「戻り値」
サービス コンフィギュレーションの IP、IP 範囲、およびホスト リスト アレイを取得します。これらのリストはこのサービス コンフィギュレーションのサービスによって参照されます。
isProtocolRedirectable
• 「構文」
• 「説明」
• 「パラメータ」
• 「戻り値」
• 「例外」
throws ItemNotFoundException
指定されたプロトコルがリダイレクションをサポートしているかチェックします。
リダイレクションはプロトコルの仕様の一部であり、少数の事前定義されたプロトコル用としてのみ存在します。
• protocolName -- クエリーされたプロトコルの名前
プロトコルがリダイレクションをサポートしている場合は true、それ以外は false
• ItemNotFoundException -- このサービス コンフィギュレーションの ProtocolArray 内に該当する事前定義プロトコルが存在しない場合
setProtocolRedirectString
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
int redirectIndex,
String value)
throws ItemNotFoundException,
MalformedURLException
一定のフローをリダイレクトするアドレスを設定します。要求されたプロトコルを使用する一部のサービス向けの ACCESS_BLOCK_AND_REDIRECT アクセス モードがルールに含まれる場合、リダイレクションが発生します。リダイレクト ストリング アレイ内に一定の String が発生すると設定が行われます。使用するリダイレクト String はリダイレクト ストリング アレイから決定されます。
• protocolName -- アクティビティがリダイレクトされるプロトコル
• redirectIndex -- プロトコルのリダイレクト ストリング アレイ内にあるリダイレクト String のインデックス
• ItemNotFoundException -- このサービス コンフィギュレーションの ProtocolArray 内に該当する事前定義プロトコルが存在しない場合、またはリダイレクト インデックスが範囲外の場合
setProtocolRedirectString
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
String value)
throws ItemNotFoundException,
MalformedURLException
一定のフローをリダイレクトするデフォルト アドレスを設定します。要求されたプロトコルを使用する一定のサービスに対する ACCESS_BLOCK_AND_REDIRECT アクセス モードがルールに含まれている場合、リダイレクションが発生します。
• protocolName -- アクティビティがリダイレクトされる要求プロトコル
• ItemNotFoundException -- このサービス コンフィギュレーションの ProtocolArray 内に該当する事前定義プロトコルが存在しない場合
setTimeFrameName
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
String newName)
throws ItemNotFoundException,
DuplicateItemException
特定のインデックスを持つ TimeFrame 用のエイリアスを設定します。
エイリアスでは、タイムフレームに意味のある名前を付けることができます。
• index -- エイリアスが与えられる TimeFrame のインデックス
setTimeFrameName
• 「構文」
• 「説明」
• 「パラメータ」
• 「例外」
String newName)
throws ItemNotFoundException,
DuplicateItemException
指定された TimeFrame 用のエイリアスを設定します。エイリアスでは、タイムフレームに意味のある名前を付けることができます。
• frame -- エイリアスが与えられる TimeFrame
setTimeFrameNames
• 「構文」
• 「説明」
• 「パラメータ」
Service Configuration API のプログラミングに関するガイドライン
SCE プラットフォームへの接続
いずれかの login() 方式を使用して作成した接続は、logout() によって適切に終了している必要があります（Class SCABB の概要を参照）。
Service Configuration API のコード例
ここでは、Service Configuration API の使用に関する複数のコード例を示します。
サービス コンフィギュレーションの適用
次の例では、新しいサービス コンフィギュレーションを、コマンドラインで指定された SCE プラットフォームに適用します。
import java.io.File;
import com.cisco.scabb.servconf.mgmt.ConnectionApi;
import com.cisco.scabb.servconf.mgmt.ImportExportApi;
import com.cisco.scabb.servconf.mgmt.SCABB;
import com.cisco.scabb.servconf.mgmt.ServiceConfig;
import com.cisco.scabb.servconf.mgmt.ServiceConfigApi;
import com.pcube.apps.engage.Connection;
import com.pcube.apps.engage.ConnectionFailedException;
/**
* applies the service configuration in the PQB file to the SCE
* specified in the command line. message is printed to standard error
* in case of failure.
* <p>
* usage: java examples.SimpleApplyPqb <sce-address><password>
* <pqb-filename>
*/
public class SimpleApplyPqb {
public static void main(String[] args) {
if (args.length != 3) {
System.err.println("usage: java examples.SimpleApplyPqb "
+ "<sce-address><password><pqb-filename>");
System.exit(1);
}
String sceAddress = args[0];
String password = args[1];
String pqbFilename = args[2];
ServiceConfig serviceConfig = openPqbFile(pqbFilename);
if (serviceConfig == null) {
return;
}
applyPqb(sceAddress, password, serviceConfig);
}
/**
* apply the service configuration in the specified PQB file to the
* specified SCE. message is printed to standard error in case of
* failure.
*
* @param sceAddress
* @param password
* @param serviceConfig
*/
private static void applyPqb(String sceAddress, String password,
ServiceConfig serviceConfig) {
ConnectionApi connection = null;
try {
System.out.println("connecting to SCE at " + sceAddress);
connection = SCABB.login(sceAddress, "admin", password,
Connection.SE_DEVICE);
System.out.println("connected to SCE");
System.out.println("applying service configuration");
ServiceConfigApi.applyServiceConfiguration(connection,
serviceConfig);
System.out.println("service configuration applied");
} catch (ConnectionFailedException e) {
System.err.println("connection to SCE failed: "
+ e.getMessage());
e.printStackTrace();
} catch (Exception e) {
System.err.println("apply operation failed: "
+ e.getMessage());
e.printStackTrace();
} finally {
if (connection != null) {
System.out.println("disconnecting from SCE");
SCABB.logout(connection);
System.out.println("disconnected");
}
}
}
/**
* return the service configuration in the specified PQB file, or
* null if reading the file has failed. message is printed to
* standard error in case of failure.
*
* @param pqbFilename
* @return
*/
private static ServiceConfig openPqbFile(String pqbFilename) {
ServiceConfig serviceConfig = null;
try {
System.out.println("opening PQB file " + pqbFilename);
serviceConfig = ImportExportApi
.importServiceConfiguration(new File(pqbFilename));
System.out.println("PQB file opened");
} catch (Exception e) {
System.err.println("opening PQB file failed: "
+ e.getMessage());
e.printStackTrace();
}
return serviceConfig;
}
}
ゾーンの自動アップデート
次の例では、ゾーン IP アドレスを使用して SCE をアップデートします。ゾーン IP アドレスは CSV ファイルで指定されます。
import java.io.File;
import com.cisco.scabb.servconf.mgmt.ConnectionApi;
import com.cisco.scabb.servconf.mgmt.ImportExportApi;
import com.cisco.scabb.servconf.mgmt.SCABB;
import com.cisco.scabb.servconf.mgmt.ServiceConfig;
import com.cisco.scabb.servconf.mgmt.ServiceConfigApi;
import com.cisco.scasbb.backend.classification.Zone;
import com.pcube.apps.engage.Connection;
import com.pcube.apps.engage.ConnectionFailedException;
import com.pcube.apps.engage.common.ImportExportException;
/**
* updates an SCE with zone IP addresses. the zone IP address are
* specified in a CSV file. the SCE address and CSV filename are taken
* from the cmd-line argument.
* <p>
* usage: java examples.UpdateZoneFromCsv <sce-address><password>
* <zone-csv-file><zone-name>
*
*/
public class UpdateZoneFromCsv {
public static void main(String[] args) {
if (args.length != 4) {
System.err.println("usage: java examples.UpdateZoneFromCsv"
+ " <sce-address><password>"
+ " <zone-csv-file><zone-name>");
System.exit(1);
}
String sceAddress = args[0];
String password = args[1];
String csvFilename = args[2];
String zoneName = args[3];
ServiceConfig serviceConfig = retrievePqb(sceAddress, password);
if (serviceConfig == null) {
return;
}
ServiceConfig updatedServiceConfig = importZoneFromCsv(
serviceConfig, csvFilename, zoneName);
if (updatedServiceConfig == null) {
return;
}
applyPqb(sceAddress, password, updatedServiceConfig);
}
/**
* apply the service configuration in the specified PQB file to the
* specified SCE. message is printed to standard error in case of
* failure.
*
* @param sceAddress
* @param password
* @param serviceConfig
*/
private static void applyPqb(String sceAddress, String password,
ServiceConfig serviceConfig) {
ConnectionApi connection = null;
try {
System.out.println("connecting to SCE at " + sceAddress);
connection = SCABB.login(sceAddress, "admin", password,
Connection.SE_DEVICE);
System.out.println("connected to SCE");
System.out.println("applying service configuration");
ServiceConfigApi.applyServiceConfiguration(connection,
serviceConfig);
System.out.println("service configuration applied");
System.err.println("connection to SCE failed: "
+ e.getMessage());
e.printStackTrace();
} catch (Exception e) {
System.err.println("apply operation failed: "
+ e.getMessage());
e.printStackTrace();
} finally {
if (connection != null) {
System.out.println("disconnecting from SCE");
SCABB.logout(connection);
System.out.println("disconnected");
}
}
}
private static ServiceConfig importZoneFromCsv(
ServiceConfig serviceConfig, String csvFilename,
String zoneName) {
// clear zone items
Zone zone = (Zone) serviceConfig.getClassificationCfg()
.getZoneList().findByName(zoneName);
if (zone == null) {
System.err.println("WARNING: zone not found: " + zoneName);
} else {
zone.getZoneItems().clear();
}
// import new zone items
try {
ImportExportApi.importZones(serviceConfig, new File(
csvFilename));
} catch (ImportExportException e) {
System.err.println("importing zones failed: "
+ e.getMessage());
e.printStackTrace();
return null;
}
return serviceConfig;
}
private static ServiceConfig retrievePqb(String sceAddress,
String password) {
ServiceConfig retrievedServiceConfig = null;
ConnectionApi connection = null;
try {
System.out.println("connecting to SCE at " + sceAddress);
connection = SCABB.login(sceAddress, "admin", password,
Connection.SE_DEVICE);
System.out.println("connected to SCE");
System.out.println("retrieving service configuration");
retrievedServiceConfig = ServiceConfigApi
.retrieveServiceConfiguration(connection);
System.out.println("service configuration retrieved");
} catch (ConnectionFailedException e) {
System.err.println("connection to SCE failed: "
+ e.getMessage());
e.printStackTrace();
} catch (Exception e) {
System.err.println("retrieve operation failed: "
+ e.getMessage());
e.printStackTrace();
} finally {
if (connection != null) {
System.out.println("disconnecting from SCE");
SCABB.logout(connection);
}
}
return retrievedServiceConfig;
}
}
サービス名およびパッケージ名のリスト
次の例では、サービス コンフィギュレーション内のサービス名およびパッケージ名を出力します。
import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import com.cisco.scabb.servconf.mgmt.ImportExportApi;
import com.cisco.scabb.servconf.mgmt.ServiceConfig;
import com.cisco.scabb.servconf.mgmt.ServiceConfigApi;
import com.pcube.apps.engage.common.ImportExportException;
import com.pcube.apps.engage.policy.Package;
import com.pcube.apps.engage.policy.Service;
public class IterateServiceConfig {
public static void main(String[] args)
throws ImportExportException, IOException {
// take the PQB filename from the cmd-line, or use the default
// service configuration instead
ServiceConfig serviceConfig = null;
if (args.length >0) {
serviceConfig = ImportExportApi
.importServiceConfiguration(new File(args[0]));
} else {
serviceConfig = ServiceConfigApi.importDefaultServConf();
}
System.out.println("-------- package names --------");
Iterator pkgIter = serviceConfig.getPackageList().iterator();
while (pkgIter.hasNext()) {
Package pkg = (Package) pkgIter.next();
System.out.println(pkg.getNumericId() + ": "
+ pkg.getName());
}
System.out.println("-------- service names --------");
Iterator svcIter = serviceConfig.getServiceList().iterator();
while (svcIter.hasNext()) {
Service svc = (Service) svcIter.next();
System.out.println(svc.getNumericId() + ": "
+ svc.getName());
}
}
}
フィードバック