Cisco Unified Provisioning Manager Northbound Interface プログラマー ガイド
共通の Provisioning Manager NBI
共通の Provisioning Manager NBI
発行日;2012/02/26 | 英語版ドキュメント(2010/10/13 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 768KB) | フィードバック

目次

共通の Provisioning Manager NBI

の概要

管理対象オブジェクト

オブジェクト キー

要求名の概要

オブジェクト アトリビュートの概要

要求の引数の概要

設定可能なプロパティ

オブジェクト

インフラストラクチャ製品のキー アトリビュート

加入者製品のキー アトリビュート

製品カタログからの製品アトリビュートの参照

要求

要求シグニチャ クラス

デバイス管理コマンドおよびクエリー

createDevice Java シグニチャ

getDevice Java シグニチャ

updateDevice Java シグニチャ

listDevice Java シグニチャ

deleteDevice Java シグニチャ

getConfiguredInfraProduct Java シグニチャ

listConfiguredInfraProducts Java シグニチャ

ドメイン管理コマンドおよびクエリー

createDomain Java シグニチャ

getDomain Java シグニチャ

updateDomain Java シグニチャ

listDomain Java シグニチャ

deleteDomain Java シグニチャ

サービス エリア文字列管理コマンドおよびクエリー

createServiceArea Java シグニチャ

getServiceArea Java シグニチャ

updateServiceArea Java シグニチャ

listServiceArea Java シグニチャ

deleteServiceArea Java シグニチャ

同期化管理コマンド

syncDevice Java シグニチャ

syncDomain Java シグニチャ

加入者管理コマンドおよびクエリー

createSubscriber Java シグニチャ

createSubscribers Java シグニチャ

getSubscriber Java シグニチャ

updateSubscriber Java シグニチャ

listSubscriber Java シグニチャ

deleteSubscriber Java シグニチャ

resetSubscriberServicePassword Java シグニチャ

listSubscriberService Java シグニチャ

getSubscriberService Java シグニチャ

NBI オブジェクト メタデータの概要

ワーク オーダー管理コマンドおよびクエリー

submitOrder Java シグニチャ

getOrder Java シグニチャ

listOrder Java シグニチャ

接続チェック要求

ping Java シグニチャ

インベントリ クエリー

getInventoryItem Java シグニチャ

listInventoryItem Java シグニチャ

事前入力

listProductAttributeChoice Java シグニチャ

ステータス クエリー

getApiStatus Java シグニチャ

listApiStatus Java シグニチャ

特殊な要求

listSrstPhoneInfo Java シグニチャ

getOrderSummary Java シグニチャ

submitConfigTemplate Java シグニチャ

listConfigTemplateKeyword Java シグニチャ

WS-Enumeration 要求

pullOp Java シグニチャ

renewOp Java シグニチャ

getStatusOp Java シグニチャ

releaseOp Java シグニチャ

WS-Notification の 実装

通知ユーザ サービス

共通の Provisioning Manager NBI

この章では、すべてのサービスに共通する Provisioning Manager NBI の操作について説明します。

この章の内容は、次のとおりです。

「Provisioning Manager NBI の概要」

「管理対象オブジェクト」

「Provisioning Manager NBI オブジェクト」

「Provisioning Manager NBI 要求」

Provisioning Manager NBI の概要

Provisioning Manager NBI では、次が使われます。

SOAP HTTP バインディングによる WSDL/XSD(Web サービスとして公開される)

トランスポート層としての HTTPS

HTTP

WSDL 1.1

SOAP 1.2

AXIS2 1.3

XMLBeans バインディング フレームワーク

次の Web サービスの部分:WS-Notification、WS-Enumeration、WS-Security、WS-BaseFaults、WS-Resource、WS-Addressing

表 2-1 に、参照される XML スキーマを示します。

 

表 2-1 参照される XML スキーマ

プレフィクス
仕様
URL

soap

SOAP 1.2

http://schemas.xmlsoap.org/soap/envelope/

http://schemas.xmlsoap.org/wsdl/soap/

wsdl

WSDL 1.1

http://schemas.xmlsoap.org/wsdl/

xml

--

http://www.w3.org/XML/1998/namespace

xs または xsd

XML Schema

http://www.w3.org/2001/XMLSchema

wsrf

WS Resource Framework

http://docs.oasis-open.org/wsrf/rw-2

wsbf

WS-BaseNotification

http://docs.oasis-open.org/wsd/bw-2

wsrf-bf

WS-BaseFaults

http://docs.oasis-open.org/wsfr/bf-2

wsa

WS-Addressing

http://www.w3.org/2005/08/addressing

wsen

WS-Enumeration

http://schemas.xmlsoap.org/ws/2004/09/enumeration

wsse

WS-Security 1.1

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

WS-ResourceProperties

http://docs.oasis-open.org/wsrf/rpw-2

wsrf-bf

WS-BaseFaults

http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2-draft-01.xsd

co-v1-3

Tigerstripe

http://ossj.org.xml.Common/v1-3

管理対象オブジェクト

完全管理対象オブジェクトは、NBI 要求によって、作成、更新、読み取り(取得)、表示、削除ができます。部分管理対象オブジェクトは読み取り(取得)と表示ができます。オブジェクトは、特定のアトリビュートとメタデータ アトリビュート/値のペアの配列を組み合わせたものです。NBI オブジェクト メタデータでは、アトリビュート名がタグではなく、値とペアのデータ フィールドです(メタデータの詳細については 「NBI オブジェクト メタデータの概要」を参照してください)。

これらのペアは、特定のデータ スコープに関するアトリビュート項目の配列としてスキーマに定義されます。たとえば、デバイス オブジェクトの ArrayOfDevicePropertiesValue アトリビュートは、デバイスのプロパティの名前と値を定義します。値は単独か、1 つ以上の一意の設定の配列で指定できます。ほとんとの場合、有効なプロパティ名は列挙で定義され、サーバによってチェックされます。

各 NBI 要求内の XML オブジェクトは SAX パーサーを使用して、XSD 定義に照らして検証されます。

次の Provisioning Manager インフラストラクチャ オブジェクトは完全管理対象です。

Device:IPT 機能を持つネットワーク エンティティ

Domain:共通管理用に分割されたネットワーク

Service Area:加入者向けデバイス サービス

Subscriber:Provisioning Manager エンド ユーザ

次はクエリー専用オブジェクトです。

InventoryItem:Provisioning Manager が InventoryManager によって保持するオブジェクトを表す汎用メタデータ オブジェクトを取得するシン AXIS インターフェイス。検索を容易にするため、関連付けられたオブジェクトがそれらの名前とアトリビュートで参照されます。

ServiceDetail:デバイスに設定されたサービスを表します。これは、製品と、ドメイン、サービス エリア、加入者情報などのその他の情報を格納します。XSD の製品オブジェクトは製品を表します。サービスは、ネットワーク設定をサポートするデバイス インフラストラクチャ設定済み製品、または各ユーザをサポートする加入者サービスに基づきます。

次に送信オブジェクトおよびクエリー オブジェクトを示します。

Order:ワーク オーダーを送信でき、そのステータスを追跡できます。

Nbi Request:NBI 要求を取得でき、そのステータスを追跡できます。NBI 要求は実行の完了後まもなく消去されます。ipt.properties ファイルで消去期間を変更できます。

次に送信オブジェクトとクエリー ヘルパー オブジェクトを示します。

CupmApiList:クライアントにオブジェクトのリストを返すために使用される汎用コンテナ

CupmApiFilter:Provisioning Manager NBI リスト コマンドに使用される特定のフィルタ。オブジェクト選択基準と、各オブジェクトと一緒に返されるオブジェクト アトリビュート名を指定します。

次に外部機能オブジェクトを示します。

CupmApiResponseValue:クライアントが基本検証に合格した NBI 要求を送信する際に同時に返されるデータ構造。NBI ID を格納します。

CupmApiResultValue:サーバが NBI 要求の実行を完了したときに非同期に返されるデータ構造

CupmApiStatus:NBI 要求の終了ステータスを示す CupmApiResultValue 内のオブジェクト。NBI 要求のクエリー時にも返されるデータです。

CupmApiFaultType:WS-BaseFault 仕様の拡張。要求の実行の非同期部分で、要求が失敗した場合に、Provisioning Manager サーバからのエラー情報が格納されます。

オブジェクト キー

オブジェクトは、それらのキー アトリビュートによって一意に識別されます。管理対象オブジェクトにはそのキーとしてアトリビュートが 1 つだけあります。

要求名の概要

Provisioning Manager NBI 要求は常に「動詞名詞」の形式になります。

次のリストに、基本オブジェクト管理の動詞を示します。

Create

Get

Update

Delete

List

syncDomain や resetSubscriberServicePassword などの特殊なコマンドには、特別な動詞が使われます。

基本オブジェクト管理の名詞はクラスです。名詞は、特殊なコマンドのアトリビュートや概念を示すことがあります。

オブジェクト アトリビュートの概要

XSD ファイルに指定された Provisioning Manager NBI オブジェクトは常に Java POJO ファイルに変換されます。そのためすべての NBI 要求に対応する Java シグニチャおよびすべての XSD 定義オブジェクトに対応する Java Provisioning Manager NBI オブジェクトがあります。

Provisioning Manager NBI オブジェクトの構造は、特定のデータとメタデータを組み合わせたものになっています。一意の設定が必要なすべてのアトリビュートは、オブジェクトに明示的に定義します。これらのアトリビュートはオブジェクトの外部キーです。

他のすべてのアトリビュートは、オブジェクト内で名前と値のメタデータ構造になります。多くのクラスでは、これらのメタデータ オブジェクトを指定する必要はありません。

関連付けられたすべてのオブジェクトはそれらのキーによって参照されます。オブジェクトの入れ子構造はありません。

要求の引数の概要

Create<Object>

Create NBI 要求は常に引数として管理対象オブジェクトをとります。作成のためのキー アトリビュートおよび必須アトリビュートをオブジェクトに指定する必要があります。他のすべてのアトリビュートはそれらの初期設定で指定できます。

Get<Object>

Get NBI 要求は常に最初の引数として管理対象オブジェクトをとります。クライアントは、一意のキーを定義する特定のアトリビュートのみを設定します。メタデータ アトリビュートは必要ありません。

Delete<Object>

Delete NBI 要求は常に最初の引数として管理対象オブジェクトをとります。クライアントは、一意のキーを定義する特定のアトリビュートのみを設定します。メタデータ アトリビュートは必要ありません。

Update<Object>

Update NBI 要求は最初の引数として管理対象オブジェクトをとります。ユーザはオブジェクトに明示的に定義されるアトリビュートを設定する必要があります。指定する必要があるメタデータ アトリビュートは、クライアントが変更しようとするアトリビュートだけです。

複数の値を持つアトリビュートから特定の値を削除する場合、更新するアトリビュートのピアであるアクション アトリビュートがあります。アクション アトリビュートを REMOVE に設定します。削除する値は、それらのキー アトリビュートによって指定します。

List<Object>

List NBI 要求は引数として CupmApiFilter オブジェクトをとります。フィルタには、選択基準を定義するアトリビュート名と値のメタデータのペアが含まれます。メタデータをグループ化して、1 つの「and」または 1 つの「or」クエリーをサポートすることができます。NULL フィルタはそのオブジェクトのすべてのインスタンスのリストを生成する場合に使用できます。

フィルタには、クライアントがオブジェクト キーのリスト、特定の一連のアトリビュート、または完全なオブジェクトのリストのどれが返されることを必要とするかを示すフラグもあります。デフォルトはオブジェクト キーのみを返します。

設定可能なプロパティ

オブジェクト Domain、Device、Service Area、Subscriber 内のメタデータの設定可能なプロパティは、XSD ファイルに列挙で定義されます。詳細については、提供されている html ドキュメントを参照してください。

html ファイルは SDK のサブディレクトリ html-doc フォルダ内にあります。html-doc フォルダには、そのオブジェクトやカテゴリの要求をサポートするサブディレクトリがあります。たとえば、createDevice、listDevice などについては、Device フォルダに移動します。該当するディレクトリの html ファイルをクリックして、ドキュメントを表示します。

Provisioning Manager NBI オブジェクト


) オブジェクトは命名規則 <object>Value で従来からインターフェイスでサポートされています。


Device

キー アトリビュート:deviceName

完全オブジェクト定義ファイル:Device.xsd

Domain

キー アトリビュート:domainID

完全オブジェクト定義ファイル:Domain.xsd

ServiceArea

キー アトリビュート:serviceAreaID

完全オブジェクト定義ファイル:ServiceArea.xsd

InventoryItem

クエリーでは、Inventory Manager 内の任意のオブジェクトを参照できます。

キー アトリビュート:InventoryItem オブジェクトは Provisioning Manager IM オブジェクト タイプに設定されます。オブジェクト タイプのキー アトリビュートには、メタデータ アトリビュート名と値があります。get API または list API の場合に、オブジェクトを一意に識別する IM クラス名とアトリビュート値を指定する必要があります。その他のアトリビュートが指定されていない場合、複数のインスタンスが返されます。

完全オブジェクト定義ファイル:InventoryItem.xsd

ServiceDetail

クエリーでは、設定済みのインフラストラクチャ製品または加入者サービス製品を、get または list 要求で返すことができます。

キー アトリビュート:get service 要求のキー アトリビュートは、keyAttribute というアトリビュート内にメタデータの配列として指定されます。特定の製品の特定のキーについては、このマニュアルのサービス テーブルを参照してください。製品のキーを判断するもう 1 つの方法は、デバイスまたは加入者のすべての製品をリスト表示することです。このリストは、キーとそれらの値のみを返します。

完全オブジェクト定義ファイル:Order.xsd

Order

ワーク オーダー ID は Provisioning Manager サーバの内部でのみ使用されます。ユーザ インターフェイスまたはバッチ プロビジョニングによって送信されたオーダーは、追跡目的でオーダー ID を生成します。

Provisioning Manager クライアントは NBI ID を使用してワーク オーダーをクエリーします。getOrder API を使用して、追跡目的でオーダー ID または NBI ID をとることができます。

完全オブジェクト定義ファイル:Order.xsd

Subscriber

キー アトリビュート:subscriberID

完全オブジェクト定義ファイル:Subscriber.xsd

CupmApiListValue

NBI 要求がデータを返す場合、追加のオブジェクトがこのコンテナに入れられます。このオブジェクトは、列挙で処理されるすべてのクエリーを返す場合に使用されます。

これは、事前入力選択リストを返す場合にも使用されます。

完全オブジェクト定義ファイル:Common.xsd

CupmApiResponseValue

ApiReponse オブジェクトは Provisioning Manager サーバに正常に送信されたすべての Provisioning Manager NBI 要求に対して同時に返されるオブジェクトです。

表 2-2 に CupmApiResponseValue のオブジェクト アトリビュートを示します。

 

表 2-2 CupmApiResponseValue オブジェクト アトリビュート

アトリビュー名
アトリビュート タイプ
説明

ApiId

String

新しい NBI 要求の受け付け時に Provisioning Manager サーバによって生成される Provisioning Manager サーバ内の一意の ID。Provisioning Manager サーバは新しい NBI 要求ごとに増加される Long 型整数を割り当てます。この整数は 10 分後にリセットされます。すべての NBI 要求には、生成された数字の先頭にオプションの文字列を追加するパラメータがあります。

startTime

time/date

サーバが NBI 要求を受け付けた UTC 時間

Result

CupmApiResultValue

初期リリースでは使用されていません。

フレームワークは Provisioning Manager NBI 要求の同時実行をサポートします。このアトリビュートは常に NULL です。

完全オブジェクト定義ファイル:Common.xsd

CupmApiResultValue

表 2-3 に CupmApiResultValue のオブジェクト アトリビュートを示します。

 

表 2-3 CupmApiResultValue オブジェクト アトリビュート

アトリビュー名
アトリビュート タイプ
説明

status

CupmApiStatusValue

Provisioning Manager によって実行された NBI 要求の最終ステータスを示す関連 CupmApiStatus オブジェクト。NBI ID がこのオブジェクトに含まれます。

data

CupmApiListValue

NBI 要求が返すことになっていたデータを格納する関連 CupmApiList オブジェクト

error

CupmApiFaultType

応答の送信後、NBI 要求が失敗した場合、NBI 例外オブジェクトが存在し、問題が示されます。NBI 要求が正常に実行された場合、これは NULL になります。

完全オブジェクト定義ファイル:Common.xsd

CupmApiStatusValue

表 2-4 に CupmApiStatusValue のオブジェクト アトリビュートを示します。

 

表 2-4 CupmApiStatusValue オブジェクト アトリビュート

アトリビュー名
アトリビュート タイプ
説明

apiId

String

NBI ID

status

ENUM

NBI 要求のステータス

message

String

正常に実行された NBI 要求からの情報または警告メッセージ

startTime

time/date

サーバが NBI 要求を受け付けた UTC 時間

completeTime

time/date

サーバが NBI 要求を完了した UTC 時間

OrderDetailStatus

OrderStatus

SubmitOrder NBI コマンドの添付(任意のタイプ)

表 2-5 に CupmApiStatusValue アトリビュートの状態コードを示します。

 

表 2-5 CupmApiStatusValue アトリビュートの状態コード ENUM

状態
説明

SUBMITTED

Provisioning Manager NBI 要求は Provisioning Manager サーバによって受信されました。同期メッセージ交換はまだ完了していません。

REJECTED

Provisioning Manager NBI 要求は NbiManager によって拒否され、例外がクライアントに返されました。

PENDING

Provisioning Manager NBI 要求は ApiManager によって受け付けられ、API ID が割り当てられました。実行は進行中です。

COMPLETED_SUCCESSFULLY

Provisioning Manager NBI は正常に完了しました。

COMPLETED_FAILURE

Provisioning Manager NBI は失敗しました。失敗は一部か全体です。

オーダーの場合、各製品の詳細手順に関する情報をオーダーに提供する追加のステータス オブジェクトが添付されます。

完全オブジェクト定義ファイル:Common.xsd

CupmApiFilterValue

CupmApiFilter には 3 つのセクションがあります。

Object Selection Criteria for primary object:返すオブジェクト インスタンスを定義します。

データの選択のためのアトリビュート名と値を指定する汎用メタデータ構造。

論理「積」または論理「和」によって上記の基準を適用するかどうかを示す And/Or フラグ。

Object Selection Criteria for associated object:リスト選択のオブジェクト タイプに 1 つ以上の関連オブジェクトがある場合、これらのいずれかのオブジェクトを選択して、リスト オブジェクト タイプに加えて、このオブジェクトに選択基準を適用できます。

関連オブジェクト タイプを格納する文字列

データの選択のためのアトリビュート名と正規表現を指定する汎用メタデータ構造。最初の選択基準の and/or フラグがここにも適用されます。

Object Attributes Returned Criteria:選択したオブジェクトの返される必要があるアトリビュートを指定します。

キー アトリビュートのみ、すべてのアトリビュート、または選択したアトリビュートを返すことを示す ENUM

上の選択で必要な場合に、適用されるアトリビュート リスト。このリストのキー アトリビュートおよびすべてのアトリビュートが返されます。

CupmApiFilter クラスを使用して、NBI リスト コマンドで返されるリストの許容基準を定義します。

フィルタにはメタデータのアトリビュート名と値のペアが含まれます。値は特定の値または正規表現に設定可能な文字列です。メタデータをグループ化して、「and」または「or」クエリーをサポートすることができます。NULL フィルタはそのオブジェクトのすべてのインスタンスのリストを生成する場合に使用できます。サポートされる文字列については、「インフラストラクチャ製品のキー アトリビュート」を参照してください。

表 2-6 に CupmApiFilterValue のアトリビュートを示します。

 

表 2-6 CupmApiFilterValue アトリビュート

アトリビュー名
アトリビュート タイプ
説明

returnedDataCriteriaValue

ENUM

各オブジェクトと一緒に返されるアトリビュートを指定します。

KEY_AND_SPECIFIED

KEYS_ONLY

ALL

additionalStatus

anyType

additionalStatus アトリビュートに対して、サーバによって返される値はタイプ ServiceDetailStatus のみです。ServiceDetailStatus は、ワーク オーダーの各詳細の現在のステータスを格納します。

完全オブジェクト定義ファイル:Common.xsd

インフラストラクチャ製品のキー アトリビュート

表 2-7 にインフラストラクチャ製品のキー アトリビュートを示します。表示されていないインフラストラクチャ製品にはキー アトリビュートがありません。

 

表 2-7 インフラストラクチャのキー アトリビュート

インフラストラクチャ製品
キー アトリビュート

Call Park

IC_pattern

Call Pickup Group

IC_name

Calling Search Space

IC_name

Common Device Config

IC_name

CTI Route Point

IC_name

Device Pool

IC_name

H323 Gateway

IC_name

Hunt List

IC_name

Hunt Pilot

IC_pattern

Line Group

IC_name

Location

IC_name

Media Resource Group

IC_name

Media Resource Group List

IC_name

Route Group

IC_name

Route List

IC_name

Route Partition

IC_name

Route Pattern

IC_pattern/IC_routePartitionName

SIP Trunk

IC_name

Translation Pattern

IC_pattern/IC_routePartitionName

Unified CM Group

IC_name

Voicemail Pilot

IC_drin/IC_cssName

Voicemail Profile

IC_name

Voice Region

IC_name

加入者製品のキー アトリビュート

表 2-8 に加入者製品のキー アトリビュートを示します。表示されていない加入者製品にはキー アトリビュートがありません。

 

表 2-8 加入者のキー アトリビュート

加入者製品
キー アトリビュート

Phone

type(Cisco_7970 など)

macaddress(Cisco_IP_Communicator、CTI_Port、CUPC を除くすべての電話機タイプ)

devicename(Cisco_IP_Communicator、CTI_Port、CUPC の電話機タイプのみ)

Line

directorynumber

routepartition

selectedPhone1

LineOnSharedPhone

directorynumber

routepartition

targetphone 1

EM_Access

name

EM_Line

directorynumber

routepartition

SelectedEM_Access

Voicemail

VoicemailAlias

Email

Alias

UnifiedMessaging

SelectedEmail

1.すべての selectedPhone および targetPhone 名は MAC アドレスです。MAC アドレスは 12 個の 16 進数の文字(0 ~ 9 および A ~ F)から構成されます。Cisco Unified Communications Manager 上の物理的な電話機の場合、名前は SEP が前に付いた MAC アドレス(たとえば SEPAAAA00001111)または TAPS 電話機の場合 BAT が前に付いた MAC アドレス(たとえば BATAAAA00001111)になります。Cisco Unified Communications Manager Express 上の物理的な電話機の場合、MAC アドレスの前には何も付きません。


) キーとすべての製品アトリビュートを含む XML 戻りオブジェクトの場合、既存のサービスをクエリーする getSubscrberService 要求および getConfiguredInfraProduct 要求、または加入者とデバイスのそれぞれに対する listSubscriberService 要求および listConfiguredInfraProduct 要求を、すべてのアトリビュートを返すように設定したフィルタを使用して送信します。


製品カタログからの製品アトリビュートの参照

製品カタログは Provisioning Manager を使用してオーダー可能なすべてのインフラストラクチャ製品と加入者製品を定義します。製品の定義は、productdirectory¥schema ディレクトリの product_catalog_translated.xsd ファイルにあります。オーダー可能な各製品については productcatalog¥metadata フォルダ内のファイルに定義されています。たとえば、HuntList ファイル名は CUPMProduct_IC_HuntList.xml です。

すべての製品について、アトリビュート名とタイプがこれらのファイルに定義されています。各ファイルの <product> タグは製品名を定義し、<productAttribute> タグは製品アトリビュート名を定義します。<productAttribute> タグの ID をデータ ファイルで使う必要があります。<productAttribute> タグの <name> タグはアトリビュートの実行する動作を説明します。

製品カタログに定義されている製品プロビジョニング アトリビュートを NBI SubmitOrder 要求で指定できます。

たとえば、sample¥xml ディレクトリ内の SubmitOrderAddPhonesWithLines.xml ファイルには電話機と回線を追加するための XML 要求の例が含まれています。XML 要求は ID 電話機および ID 回線をプロビジョニングします。

MLPP No Answer Ring Duration を設定する場合、productcatalog¥metadata ディレクトリ内の CUPMProduct_line.xml ファイルを参照してください。この機能のプロビジョニング アトリビュートは mlppnard で、整数を格納します。

回線にこの機能を設定するには、次の XML コードを回線 productID に追加します。

<item>
<attributeID>mlppnard</attributeID>
<attributeValue>
<co-v1-3:item>3</co-v1-3:item>
</attributeValue>
</item>
 

これにより回線に MLPP No Answer Ring Duration が 3 つのリングに設定されます。

検証アトリビュートを使用して、指定した設定が有効な範囲内であるかどうかを検証できます。サーバはオーダーを検証しますが、ワークフローには影響しません。設定が有効な範囲内にある場合、成功通知を受け取り、有効な範囲内にない場合は、失敗のメッセージを受け取ります。

インフラストラクチャ製品の例については、ハント リストおよびハント パイロットの説明を設定することを考慮してください。

ハント リストおよびハント パイロットの場合、説明のアトリビュート名は IC_description です。IC_description アトリビュートを追加するには、次の XML コードをいずれかの製品 ID に追加します。

<item>
<attributeID>IC_description</attributeID>
<attributeValue>
<co-v1-3:item>My Description</co-v1-3:item>
</attributeValue>
</item>
 

ハントリストを有効にするには、次のアトリビュートを追加します。次は製品カタログ ファイル CUPMProduct_IC_HuntList.xml から取得したものです。

<productAttribute>
<id>IC_routeListEnabled</id>
<name>Enable this Hunt List</name>
 

データ ファイルでのこのアトリビュートの例は次のようになるはずです。

<<item>
<attributeID>IC_routeListEnabled </attributeID>
------------------------------
-------------------------------
</item>

) 製品カタログ内のすべてのアトリビュート名は大文字と小文字が区別されます。ほとんどの場合、ブール型定数も大文字と小文字が区別されます。


Provisioning Manager NBI 要求

すべての要求は同時に CupmApiResponseValue オブジェクトを返すか、例外をスローします。スローされる例外は WSDL/XSD または NbiManager によって生成されます。

すべての NBI 要求は非同期に CupmApiList オブジェクトを返します。CupmApiList の最初の要素は CupmApiStatus オブジェクトです。2 番目の要素は要求された戻りデータ(存在する場合)です。

要求シグニチャ クラス

Provisioning Manager NBI は WSDL および XSD ファイルに正式に定義されます。各 NBI 要求には通常の Java シグニチャがあります。要求は Java クラス メソッド コールとしてコード化できます。要求オブジェクト内のピアの子オブジェクトはメソッドへの Java パラメータになります。

SDK に提供されている RequestSignature クラスはこの Java 要求シグニチャ インターフェイスを定義します。サーバに接続するために、最初の引数として CUPMService スタブが常に必要です。このスタブを生成するユーティリティ コマンドもこのクラスに提供されています。このクラスは返されるデータのサブクラスも提供します。初期応答ドキュメントと抽出された CupmApiResultValue(該当する場合)の両方が返されます。

Java シグニチャには、XSD シグニチャと異なるいくつかの一貫した変更があります。これにより Java 環境で要求の生成が簡単になります。

次に一貫したシグニチャの変更を示します。

EPR は文字列で渡されます。RequestSignature クラスは文字列を自動的に Address オブジェクトを含む EPR に変換します。

列挙値は文字列で渡されます。

元の応答ドキュメントと添付された CupmApiResultValue の両方を返す ResponseReturn クラスを提供します。

次の項では、RequestSignature クラスに定義されている各要求の Java シグニチャを示します。

デバイス管理コマンドおよびクエリー

Provisioning Manager NBI は Provisioning Manager デバイス オブジェクトの完全管理をサポートします。

createDevice Java シグニチャ

新しいデバイスを作成します。

構文:

public ResponseReturn createDevice (CUPMService stub, DeviceValue device, String endPointReference, String idPrefix);

パラメータ:

device:アトリビュート キーおよびアトリビュート名と値のペアがそれらの初期値に設定されているデバイス オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

CreateDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus を格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

getDevice Java シグニチャ

デバイスを取得します。

構文:

public ResponseReturn getDevice (CUPMService stub, DeviceValue device, String endPointReference, String idPrefix);

パラメータ:

device:キー アトリビュートが取得するオブジェクトに設定されているデバイス オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は get の結果である 1 つのデバイス オブジェクトを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

updateDevice Java シグニチャ

デバイスを更新します。

構文:

public ResponseReturn updateDevice (CUPMService stub, DeviceValue device, String endPointReference, String idPrefix);

パラメータ:

device:更新するオブジェクトを識別するために設定されたキー アトリビュートと、新しい値に更新されるすべてのアトリビュートの名前と値のペアを持つデバイス オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

UpdateDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) デバイスから機能を削除するには、デバイス オブジェクト内の機能を指定し、capabilityAction アトリビュートを REMOVE に設定します。デバイスに最後に割り当てられている機能は削除できないので注意してください。


listDevice Java シグニチャ

一連のデバイスを選択します。

構文:

public ResponseReturn listDevice (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:オブジェクト選択基準と返されるデバイス オブジェクト アトリビュートを定義します。バージョンのみを入力した場合、エラーが返されます。バージョンベースのクエリーは capabilityName に依存するため、capabilityName も入力する必要があります。

次のアトリビュートを使用してフィルタできます。

DBPort

ExtensionMobilityServiceName

DeviceUsername

DoNotCreateLDAPUser

Type

CapabilityUsername

CapabilityName

CUELineUsername

ServiceEngineInterfaceNumber

DeviceName

ExtensionMobilityServiceURL

LDAPDirectoryIntegration

CapabilityProtocol

DeviceProtocol

Version

IpAddress

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


deleteDevice Java シグニチャ

デバイスを削除します。

構文:

public ResponseReturn deleteDevice (CUPMService stub, DeviceValue device, String endPointReference, String idPrefix);

パラメータ:

device:キー アトリビュートが削除するデバイスに設定されているデバイス オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

DeleteDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

getConfiguredInfraProduct Java シグニチャ

製品情報、デバイス名、機能名のみを含むサービス詳細を返します。ServiceAreaID または DomainID は返しません。

構文:

public ResponseReturn getConfiguredInfraProduct (CUPMService stub, DeviceValue device, ProductValue product, String endPointReference, String idPrefix);

パラメータ:

device:必要なキー アトリビュート。

product:返されるインフラストラクチャ製品。キー アトリビュート(「完全オブジェクト定義ファイル:Common.xsd」を参照)は製品の検索に使用されます。製品検索にキー以外のアトリビュートは無視されます。

epr:非同期結果通知が送信される EndpointReference

idPrefix:クライアントに返される NBI ID の前に付けられます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetConfiguredInfraProductException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiStatus と CupmApiList を格納する CupmApiResultValue。CupmApiList は、選択された 1 つのインフラストラクチャ製品を格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listConfiguredInfraProducts Java シグニチャ

特定のデバイスに設定されたすべてのサービスのリストを返します。

構文:

public ResponseReturn listConfiguredInfraProducts (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:返される製品をフィルタし、返されるアトリビュートを決定します。クライアントが 1 つのデバイス上のインフラストラクチャ製品に関心がある場合、このフィルタでデバイス名を指定します。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:クライアントに返される NBI ID の先頭に追加される文字列

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListConfiguredInfraProductsException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


ドメイン管理コマンドおよびクエリー

Provisioning Manager NBI は Provisioning Manager ドメイン オブジェクトの完全管理をサポートします。

createDomain Java シグニチャ

新しいドメインを作成します。

構文:

public ResponseReturn createDomain (CUPMService stub, DomainValue Domain, String endPointReference, String idPrefix);

パラメータ:

domain:アトリビュート キーおよびアトリビュート名と値のペアがそれらの初期値に設定されているドメイン オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

CreateDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

getDomain Java シグニチャ

構文:

ドメインを取得します。

public ResponseReturn getDomain (CUPMService stub, DomainValue Domain, String endPointReference, String idPrefix);

パラメータ:

domain:キー アトリビュートが取得するオブジェクトに設定されているドメイン オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は get の結果である 1 つの Domain オブジェクトを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

updateDomain Java シグニチャ

ドメインを更新します。

構文:

public ResponseReturn updateDomain (CUPMService stub, DomainValue Domain, String endPointReference, String idPrefix);

パラメータ:

Domain:更新するオブジェクトを識別するために設定されたキー アトリビュートと、新しい値に更新されるすべてのアトリビュートの名前と値のペアを持つドメイン オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

UpdateDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listDomain Java シグニチャ

一連のドメインを選択します。

構文:

public ResponseReturn listDomain (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:オブジェクト選択基準と返されるデバイス オブジェクト アトリビュートを定義します。

次のアトリビュートを使用してフィルタできます。

SubscriberRoles

UnifiedMessageProcessor

DomainID

DomainDescription

CallProcessor

ServiceArea

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、これは WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


deleteDomain Java シグニチャ

ドメインを削除します。

構文:

public ResponseReturn deleteDomain (CUPMService stub, DomainValue Domain, String endPointReference, String idPrefix);

パラメータ:

domain:キー アトリビュートが削除するドメインに設定されているドメイン オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

DeleteDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

サービス エリア文字列管理コマンドおよびクエリー

Provisioning Manager NBI は Provisioning Manager サービス エリア オブジェクトの完全管理をサポートします。


) CreateServiceArea NBI を使用して、サービス エリアがコール プロセッサに関連付けられていない場合でも、ディレクトリ番号ブロックをサービス エリアに関連付けることができます。Provisioning Manager ユーザ インターフェイスではこれを実行できません。


createServiceArea Java シグニチャ

新しいサービス エリアを作成します。

構文:

public ResponseReturn createServiceArea (CUPMService stub, ServiceAreaValue serviceArea, String endPointReference, String idPrefix);

パラメータ:

serviceArea:アトリビュート キーおよびアトリビュート名と値のペアがそれらの初期値に設定されている ServiceArea オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

CreateServiceAreaException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

getServiceArea Java シグニチャ

特定のサービス エリアを取得します。

構文:

public ApiResponse getServiceArea (CUPMService stub, ServiceAreaValue serviceArea, String endPointReference, String idPrefix);

パラメータ:

serviceArea:キー アトリビュートが取得するオブジェクトに設定されている ServiceArea オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetServiceAreaException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は get の結果である 1 つの ServiceArea オブジェクトを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

updateServiceArea Java シグニチャ

サービス エリアを更新します。

構文:

public ResponseReturn updateServiceArea (CUPMService stub, ServiceAreaValue serviceArea, String endPointReference, String idPrefix);

パラメータ:

serviceArea:更新するオブジェクトを識別するために設定されたキー アトリビュートと、新しい値に更新されるすべてのアトリビュートの名前と値のペアを持つ ServiceArea オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

UpdateServiceAreaException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) サービス エリアからディレクトリ番号ブロックを削除するには、サービス エリア プロパティ directoryNumberBlockProperties で削除するディレクトリ番号ブロックを指定します。次に、directoryNumberBlockAction アトリビュートを REMOVE に設定します。


listServiceArea Java シグニチャ

一連のサービス エリアを選択します。

構文:

public ResponseReturn listServiceArea (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:オブジェクト選択基準と返されるデバイス オブジェクト アトリビュートを定義します。

次のアトリビュートを使用してフィルタできます。

CommonDeviceConfig

lastNumber

serviceAreaID

subscriberTemplateWithTTSDisabled

callSearchSpaceLine

location

devicePool

firstNumber

subscriberTemplateWithTTSEnabled

subscriberRoles

externalMask

cosWithTTSEnabled

domainID

callProcessorName

minLength

callSearchSpacePhone

prefix

cosWithTTSDisabled

phoneProtocol

routePartition

unifiedMessageProcessorName

emailProcessor

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListServiceAreaException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


deleteServiceArea Java シグニチャ

サービス エリアを削除します。

構文:

public ResponseReturn deleteServiceArea (CUPMService stub, ServiceAreaValue serviceArea, String endPointReference, String idPrefix);

パラメータ:

serviceArea:キー アトリビュートが削除するサービス エリアに設定されている ServiceArea オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

DeleteServiceAreaException:サーバが NBI 要求を実行できない場合。ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

同期化管理コマンド

同期化 NBI 要求は Provisioning Manager ユーザ インターフェイスを使用して実行する操作と同じ操作を実行します。

同期化のステータスが返されます。これは、開始時間、終了時間、メッセージの 3 つの文字列要素を含む CupmApiList から構成されます。

syncDevice Java シグニチャ

指定された管理対象デバイスをポーリングして Provisioning Manager データベースを同期させます。同期させるデバイス機能を指定します。デバイス インフラストラクチャ、デバイスに設定されている加入者、またはその両方の同期化を指定します。

構文:

public ResponseReturn syncDevice (CUPMService stub, DeviceValue device, SyncType syncType, ExecuteOption executeOption, String endPointReference, String idPrefix);

パラメータ:

device:同期させるデバイス。キー アトリビュート DeviceName のみ必要です。デバイス オブジェクトの Capability アトリビュートを使用して、複数の機能を持つデバイスのどの機能を同期させるかを指定できます。

syncType:2 つの同期化のうち実行する同期化または両方を指定する Enum。値は INFRA、SUBSCRIBER、BOTH(デフォルト)です。

executeOption:同期化を実行するかどうか、最後の同期化のステータス概要を返すかどうかを指定する Enum。値は SYNC または LAST_SYNC_STATUS です。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:NBI ID の値に設定されているサーバによって生成された数字の文字列の先頭に追加する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

SyncDeviceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は、それぞれ同期化ステータス形式の 1 つまたは 2 つの CupmApiList オブジェクトを格納します。2 つのオブジェクトが存在する場合、最初のオブジェクトはインフラストラクチャ同期化ステータス用で、2 番目のオブジェクトは加入者同期化ステータス用です。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

syncDomain Java シグニチャ

ドメインとデバイスとの Provisioning Manager 同期化を実行します。

構文:

public ResponseReturn syncDomain (CUPMService stub, DomainValue Domain, ExecuteOption executeOption, String endPointReference, String idPrefix);

パラメータ:

Domain:キー アトリビュート DomainID が必要です。

ExecuteOption:同期化を実行するかどうか、最後の同期化のステータス概要を返すかどうかを指定する Enum。値は SYNC または LAST_SYNC_STATUS です。LAST_SYNC_STATUS オプションは同期化を実行しませんが、最後の同期化のステータスを返します。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:クライアントに返される NBI ID の前に付けられます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

SyncDomainException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は、同期化ステータス形式の CupmApiList オブジェクトを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) Domain に属するいずれかのデバイスが同期化を実行中の場合、syncDomain コマンドはサーバによって拒否されます。


加入者管理コマンドおよびクエリー

Provisioning Manager NBI は Provisioning Manager Subscriber オブジェクトの完全管理をサポートします。さらに、設定されている加入者サービスをクエリーし、パスワードをリセットするための特殊なコマンドもサポートしています。

createSubscriber Java シグニチャ

1 つの加入者を作成します。

構文:

public ResponseReturn createSubscriber (CUPMService stub, SubscriberValue subscriber, String endPointReference, String idPrefix);

パラメータ:

subscriber:アトリビュート キーおよびアトリビュート名と値のペアがそれらの初期値に設定されている Subscriber オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

CreateSubscriberException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

createSubscribers Java シグニチャ

複数の加入者を作成します。

構文:

public ResponseReturn createSubscribers (CUPMService stub, CupmApiListValue subsriberList, String endPointReference, String idPrefix);

パラメータ:

subscriberList:Subscriber オブジェクトのリストを格納する CupmApiList。リストに含まれる各 Subscriber オブジェクトが作成されます。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

CreateSubscribersException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:実行が成功した場合にのみ CupmApiStatus が格納されます。

CupmApiStatus の結果が失敗の場合、CupmApiList が含まれます。CupmApiList は一連の CupmApiList オブジェクトを格納します。各 CupmApiList オブジェクトは 1 つの整数と CupmApiFaultType を持ちます。整数は、失敗したリスト内の加入者の、0 で始まるインデックスです。CupmApiFaultType は、この加入者の作成が失敗した理由です。NBI 要求の失敗に対して、1 つの CupmApiFaultType が含まれます。

getSubscriber Java シグニチャ

特定の加入者を取得します。

構文:

public ResponseReturn getSubscriber (CUPMService stub, SubscriberValue subscriber, String endPointReference, String idPrefix);

パラメータ:

subscriber:キー アトリビュートが取得するオブジェクトに設定されている Subscriber オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetSubscriberException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は get の結果である 1 つの Subscriber オブジェクトを格納します。CupmApiFaultType は NBI 要求が失敗した場合に含まれます。

updateSubscriber Java シグニチャ

加入者を更新します。

構文:

public ApiResponse updateSubscriber (CUPMService stub, SubscriberValue subscriber, String endPointReference, String idPrefix);

パラメータ:

subscriber:更新するオブジェクトを識別するために設定されたキー アトリビュートと、新しい値に更新されるすべてのアトリビュートの名前と値のペアを持つ Subscriber オブジェクト

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

UpdateSubscriberException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。CupmApiFaultType は NBI 要求が失敗した場合に含まれます。

listSubscriber Java シグニチャ

一連の加入者を選択します。

構文:

public ResponseReturn listSubscriber (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:オブジェクト選択基準と返されるデバイス オブジェクト アトリビュートを定義します。

次のアトリビュートを使用してフィルタできます。

subscriberRoles

lastName

phone

email

domainID

department

subscriberID

firstName

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListSubscriberException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


deleteSubscriber Java シグニチャ

加入者を削除します。

構文:

public ResponseReturn deleteSubscriber (CUPMService stub, SubscriberValue subscriber, boolean onlyFromCUPM, String endPointReference, String idPrefix);

パラメータ:

subscriber:キー アトリビュートが削除する加入者に設定されている Subscriber オブジェクト

onlyFromCUPM:デフォルトは false です。true に設定されている場合、加入者は Provisioning Manager からのみ削除されます。加入者にカスタマー レコードと一致するサービスがある場合、Provisioning Manager はサービスを関連解除し(キャンセルしない)、Provisioning Manager だけからユーザを削除します。これにより、加入者をあるドメインから別のドメインに移動したり、サービスを別のサービス エリアに一致(移動)させたりする方法が得られます。


) サービスが加入者から関連解除されても、そのサービスはデバイス(プロセッサ)から削除または関連解除されません。Provisioning Manager 内で関連解除されるだけです。それ以降のドメイン同期化が発生すると、同期化ルールに応じて、加入者が再度作成され、サービスを加入者に関連付けることができます。


endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

DeleteSubscriberException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

resetSubscriberServicePassword Java シグニチャ

加入者パスワードをリセットします。Provisioning Manager ユーザ インターフェイスの [Manage Subscriber] タブと同じ機能を提供します。

構文:

public ResponseReturn resetSubsciberServicePassword (CUPMService stub, SubscriberValue subscriber, String passwordType, String encryptedPword, String endPointReference, String idPrefix);

パラメータ:

subscriber:キー アトリビュートが加入者を一意に識別するように設定されている Subscriber オブジェクト

passwordType:リセットするパスワードのタイプ。

有効なエントリは次のとおりです。

UnifiedCMPassword

UnifiedCMPin

UnifiedCMEPassword

UnifiedCMDigestCredentials

UnityPassword

UnityConnectionPassword

UnityConnectionPin

passwordType が NULL または指定されていない場合、デフォルトは UnifiedCMPassword に設定されます。

encryptedPword:加入者の新しいパスワード(暗号化されます)。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL が許可されます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ResetSubscriberServicePasswordException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listSubscriberService Java シグニチャ

特定の加入者に設定されているすべてのサービスのリストを返します。

構文:

public ResponseReturn listSubscriberService (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:デバイス、サービス エリア、機能を指定する選択基準。1 つの加入者のサービスだけが必要な場合は、フィルタのアトリビュートとして加入者 ID を指定します。

次のアトリビュートを使用してフィルタできます。

SubscriberID

ProductID

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:クライアントに返される NBI ID の先頭に追加される文字列

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListSubscriberServiceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


getSubscriberService Java シグニチャ

次を返します。

製品情報を含むサービスの詳細

サービス エリア ID

ドメイン ID

加入者 ID

構文:

public ResponseReturn getSubscriberService (CUPMService stub, SubscriberValue subscriber, ServiceAreaValue serviceArea, ProductValue product, String endPointReference, String idPrefix);

パラメータ:

Subscriber:サービスを取得するキー アトリビュート subscriberID を持つ Subscriber オブジェクトを指定します。

ServiceAreaValue:加入者のサービスがプロビジョニングされたサービス エリア。

product:返されるサービスを識別します。キー アトリビュート(「加入者製品のキー アトリビュート」を参照)は製品の検索に使用されます。製品検索にキー以外のアトリビュートは無視されます。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:クライアントに返される NBI ID の先頭に追加される文字列

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetSubscriberServiceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。CupmApiFaultType は NBI 要求が失敗した場合に含まれます。

NBI オブジェクト メタデータの概要

ほとんどの Provisioning Manager NBI トップレベル オブジェクトでは、データの大半がメタ データです。DeviceValue、DomainValue、ServiceAreaValue、SubscriberValue オブジェクトでは、キー アトリビュートと一意である必要があるアトリビュートのみが一意のタグとしてトップ レベルに指定されます。

他のすべてのデータはメタデータ ペア オブジェクトとして指定されます。メタデータ オブジェクト名は状況依存です。たとえば、デバイスは、コール プロセッサの場合に cmProperties メタデータを持ち、ユニファイド メッセージ プロセッサの場合に umpProperties メタデータを持ちます。

メタデータ オブジェクトは複合体で、データが常に 1 つの値を持つ場合、オブジェクトには propertyName と propertyValue の 2 つの文字列が格納されます。Value プロパティ名は、メタデータ オブジェクトに関連付けられている列挙で定義されます。

メタデータ オブジェクトが、複数の値に関連付けることができる 1 つまたは複数のプロパティを持つ場合、オブジェクトには、文字列 1 つ、文字列またはオブジェクトの配列 1 つ、アクションの列挙 1 つが格納されます。デフォルトのアクション ADD は、すでに割り当て済みの一連の値に値を追加するために使用します。アクション REMOVE は現在割り当てられている値の配列から指定した値を削除するために使用します。更新要求では、アクションの割り当てのみが必要です。

ワーク オーダー管理コマンドおよびクエリー

Provisioning Manager NBI には、見込みワーク オーダーの概念はありません。すべてのワーク オーダーは、NbiManager が NBI 要求を受け入れ、オプションの検証チェックが成功するとただちに送信されます。

Provisioning Manager NBI にはワーク オーダー ID はありません。NBI 要求によって送信されたワーク オーダーは NBI ID によって識別されます。

submitOrder Java シグニチャ

Provisioning Manager にワーク オーダーを送信します。ワーク オーダーが Provisioning Manager によって受け付けられ、検証(検証が指定されている場合)に合格すると、Provisioning Manager に送信されて実行されます。

構文:

public ResponseReturn submitOrder (CUPMService stub, OrderValue order, ValidationType validationType, RollbackType rollbackType, String endPointReference, String idPrefix);

パラメータ:

order:NBI 要求が受け付けられた場合に、Provisioning Manager に送信されるワーク オーダーを作成します。オーダーは Provisioning Manager で見込みワーク オーダーになりません。

validationType:ワーク オーダーを送信する前に検証する必要があるかどうかに関する ENUM。値は VALIDATE_ONLY、SUBMIT_ONLY、VALIDATE_AND_SUBMIT です。

rollbackType:オーダーが失敗した場合にロールバックする方法を表す ENUM。値は PARTIAL です。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:サーバによって生成された数値の先頭に追加され、NBI ID になる文字列。この場合、NBI ID はオーダー ID としても使われることに注意してください。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

SubmitOrderException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus のみを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

オーダー オブジェクトの内容

オーダー オブジェクトにはオーダー タイプ(ADD、CHANGE、CANCEL)と一連のサービス詳細が格納されます。これらの値は、列挙で定義され、一連のサービスの作成、変更、削除を指定します。

サービス詳細オブジェクトには、デバイス名、デバイス機能、サービス エリア ID、加入者 ID、ドメイン ID、一連の製品が格納されます。

製品オブジェクトには、製品 ID、シーケンス番号、assocWith フラグ、一連のキー アトリビュート、製品アトリビュートが格納されます。シーケンス番号は各製品の作成のオーダーを定義し、同じオーダーの製品間で一意である必要があります。assocWith フラグは ADD オーダー タイプに使われます。あるオーダー詳細で作成された製品を、同じワーク オーダーで後に作成された別の製品と関連付ける必要がある場合、追加されるサービスが、すでに追加されているサービスを参照できるように、assocWith アトリビュートを指定する必要があります。assocWith を使用する例は、Phone、Line、Email、Voicemail、Unified Messaging Service などの複数の従属製品を含むオーダーです。

CHANGE または CANCEL オーダー タイプではキー アトリビュートが必要です。キー アトリビュートについては、表 2-7 および表 2-8 を参照してください。


) オーダーは、オーダー詳細に指定されているサービス エリアのアトリビュート設定を継承します。アトリビュートはオーダー自体で指定して、その 1 手順でサービス エリア設定を上書きできます。


Add オーダー

依存関係を持つ複数の製品(Phone-Line、Phone-LineOnSharedPhone、EM_Access-EM_Line、Line-Voicemail-Email など)をオーダーするために 1 つのオーダー要求を送信する場合、sequenceNumber および assocWith を使用する必要があります。

assocWith アトリビュートを使用する場合、Line 製品の SelectedPhone、LineOnSharedPhone 製品の targetphone、Voicemail 製品の SelectedLine、Email 製品の SelectedVoicemail などの他のアトリビュートは指定しないでください。

Cancel オーダー

キャンセルする製品のキー アトリビュートのみを指定する必要があります。assocWith を指定しないでください。sequenceNumber を含める必要があります。

Change オーダー

変更するアトリビュートに加えて、製品のキー アトリビュートを指定する必要があります。

change オーダー要求で、サブアトリビュートを持たない製品アトリビュートを設定解除するには、その空の値に加えて製品アトリビュートを使用します。

サブアトリビュートを持つ製品アトリビュートを設定解除するには、すべてのサブアトリビュートに加えてプロビジョニング アトリビュート全体を設定解除する場合、親アトリビュートを空の値で指定します。1 つのサブアトリビュートを設定解除する場合は、変更要求に維持するサブアトリビュートのみを指定します。

次の例に、これらの複合プロビジョニング アトリビュートを設定解除する方法を示します。この例は、Add Phone Order 要求のサブアトリビュートを持つ speeddialinfo アトリビュートの部分から構成されます。

 
<ord:attributeID>speeddialinfo</ord:attributeID>
<ord:subAttribute>
<ord:item>
<ord:attributeID>speeddialinfo_index</ord:attributeID>
<ord:attributeValue>
<v1:item>1</v1:item>
</ord:attributeValue>
</ord:item>
<ord:item>
<ord:attributeID>speeddialinfo_DirectoryNumber</ord:attributeID>
<ord:attributeValue>
<v1:item>10001</v1:item>
</ord:attributeValue>
</ord:item>
<ord:item>
<ord:attributeID>speeddialinfo_label</ord:attributeID>
<ord:attributeValue>
<v1:item>label_10001</v1:item>
</ord:attributeValue>
</ord:item>
<ord:item>
<ord:attributeID>speeddialinfo_index</ord:attributeID>
<ord:attributeValue>
<v1:item>2</v1:item>
</ord:attributeValue>
</ord:item>
<ord:item>
<ord:attributeID>speeddialinfo_DirectoryNumber</ord:attributeID>
<ord:attributeValue>
<v1:item>10002</v1:item>
</ord:attributeValue>
</ord:item>
<ord:item>
<ord:attributeID>speeddialinfo_label</ord:attributeID>
<ord:attributeValue>
<v1:item>label_10002</v1:item>
</ord:attributeValue>
</ord:item>
</ord:subAttribute>
</ord:item>
 

speeddialinfo アトリビュートのすべてのサブアトリビュートを設定解除する場合の変更オーダー要求は次のようになります。

 
<ord:attributeID>speeddialinfo</ord:attributeID>
<ord:attributeValue></ord:attributeValue>
 

インデックス値が 2 の speeddialinfo アトリビュートを設定解除する場合の変更要求は次のようになります。

<item>
<attributeID>speeddialinfo</attributeID>
<subAttribute>
<item>
<attributeID>speeddialinfo_DirectoryNumber</attributeID>
<attributeValue>
<v1:item>10011</v1:item>
</attributeValue>
</item>
<item>
<attributeID>speeddialinfo_label</attributeID>
<attributeValue>
<v1:item>label_10001</v1:item>
</attributeValue>
</item>
<item>
<attributeID>speeddialinfo_index</attributeID>
<attributeValue>
<v1:item>1</v1:item>
</attributeValue>
</item>
</subAttribute>
</item>
 

getOrder Java シグニチャ

以前に送信されたオーダー オブジェクトを返します。

構文:

public ResponseReturn getOrder (CUPMService stub, String nbiId, String orderId, String endPointReference, String ipPre);

パラメータ:

nbiId:ワーク オーダー オブジェクトを指定するためのキー。これは、NBI SubmitOrder 要求によって送信されたオーダーのみを取得できます。

orderId:GUI または NBI 要求によって生成されたオーダーを取得するために使われます。nbiID または OrderID が必要ですが、両方を含めるとエラーになります。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

ipPre:この get NBI 要求に割り当てられる NBI ID の前に付けられます。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetOrderException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmAPiList を格納します。CupmApiList は選択されたオーダーの 1 つのオブジェクトを格納します。NBI オーダー要求がまだ保持されている場合、それが返されます。その保持期間を超えていて、消去されている場合、ワーク オーダー オブジェクトの XMLEntity バージョンの変換が返されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listOrder Java シグニチャ

すべてのオーダー詳細を返します。

この API を使用する場合、次のことに注意してください。

これは、CPU に負荷のかかる処理です。パフォーマンスに影響します。この API を使う場合は、パフォーマンスの制限を考慮してください。


ALL 戻り基準を使用すると、大量の CPU リソースを消費します。KEYS_ONLY フィルタ オプションを使用して、オーダー ID のリストを取得してから、getOrder を実行して、特定のオーダーの詳細を取得することを推奨します。


システムに以前のバージョンの Provisioning Manager からのオーダーがある場合、すべての情報が返されないか、またはオーダー全体がスキップされることがあります。

オーダーが発行された後に、デバイス名が変更された場合、IM 検索が失敗することがあります。これが発生すると、オーダーはスキップされます。

構文:

public ResponseReturn listOrder (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String ipPre);

パラメータ:

filter:選択基準を絞り込むために使用します。

次のアトリビュートを使用してフィルタできます。

SubscriberID

ServiceAreaID

DomainID

ProductID

OrderStatus

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListOrderException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。NBI オーダー要求がまだ保持されている場合、それが返されます。その保持期間を超えていて、消去されている場合、ワーク オーダー オブジェクトの XMLEntity バージョンの変換が返されます。KEYS_ONLY に設定されているフィルタが指定されている場合、CupmApiList には xmlstrings が格納されます。各文字列は 1 つの Object ID を格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。


) pullOp API を使用して、指定した列挙のコンテキストに従って要素のリストを取得できます(pullOp の詳細については「pullOp Java シグニチャ」を参照してください)。


接続チェック要求

ping Java シグニチャ

構文:

public ResponseReturn ping (CUPMService stub, String epr)

戻り値:

2 つの文字列 Provisioning Manager バージョンと Provisioning Manager NBI バージョン。

ASyncReturn:

サーバ ステータスを含むテスト文字列が、指定された EPR で指定された通知ユーザに送信されます。

インベントリ クエリー

getInventoryItem Java シグニチャ

インベントリ項目を取得します。

構文:

public ResponseReturn getInventoryItem (CUPMService stub, InventoryItemValue item, String endPointReference, String idPrefix);

パラメータ:

item:取得するオブジェクト タイプ、アトリビュート キーおよびそれらのキーの一意の値を指定する InventoryItem オブジェクト。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetInventoryItemException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList には選択した 1 つの InventoryItem オブジェクトが格納されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listInventoryItem Java シグニチャ

フィルタの選択に基づいて、Provisioning Manager データベースからインベントリ項目のリストを取得します。フィルタは関連するオブジェクト(1 つのレベルのアソシエーションのみ)に基づいて選択することもできます。

構文:

public ResponseReturn listInventoryItem (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:返される InventoryItem オブジェクトと含まれるアトリビュートを指定します

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListInventoryItemException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

事前入力

このコンテキストでの事前入力は、サービス アトリビュート選択リストを動的に入力することを表します。

listProductAttributeChoice Java シグニチャ

特定の製品の特定のアトリビュートの選択リストを返します。選択リストは、動的で、Capabilityname、DeviceName、ServiceAreaID、およびすでに指定されている製品アトリビュートに基づきます。

構文:

public ResponseReturn listProductAttributeChoice (CUPMService stub, String[] arrayOfAttributes, ProductValue product, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

product:戻り選択リストに指定された製品で、すでに設定されているすべてのアトリビュートを格納します。

arrayOfAttributes:選択リストの各アトリビュートが返されます。

filter:フィルタの選択基準セクションでは、デバイス、デバイスの機能、ServiceArea、設定されているすべての製品アトリビュート値を指定します。capabilityName と、DeviceName または ServiceAreaID のいずれかまたはその両方を指定する必要があります。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListProductAttributeChoiceException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiStatus と CupmApiList を格納する CupmApiResultValue。CupmApiList は製品アトリビュートに要求された選択リストを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

Provisioning Manager NBI ステータス クエリー

getApiStatus Java シグニチャ

特定の NBI 要求のステータスを返します。コマンドの実行が完了すると、添付された CupmApiResultValue も返されます。

構文:

public ResponseReturn getApiStatus (CUPMService stub, String apiId, String endPointReference, String idPrefix);

パラメータ:

apiId:返されるコマンド ステータスの NBI ID

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetApiStatusExcepton:サーバが NBI 要求を実行できない場合

SyncReturn:

CupmApiResponseValue:CupmApiStatus と CupmApiList を格納する CupmApiResultValue を格納します。リストには、要求に指定された NBI 要求の 1 つのオブジェクト CupmApiStatus が含まれます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

ASyncReturn:

None:コマンドは同期しています。


) サーバが NBI 要求を消去している場合、コマンドは失敗します。


listApiStatus Java シグニチャ

このクライアントが送信したすべての未処理の NBI 要求のステータスを返します。

構文:

public ResponseReturn listApiStatus (CUPMService stub, CupmApiFilterValue filter, String endPointReference, String idPrefix);

パラメータ:

filter:返される NBI 要求の制限されたフィルタ。

次のアトリビュートを使用してフィルタできます。

status

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListApiStatusExcepton:サーバが NBI 要求を実行できない場合

SyncReturn:

CupmApiResponseValue:CupmApiStatus と CupmApiList を格納する CupmApiResultValue を格納します。CupmApiList は 1 つのオブジェクト EnumerationContextType を格納し、WS-Enumeration で提案される標準を使用して、リストを取得するために使用されます。

CupmApiFaultType:NBI 要求が失敗したか警告が生成された場合に含まれます。

ASyncReturn:

None:コマンドは同期しています。

特殊な要求

listSrstPhoneInfo Java シグニチャ

指定した SRST IP アドレスと Provisioning Manager IP アドレスに関連付けられている PhoneInfo オブジェクト(それぞれそのユーザと回線を含む電話機を表す)のリストを生成します。生成される電話機のリストは常に Provisioning Manager IM データベースの電話機のセットまたはサブセットになります。

構文:

public ResponseReturn listSrstPhoneInfo (CUPMService stub, String cpIpAddr, String srstIpAddr, String queryOption, String endPointReference, String idPrefix);

パラメータ:

cpIpAddr:コール プロセッサの IP アドレス

srstIpAddr:SRST の IP アドレス

queryOption:PhoneInfoqueryOption 列挙によって定義されたデータ選択基準

ALL:(デフォルト)Provisioning Manager のすべての電話が考慮されます。

IN_CUPM_SUBSCRIBER_RECORD:Provisioning Manager 加入者レコードに含まれる電話機のみが選択されます。

NOT_IN_CUPM_SUBSCRIBER_RECORD:Provisioning Manager に存在し、Provisioning Manager 加入者レコードに存在しない電話機のみが選択されます。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成に変更がされません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

ListSrstPhoneInfoException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は WS-Enumeration コンテキスト オブジェクトを格納し、リストをプルするキーとして使われます。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

getOrderSummary Java シグニチャ

構文:

public ResponseReturn getOrderSummmary (CUPMService stub, Calendar startTime, Calendar endTime, String endPointReference, String idPrefix);

パラメータ:

startTime:レポートの期間の開始。指定しない場合、値のデフォルトは最も早い既知のワーク オーダーに設定されます。

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成に変更がされません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

GetOrderSummaryException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList は 1 つのオブジェクト OrderSummary オブジェクトを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

submitConfigTemplate Java シグニチャ

Cisco IOS テレフォニー コマンド セット、ルータ関連コマンド、インフラストラクチャ製品オーダー コマンドをデバイスの機能に送信します。コマンドはテンプレートで指定します。キーワード置換機能を使用することができます。

構文:

public ResponseReturn submitConfigTemplate (CUPMServiceStub stub, ConfigDetailValue configDetail, String validate, String rollback, String endPointReference, String idPrefix);

パラメータ:

configDetail:このオブジェクトは、Cisco IOS コマンドを送信するデバイスと機能を定義します。送信するテンプレートを指定し、この使用でのキーワードとそれらの値のリストを格納します。

validate:VALIDATE、SUBMIT、VALIDATE_AND_SUBMIT はこの列挙の設定です。

rollback:PARTIAL_ROLLBACK 設定

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

submitConfigTemplateException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList はデバイスでの Cisco IOS コマンドの実行のステータスを格納します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

listConfigTemplateKeyword Java シグニチャ

submitConfigTemplate 要求によって送信されるテンプレートで使われるキーワードのリストのサポートを提供します。指定したテンプレートのすべてのキーワードのリストを返します。

構文:

public ResponseReturn listConfigTemplateKeyword (CUPMServiceStub stub String templateName, String endPointReference, String idPrefix);

パラメータ:

templateName:キーワードのリストを返すテンプレートを識別する名前

endPointReference:非同期結果通知が送信される EndpointReference オブジェクトに変換される文字列

idPrefix:内部で生成される数値の先頭に追加され、NBI ID を形成する文字列。NULL または空の文字列は有効で、内部の生成が変更されません。

戻り値:

CupmApiResponseValue:NBI ID を持つオブジェクト

スロー:

listConfigTemplateException:サーバが NBI 要求を実行できない場合

ASyncReturn:

CupmApiResultValue:CupmApiStatus と CupmApiList を格納します。CupmApiList はこのテンプレートのキーワードをリストする 1 つのオブジェクトを格納します。そのオブジェクトは ArrayOfString オブジェクトを格納する KeywordListDocument です。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

WS-Enumeration 要求

Provisioning Manager NBI List コマンドが正常に実行されると、CupmApiResultValue がクライアントへの通知として送信されます。この通知には wsen:EnumerationContext オブジェクトが格納されます。

クライアントは、この EnumerationContext を参照しながら、サーバへの次の要求を送信できます。

PullOp:指定した列挙コンテキストに従って、要素のリストを返します。更新された列挙コンテキストも返すことがあり、呼び出し元は今後のすべての要求でこれを使用する必要があります。

RenewOp:コンテキストが有効である限り、指定した列挙コンテキストの有効期限を更新します。コンテキストが無効な場合、この処理は失敗し、障害が生成されます。

GetAPIStatus:有効期限などの列挙コンテキストのステータスを返します。

ReleaseOp:指定した列挙コンテキストを無効化し、列挙に割り当てられているリソースを解放します。Provisioning Manager NBI List コマンドによって生成された UUID リストに削除のフラグを立てます。


) Java コードで使用するオブジェクトを org.xmlsoap.schemas.ws.x2005.x09.enumeration からインポートできます。


pullOp Java シグニチャ

pullOp コマンドはリスト NBI によって生成されたリスト データの部分を取得します。クライアントは、送信する前に、CupmApiEnumIterator に MaxElements アトリビュートを設定して、返される要素数を指定できます。デフォルトは 1 です。pullOp コマンドはこの量を超えて返しません。レポートが生成されてから一部のオブジェクトが削除された場合、またはエラーが発生した場合に、返される要素数が少なくなることがあります。その後のプルの呼び出しでは、データの次の要素のシーケンスが返されます。

構文:

public ResponseReturn pullOp (CUPMService stub, wsen:EnumerationContext, wsen:MaxElements, pullSize);

パラメータ:

wsen:EnumerationContext:クライアントがサーバから受け取ったこのオブジェクトの最新バージョン

wsen:MaxElements, pullSize:この要求で返されるオブジェクトの数

戻り値:

標準プル応答

スロー:

RemoteExcepton:サーバが NBI 要求を実行できない場合

SyncReturn:

標準プル応答。これは、ItemArrayType を格納します。そのタイプでは、要求されたオブジェクト数です。プルがリストの末端に達すると、リストのピアとして wsen:EndOfSequence オブジェクトが返されます。これは、クライアントに、これ以上の要素は使用できず、列挙コンテキストが無効になったことを示します。クライアントは追加のプル操作を呼び出したり、列挙コンテキストが必要なくなったことを示す Release 操作を呼び出したりすることはできません。これらの操作を呼び出すと、wsen:InvalidEnumerationContext fault が発生します。

CupmApiFaultType:NBI 要求が失敗した場合に含まれます。

renewOp Java シグニチャ

renewOp コマンドは、サーバに、クライアントが初期の有効期限日より長くデータを保持しようとしていることを伝えます。Provisioning Manager サーバは、更新によって、レポートのスロットリングしきい値が超えない場合にのみ、これを許可します。

構文:

public ResponseReturn renewOp (CUPMService stub, wsen:EnumerationContext enumerationContext, XmlCalendar Date or Duration duration);

日付を指定した場合、その日付が新しい有効期限日になります。期限を指定した場合、その時間が現在の有効期限日に追加されます。

NBI プロパティは、有効期限日を延長できる最大回数を制御します。

パラメータ:

wsen:EnumerationContext:クライアントがサーバから受け取ったこのオブジェクトの最新バージョン

idPrefix:内部で生成される数値の先頭に追加され、一意の NBI 識別子を形成する文字列。NULL または空の文字列は有効で、内部で生成される数値だけの NBI 識別子になります。

戻り値:

標準 WS-Enumeration Renew 応答メッセージ

スロー:

Remote Exception:サーバが NBI 要求を実行できない場合

SyncReturn:

新しい有効期限日を返します。

getStatusOp Java シグニチャ

ApiEnumerator オブジェクトを更新します。

構文:

public ResponseReturn getStatusOp (CUPMService stub, wsen:EnumerationContext enumerationContext);

パラメータ:

wsen:EnumerationContext:クライアントがサーバから受け取ったこのオブジェクトの最新バージョン

戻り値:

標準 WS-Enumeration getStatus 応答メッセージ

スロー:

RemoteException:サーバが NBI 要求を実行できない場合

SyncReturn:

現在の有効期限日を返します。

releaseOp Java シグニチャ

サーバに、クライアントがデータを処理し終わったため、消去可能であることを伝えます。

構文:

public ResponseReturn release (CUPMService stub, wsen:EnumerationContext enumerationContext);

パラメータ:

wsen:EnumerationContext:クライアントがサーバから受け取ったこのオブジェクトの最新バージョン

戻り値:

Standard WS-Enumeration 標準 Release 応答メッセージ

スロー:

RemoteException:サーバが NBI 要求を実行できない場合

SyncReturn:

パラメータがない応答

WS-Notification の Provisioning Manager NBI 実装

Provisioning Manager クライアントは Provisioning Manager サーバに NBI 要求を送信します。2 つのプラットフォームは Web サービス ピアです。クライアントは NotificationConsumer で、Provisioning Manager サーバである Web サービス リソースに加入しています。Provisioning Manager サーバは NotificationProducer です。1 つだけのトピックを含み、1 つだけの Web サービス リソースとして表示されます。Provisioning Manager サーバが NBI 要求を完了すると、NBI 要求の結果を含む通知を発行します。各クライアントがサーバに加入すると、Provisioning Manager サーバが NBI 要求の結果通知を発行したときに、その NBI 要求を送信したクライアントのみが応答を受け取るように、フィルタが実装されます。

サーバによって受け付けられる NBI 要求とクライアントに送信される NBI 要求の結果通知には 1 対 1 の関係があります。

Provisioning Manager サーバは要求されていないクライアントにメッセージを送信することはありません。

通知ユーザ サービス

Provisioning Manager NBI SDK は、要求通知を受け取る通知ユーザ サービスを提供します。通知ユーザ サービスは Java で記述され、Tomcat で実行する axis2.war ファイルで展開されるように設計されています。

このサービスのデフォルトの機能は、ポート 8080 で通知を受け取り、Tomcat コンソール ウィンドウに通知を表示することです。

通知ソフトウェアには、通知をディスクに書き込むメソッドが備えられています。通知を書き込むディレクトリは環境変数 consumer.home で設定します。この環境変数が設定されていない場合に使用されるデフォルト値は \NotificationConsumer です。通知を別々に処理するコードを記述する場合、Java コードから、このメソッドの呼び出しをコメント アウトします。呼び出しは NotificationConsumerServiceSkeleton.java ファイルにあります。

list subscriber または list Domain に、Perl クライアントの自動プル機能を使用する場合、ディスクに通知を書き込む機能が必要です。