Cisco License Manager 用 Java API リファレンス ガイド
スケジューラ管理関数
スケジューラ管理関数
発行日;2012/01/08 | 英語版ドキュメント(2009/10/27 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

スケジューラ管理関数

listScheduler

registerDiscoveryScheduler

registerScheduler

registerServerStatusListener

unregisterDiscoveryScheduler

unregisterScheduler

スケジューラ管理関数

この章では、次のスケジューラ管理関数に関する情報を示します。

「listScheduler」

「registerDiscoveryScheduler」

「registerScheduler」

「registerServerStatusListener」

「unregisterDiscoveryScheduler」

「unregisterScheduler」

listScheduler

構文

Schedule[] listScheduler(UserToken token) throws RemoteException;

説明

これは、スケジュールされているタスクのリストをスケジューラから取得する単純なスケジュール関数です。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

戻り値

この関数は、スケジュールが設定されている場合、スケジュール オブジェクトの配列を返します。スケジュールが設定されていない場合は null が返されます。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

registerDiscoveryScheduler

構文

Status registerDiscoveryScheduler(UserToken token, DiscoverySchedule shced) throws RemoteException;

説明

この関数を使用すると、実行する時間、頻度、および DiscoverySetting[] をスケジュールできます。DiscoverySetting[] には、ネットワーク IP アドレス、ネットマスク、グループ、および getDiscoveryAuthInfo から取得された認証データが含まれます。データを変更して DiscoverySchedule に設定できます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

discoverysched

DiscoverySchedule

--

スケジューラによって実行する時間、実行の頻度、およびサブネットや認証データ用の DiscoverySetting[] に関する詳細を含む DiscoverySchedule オブジェクト。

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。

registerScheduler

構文

registerScheduler(UserToken token, ClmTask taskName, Schedule schedule) throws RemoteException;

説明

この関数を使用すると、実行する時間、頻度、および特定の Cisco License Manager アクションをスケジュールできます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

taskName

スケジューラによって実行する Cisco License Manager サポート タスクの文字列を含む ClmTask オブジェクト。

sched

Schedule

--

スケジューラによって実行する時間、実行の頻度、およびサブネットや認証データ用の DiscoverySetting[] に関する詳細を含む DiscoverySchedule オブジェクト。

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。

registerServerStatusListener

構文

registerServerStatusListener(UserToken token,StatusListener listener) throws RemoteException;

説明

この関数を使用すると、クライアント プログラムのサーバ ステータス用リスナーを登録できます。サーバへの接続が失われると、リスナー オブジェクトの onStatus() メソッドが呼び出されます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

listener

String、必須

--

StatusListener インターフェイスを実装するオブジェクト。

戻り値

この関数は、登録が成功した場合は true を返し、失敗した場合は false を返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

unregisterDiscoveryScheduler

構文

Status unregisterDiscoveryScheduler(UserToken token) throws RemoteException;

説明

この関数を使用すると、スケジュールされている検出タスクをスケジューラから削除できます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。

unregisterScheduler

構文

Status unregisterScheduler(UserToken token, Schedule.ClmTask taskName) throws RemoteException;

説明

これは、スケジュールされているタスクをスケジューラから削除する単純なスケジュール関数です。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

taskName

Schedule.ClmTask、必須

--

スケジューラによって実行する Cisco License Manager サポート タスクの文字列を含む Schedule.ClmTask オブジェクト。

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。