名称

ChangeSynergy::apiUser


描述

ChangeSynergy::apiUser 的实例通过登录 IBM Rational Change 创建。 调用任何 api 函数都需要使用此类的实例。

登录时,自动设置令牌属性。

创建新用户,还需要对象。


方法

以下方法可用:

new
 创建新用户时使用的缺省构造函数。


 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 - 令牌不能未定义。

getUserDatabase

获取用户 IBM Rational Synergy 数据库路径属性。

my $database= $user->getUserDatabase()

 返回:标量
创建 apiUser 对象时指定的 IBM Rational Synergy 数据库。
getUserName

获取用户名属性。

my $username = $user->getUserName()

 返回:标量
创建 apiUser 对象时指定的用户名。
getUserPassword

获取用户密码属性

my $password = $user->getUserPassword()

 返回:标量
创建 apiUser 对象时指定的密码。
getUserPasswordEncoded

获取编码格式的用户密码属性。

my $password = $user->getUserPasswordEncoded()

 返回:标量
创建 apiUser 对象时指定的经过编码的密码。
getUserRole

获取用户角色属性。将返回在 PERL 中创建对象时使用的角色。请注意,此方法将不能从数据库获取任何角色信息。

my $user = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database"); my $role = $user->getUserRole();

本例中角色将为“User”角色。

 返回:标量
创建 apiUser 对象时指定的角色。
getUserRoleList

获取用户角色列表属性。定界符是字符“|”。 此方法将返回在 PERL 中创建对象时使用的一个或多个角色。 请注意,此方法将不能从数据库获取任何角色信息。

示例 1: my $user = $csapi->Login("u00001", "u00001", "User", "\\\\your_hostname\\ccmdb\\cm_database"); my $rolelist = $user->getUserRoleList();

角色列表将包含用户登录时使用的一个角色。本例中为“User”角色。

示例 2: my $aNewUser = new ChangeSynergy::apiUser("jsmith", "4.jsmith", "developer|ccm_admin|pt_admin", "\\\\your_hostname\\ccmdb\\cm_database"); my $rolelist = $user->getUserRoleList();

角色列表将包含创建对象时定义的三个角色:developer、ccm_admin 和 pt_admin。

 返回:标量
创建 apiUser 对象时指定的角色列表。
getUserToken

获取用户令牌属性。

my $token = $user->getUserToken()

 返回:标量
创建 apiUser 对象时指定的令牌,或调用其中一种登录方法后设置的令牌。
setUserToken

设置类实例的“令牌”属性。

$user->setUserToken($token)

 参数:
	token - 在 apiUser 对象中指定的用户令牌。