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

目次

アクセス制御関数

addUserToDeviceAccessList

addUserToGroupAccessList

addUserToPAKAccessList

getAssociatedActions

getUserAccessListFromDevice

getUserAccessListFromGroup

getUserAccessListFromPAK

removeAccessListFromDevice

removeAccessListFromGroup

removeUserFromDeviceAccessList

removeUserFromGroupAccessList

removeUserFromPAKAccessList

addUserToDeviceAccessList

構文

public IDStatus addDevicesToGroup(UserToken token,String[] devIDs, String group) throws RemoteException;

説明

この関数は、ユーザ ID の配列を特定のデバイスのアクセス リストに追加します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

devIDs

String、必須

--

グループに追加するデバイス ID の配列。

group

String、必須

--

グループの名前。

戻り値

この関数は IDStatus オブジェクトを返します。操作が成功した場合、IDStatus オブジェクトで次の情報が返されます。

エラー コードは ClmErrors.SUCCESS になります。

追加されるデバイスの ID が IDStatusItem 配列に格納されます。

正常に追加された各項目の IDStatusItem エラー コードが CLMError.SUCCESS になります。

エラーと例外

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

個々の要素のステータスを調べるには、DeviceStatus に含まれる DeviceStatusItem 配列を反復処理する必要があります。各 DeviceStatusItem には、Device オブジェクト、エラー コード、およびエラー メッセージが含まれます。

addUserToGroupAccessList

構文

GroupStatus addUserToGroupAccessList(UserToken token, String group, String[] usr_ids) throws RemoteException;

説明

この関数は、ユーザ ID の配列を特定のグループのアクセス リストに追加します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

--

グループ ID。

user_ids

String の配列、必須

--

デバイス アクセス リストに追加するユーザ ID の配列。

戻り値

この関数は、操作エラーが発生した場合、エラー コードとエラー メッセージを含む GroupStatus オブジェクトを返します。各 GroupStatusItem には、個々の Group オブジェクト、エラー コード、およびエラー メッセージが含まれます。

エラーと例外

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

addUserToPAKAccessList

構文

PAKStatus addUserToPAKAccessList(UserToken token, String pak, String[] usr_ids) throws RemoteException;

説明

この関数は、ユーザにアクセス制御を提供します。この関数は、ユーザ ID の配列を特定の Product Authorization Key(PAK; 製品認証キー)名のアクセス リストに追加します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

pak

String、必須

--

PAK ID。PAK オブジェクトの各インスタンスの名前として使用される PAK ID の配列。

User_ids

String の配列、必須

--

PAK アクセス リストに追加するユーザ ID の配列。

戻り値

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

エラーと例外

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

PAKStatus には操作全体のステータスが含まれます。システムレベルのエラーが発生して操作が完了できなかったとき、PAKStatus のエラー コードは SUCCESS 以外になり、エラーの原因がわかっている場合はエラー メッセージが返されます。PAKStatus には、各 ID に対応する要素を持つ PAKStatusItem の配列が含まれます。各 PAKStatusItem には、PAK オブジェクト、個々のステータスを示すエラー コード、およびエラー メッセージが含まれます。

getAssociatedActions

構文

String[] getAssociatedActions(UserToken token,String username) throws RemoteException;

説明

この関数は、実行可能なアクションを表す文字列のリストを返します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

username

String、必須

--

ユーザ名。

戻り値

この関数はユーザ名の配列を返します。

エラーと例外

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

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

getUserAccessListFromDevice

構文

String[] getUserAccessListFromDevice (UserToken token, String dev_id) throws RemoteException;

説明

この関数は、特定のデバイス ID のユーザ アクセス リストを文字列の配列として返します。各文字列は 1 つのユーザ ID を表します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev_id

String、必須

--

デバイス ID。

戻り値

この関数はデバイス ID を返します。指定したデバイスにアクセス リストがない場合は null が返されます。

エラーと例外

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

getUserAccessListFromGroup

構文

String[] getUserAccessListFromGroup (UserToken token, String group) throws RemoteException;

説明

この関数は、特定のグループのユーザ アクセス リストを文字列の配列として返します。各文字列は 1 つのユーザ ID を表します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

--

グループ名。

戻り値

この関数は文字列の配列を返します。指定したグループにアクセス リストがない場合は null が返されます。

エラーと例外

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

getUserAccessListFromPAK

構文

String[]getUserAccessListFromPAK (UserToken token, String pak_id) throws RemoteException;

説明

この関数は、特定の PAK のユーザ アクセス リストを文字列の配列として返します。各文字列は 1 つのユーザ ID を表します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

pak_id

String、必須

--

PAK オブジェクトの各インスタンスの名前として使用される PAK ID の配列。

戻り値

この関数は文字列の配列を返します。

エラーと例外

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

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

removeAccessListFromDevice

構文

public Status removeAccessListFromDevice(UserToken token, String dev_id) throws RemoteException;

説明

この関数は、指定したデバイスのアクセス リストを削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev_id

String、必須

--

アクセス リストを削除するデバイス ID。

戻り値

この関数は Status オブジェクトを返します。エラーが発生した場合、Status オブジェクトは ClmErrors.SUCCESS 以外のエラー コードを返し、エラーに関するエラー メッセージを表示します。

エラーと例外

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

removeAccessListFromGroup

構文

public Status removeAccessListFromGroup(UserToken token, String group_id) throws RemoteException;

説明

この関数は、指定したグループのアクセス リストを削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group_id

String、必須

--

アクセス リストを削除するグループ ID。

戻り値

この関数は Status オブジェクトを返します。エラーが発生した場合、Status オブジェクトは ClmErrors.SUCCESS 以外のエラー コードを返し、エラーに関するエラー メッセージを表示します。

エラーと例外

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

removeUserFromDeviceAccessList

構文

DeviceStatus removeUserFromDeviceAccessList(UserToken token, String dev, String[] usr_ids) throws RemoteException;

説明

この関数は、特定のデバイスのアクセス リストからユーザ ID のリストを削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev

String、必須

--

デバイス ID。

usr_ids

String の配列、必須

--

デバイス アクセス リストから削除するユーザ ID の配列。

戻り値

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

エラーと例外

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

操作エラーが発生した場合は、エラーに関する情報を含む DeviceStatus オブジェクトが返されます。個々の要素のステータスを調べるには、DeviceStatus に含まれる DeviceStatusItem 配列を反復処理する必要があります。各 DeviceStatusItem には、Device オブジェクト、エラー コード、およびエラー メッセージが含まれます。

removeUserFromGroupAccessList

構文

GroupStatus removeUserFromDeviceAccessList(UserToken token, String group, String[] usr_ids) throws RemoteException;

説明

この関数は、特定のグループのアクセス リストからユーザ ID のリストを削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

--

グループ名。

user_ids

String の配列、必須

--

グループ アクセス リストから削除するユーザ ID の配列。

戻り値

この関数は、操作エラーが発生した場合、エラー コードとエラー メッセージを含む GroupStatus オブジェクトを返します。各 GroupStatusItem には、個々の Group オブジェクト、エラー コード、およびエラー メッセージが含まれます。

エラーと例外

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

removeUserFromPAKAccessList

構文

PAKStatus removeUserFromPAKAccessList(UserToken token, String pak, String[] usr_ids) throws RemoteException);

説明

この関数は、特定の PAK のアクセス リストから特定のユーザ ID を削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

pak

String、必須

--

PAK オブジェクトの各インスタンスの名前として使用される PAK ID の配列。

Usr_ids

String の配列、必須

--

PAK アクセス リストから削除するユーザ ID の配列。

戻り値

この関数は PAKStatus オブジェクトを返します。操作が成功した場合、エラー コードは SUCCESS になります。PAKStatus には PAKStatusItem の配列が含まれます。各 PAKStatusItem には、PAK オブジェクト、エラー コード、およびエラー メッセージが含まれます。

エラーと例外

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

PAKStatus には操作全体のステータスが含まれます。システムレベルのエラーが発生して操作が完了できなかったとき、PAKStatus のエラー コードは SUCCESS 以外になり、エラーの原因がわかっている場合はエラー メッセージが返されます。PAKStatus には、各 ID に対応する要素を持つ PAKStatusItem の配列が含まれます。各 PAKStatusItem には、PAK オブジェクト、個々のステータスを示すエラー コード、およびエラー メッセージが含まれます。