Thor.API.Operations
Interface tcPasswordOperationsIntf

public interface tcPasswordOperationsIntf

Method Summary

Thor.API.tcResultSet	getObjectPasswordPolicy(long plObjectInstanceKey) Returns information about the password policy applying to the specified object.
Thor.API.tcResultSet	getUserPasswordPolicy(long plUserKey) Returns information about the Xellerate password policy applying to the specified user.
void	setObjectPasswords(long plUserKey, long[] palObjInsUsrKeys, java.lang.String psPassword) Sets the password for the user in the specified provisioned objects through Xellerate.
void	setXelleratePassword(long plUserKey, java.lang.String psPassword) Sets the password for the user in the Xellerate.

Method Detail

setXelleratePassword

public void setXelleratePassword(long plUserKey,
                                 java.lang.String psPassword)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcPolicyFailedException,
                                 tcAPIException

Sets the password for the user in the Xellerate.

Parameters:

plUserKey - - The User Key in the system

psPassword - - The password to set as the Users Xellerate password

Throws:

tcAPIException - - is thrown if user key is not found OR DataSet exceptions occur

tcPolicyFailedException - - thrown if the Password Policy Fails for specified password

setObjectPasswords

public void setObjectPasswords(long plUserKey,
                               long[] palObjInsUsrKeys,
                               java.lang.String psPassword)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcPolicyFailedException,
                               tcAPIException

Sets the password for the user in the specified provisioned objects through Xellerate.

Parameters:

plUserKey - - The User Key in the system

palObjInsUsrKeys - - An array of object instance user keys corresponding to the object instances whose passwords are to be set to the specified password.

psPassword - - The password to set as the Users password in the target systems

Throws:

tcAPIException - - thrown if User Key or one of the OIU keys are not found

tcPolicyFailedException - - throw if policy fails while setting the new password

getObjectPasswordPolicy

public Thor.API.tcResultSet getObjectPasswordPolicy(long plObjectInstanceKey)
                                             throws Thor.API.Exceptions.tcAPIException,
                                                    tcAPIException

Returns information about the password policy applying to the specified object. It figures out the policy that applies based on the policy rules that may be based on data saved for the user and the object instance.

Parameters:

plObjectInstanceKey - - The key of the object instance in the system.

Returns:

A tcResultSet containing one row, each column holding the value for one of the fields from the policy definition.

Throws:

tcAPIException - - thrown if OIU key is not found OR data set errors occur

getUserPasswordPolicy

public Thor.API.tcResultSet getUserPasswordPolicy(long plUserKey)
                                           throws Thor.API.Exceptions.tcAPIException,
                                                  tcAPIException

Returns information about the Xellerate password policy applying to the specified user. It figures out the policy that applies based on the policy rules that may be based on data saved for the user.

Parameters:

plUserKey - - The key of the user in the system.

Returns:

A tcResultSet containing one row, each column holding the value for one of the fields from the policy definition.

Throws:

tcAPIException - - thrown if User Key is not found OR data set errors occur