4.5.14 jp1SimtService.getLink
リンクの情報を取得するメソッドです。
なお,このメソッドは製品プラグインの__eventGetメソッド,および__eventGetメソッドの呼び出し先のメソッドからは,呼び出しできません。
jp1SimtService.getLinkメソッドの詳細を次に示します。
- メソッド名
-
Object jp1SimtService.getLink(String type, String sid, int fromLayerCount, int toLayerCount, int countPerLayer, int linkCount, String lang, String jp1User, String jp1Token)
- パラメーター
-
- type
-
システムに適用されているリンク情報の種別のうち,取得したいリンク情報の種別を指定します。nullまたは空文字列を指定した場合,リンク情報の種別に関わらず,該当するリンク情報を返却します。
typeは同じ意味を持つ関連同士をグループ化する情報です。[統合オペレーション・ビューアー]画面の[関連ノード]タブでは,typeごとに関連をフィルタリングして表示することができます。
JP1/IMの製品内や他製品との連携では次の種別を使用します。これらの種別以外に,ユーザーが任意の種別を指定することもできます。
-
rootJobnetExecutionOrder:ルートジョブネット実行順序の関連
-
managerAgent:JP1製品のマネージャーとエージェントの関連
-
rootJobnetAgent:ルートジョブネットとAJSエージェントの関連
-
sameNode:名称が同一のノードの関連
-
L2Connection:JP1/NNMiで管理するレイヤー2接続線の関連
-
Infrastructure:JP1/OAで管理するインフラリソースの関連
-
monitoringConfiguration:監視製品の構成における製品と監視対象の関連
-
- sid
-
処理対象とするノードのSIDを指定します。指定した部位の先行・後続ノード情報が返却されます。nullまたは空文字を指定した場合は,すべてのノードのリンク情報を取得します。
- fromLayerCount
-
取得する先行ノード階層数の上限値を,0〜2147483647の範囲で指定します。sidにnullまたは空文字を指定した場合,fromLayerCountパラメーターの指定は無視されます。
- toLayerCount
-
取得する後続ノード階層数の上限値を0〜2147483647の範囲で指定します。sidにnullまたは空文字を指定した場合,toLayerCountパラメーターの指定は無視されます。
- countPerLayer
-
取得するノード数のノード階層当たりの上限値を,1〜2147483647の範囲で指定します。sidにnullまたは空文字を指定した場合,この引数の値は使用されません。
- linkCount
-
取得するリンク数の上限値を1〜2147483647の範囲で指定します。sidにnullまたは空文字を指定した場合,linkCountパラメーターの指定は無視されます。
- lang
-
メッセージの言語を指定します。「ja」,「ja-JP」または「en」を指定できます。その他の値を指定した場合は「en」を指定したものと仮定されます。詳細は「4.4 実装可能なメソッド」の「ユーザー作成プラグインの言語規約」を参照してください。
- jp1User
-
次のJP1権限レベルが設定されたJP1ユーザー名を,1〜31バイトの範囲で指定します。
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- jp1Token
-
jp1Userで指定したJP1ユーザーに対応するJP1認証トークンを指定します。
- 戻り値
-
リンク情報の取得に成功した場合は,リンク情報を格納したオブジェクトが返却されます。オブジェクトに格納されるキーと値を,次に示します。
項番
キー
値
1
links
取得したリンク情報の配列を返却します。リンク情報の配列については「IM管理ノードリンク定義ファイル(imdd_nodeLink_def.conf)」(2. 定義ファイル)を参照してください。
2
exceedCountDetected
パラメーターの指定値が上限を超えたことの検知有無を示します。
3
countPerLayer
1階層あたりのノード数の上限を超えたことの検知有無を示すオブジェクトです。
4
layer整数
sidに指定された階層を階層0として,後続の階層は順に+1,先行の階層は順に-1し,階層に番号を付け整数の部分に埋め込みます。返却対象となる全階層に対し,階層あたりのノード数が上限を超えたことの検知有無を示します。
-
true
検知した
-
false
検知していない
5
linkCount
リンク数が上限を超えたことの検知有無を示します。
-
true
検知した
-
false
検知していない
6
messageId
メッセージIDです。通知すべきメッセージが存在しない場合はnullが指定されます。
7
message
メッセージ本文です。通知すべきメッセージが存在しない場合はnullが指定されます。
リンク情報の取得に失敗した場合にオブジェクトに格納されるキーと値を,次に示します。
項番
キー
値
1
errorMessage
エラーメッセージです。引数が不正な場合はKAJY22043-Eのエラーメッセージが出力されます。
その他の場合に出力されるエラーメッセージについては,「5.6.1 イベント検索」のステータスコードを参照してください。
2
errorMessageId
エラーメッセージのidを返却します。
このメソッドを呼び出す製品プラグインのメソッドは,キーerrorMessageIdの値に応じて,プラグインの仕様に基づいたエラーメッセージやエラー処理を検討してください。
キーerrorMessageは製品プラグインの内部ログに出力し,製品プラグインの障害調査に活用してください。
-
- 例外
-
なし