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

目次

ユーザ ログインおよびログアウト関数

checkUserEULAStatus

login

logout

ユーザ ログインおよびログアウト関数

この章では、次のユーザ ログインおよびログアウト関数に関する情報を示します。

「checkUserEULAStatus」

「login」

「logout」

checkUserEULAStatus

構文

EulaInfo checkUserEULAStatus(String username, String server_host, int port)
throws RemoteException;

説明

この関数は、ユーザが End-User License Agreement(EULA; 使用許諾契約)に署名しているかどうかをチェックします。

入力パラメータ

 

パラメータ
タイプ
説明

username

String、必須

--

ユーザ名。

server_host

String、必須

ホスト名または IP アドレス

Cisco License Manager サーバが実行されているホスト名または IP アドレス。Cisco License Manager サーバとクライアント プログラムが同じホストで実行されている場合、この引数は null に設定できます。

port

Integer、必須

1024 ~ 65535 の範囲

Cisco License Manager サーバがクライアントへのサービスの提供に使用するポート。Cisco License Manager サーバとクライアント プログラムが同じホストで実行されている場合、この引数は 0 に設定できます。

戻り値

この関数は EulaInfo オブジェクトを返します。このオブジェクトには EULA 情報(EULA が署名されているかどうかを示す値や署名された日時など)が含まれます。

エラーと例外

エラーが発生した場合、この関数は null を返します。

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

login

構文

UserToken login(String username, String password, String server_host, int port, int idle_timeout, EulaInfo eula) throws RemoteException;

説明

この関数は、システムにログインし、以降の関数呼び出しの許可を得るための UserToken を取得するために使用します。ユーザがシステムにログインできるのは一度に 1 つのセッションだけです。同じユーザで 2 回ログインすると、すでにログインしているセッションが自動的にログアウトします。

入力パラメータ

 

パラメータ
タイプ
説明

username

String、必須

--

ユーザ名。

password

String、必須

--

ユーザ パスワード。

server_host

String、必須

ホスト名または IP アドレス

Cisco License Manager サーバが実行されているホスト名または IP アドレス。Cisco License Manager サーバとクライアント プログラムが同じホストで実行されている場合、この引数は null に設定できます。

port

Integer、必須

--

Cisco License Manager サーバがクライアントへのサービスの提供に使用するポート。Cisco License Manager サーバとクライアント プログラムが同じホストで実行されている場合、この引数は 0 に設定できます。

idle_timeout

Integer、必須

0 ~ 1440 の範囲

トークンが有効期限切れになるためのアイドル時間(分単位)。0 に設定すると、トークンは無期限に有効になります。

eula

EulaInfo、必須

--

EulaInfo オブジェクトには、EULA が同意されているかどうか、および次回のセッションで再び EULA への同意を確認するかどうかを示す値が含まれます。

戻り値

この関数は、ユーザの認証パスを表す UserToken オブジェクトを返します。EULA が同意されていない場合、認証パスは拒否されます。

エラーと例外

エラーが発生した場合、この関数は null を返します。

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

logout

構文

void logout(UserToken token) throws RemoteException;

説明

この関数は、ユーザをシステムからログアウトし、UserToken オブジェクトを削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

戻り値

なし。

エラーと例外

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