ChangeSynergy::apiUser
ChangeSynergy::apiUser のインスタンスは、IBM Rational Change へのログインによって作成されます。 このクラスのインスタンスは、どの API 関数を呼び出すためにも必要です。
トークン・プロパティーはログイン時に自動的に設定されます。
このオブジェクトは新規ユーザーの作成にも使用されます。
以下のメソッドを使用できます。
新規ユーザーの作成時に使用されるデフォルトのコンストラクター。 sub new(username, password, role, database)
Login() 関数によって使用されるデフォルトのコンストラクター。 sub new(username, password, role, token, database)
新しく作成される ChangeSynergy::apiUser クラスを初期化して、ユーザーに関するすべての必須情報を表すようにします。
my $user = new ChangeSynergy::apiUser(username, password, role, database); my $user = new ChangeSynergy::apiUser(username, password, role, token, database);
パラメーター: username - ユーザーの名前。 password - ユーザーのパスワード。 role - ユーザーのロールまたはロール・リスト。(developer|ccm_admin|pt_admin) token - ユーザーのトークン。 database - ユーザーがログインされるデータベース。
スロー: die - ユーザー名が未定義の場合。 die - パスワードが未定義の場合。 die - ユーザー・ロールが未定義の場合。 die - データベースが未定義の場合。 die - トークンが未定義の場合。
ユーザーの IBM Rational Synergy データベース・パス・プロパティーを取得します。
my $database= $user->getUserDatabase()
戻り値: スカラー この apiUser オブジェクトの作成時に指定された IBM Rational Synergy データベース。
ユーザー名プロパティーを取得します。
my $username = $user->getUserName()
戻り値: スカラー この apiUser オブジェクトの作成時に指定されたユーザー名。
ユーザー・パスワード・プロパティーを取得します。
my $password = $user->getUserPassword()
戻り値: スカラー この apiUser オブジェクトの作成時に指定されたパスワード。
暗号化形式でユーザー・パスワード・プロパティーを取得します。
my $password = $user->getUserPasswordEncoded()
戻り値: スカラー この apiUser オブジェクトの作成時に指定された暗号化パスワード。
ユーザー・ロール・プロパティーを取得します。 PERL でオブジェクトを作成したときに指定されたロールを返します。 このメソッドは、ロール情報をデータベースから取得しないことに注意してください。
my $user = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database"); my $role = $user->getUserRole();
この事例では、ロールは「User」ロールです。
戻り値: スカラー この apiUser オブジェクトの作成時に指定されたロール。
ユーザー・ロール・リスト・プロパティーを取得します。 区切り文字はパイプ文字「|」です。 PERL でオブジェクトを作成したときに使用した 1 つまたは複数のロールを返します。 このメソッドは、ロール情報をデータベースから取得しないことに注意してください。
例 1: my $user = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database"); my $rolelist = $user->getUserRoleList();
ロール・リストには、ユーザーがログイン時に使用したロールが 1 つ含まれます。 この事例では「User」ロールです。
例 2: my $aNewUser = new ChangeSynergy::apiUser("jsmith", "4.jsmith", "developer|ccm_admin|pt_admin", "\\\\your_hostname\\ccmdb\\cm_database"); my $rolelist = $user->getUserRoleList();
このロール・リストには、オブジェクト作成時に定義された 3 つのロール developer、ccm_admin および pt_admin が含まれます。
戻り値: スカラー この apiUser オブジェクトの作成時に指定されたロール・リスト。
ユーザー・トークン・プロパティーを取得します。
my $token = $user->getUserToken()
戻り値: スカラー この apiUser オブジェクトの作成時に指定されたトークン、または Login メソッドの 1 つを呼び出した後に設定されたトークン。
このクラス・インスタンスの「トークン」(token) プロパティーを設定します。
$user->setUserToken($token)
パラメーター: token - この apiUser オブジェクトで指定されたユーザーのトークン。