Package Thor.API.Operations

Interface tcPasswordOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf
public interface tcPasswordOperationsIntf extends tcUtilityOperationsIntf

  • Method Details

    • setXelleratePassword

      void setXelleratePassword(long plUserKey, String psPassword) throws tcAPIException, tcPolicyFailedException, tcAPIException
      Sets the password for the user in the OIM.
      Parameters:
      plUserKey - - The User Key in the system
      psPassword - - The password to set as the Users OIM 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

    • setXelleratePassword

      void setXelleratePassword(long plUserKey, String psPassword, boolean changePasswordNextLogon) throws tcAPIException, tcPolicyFailedException, tcAPIException
      Sets the password for the user in the OIM.
      Parameters:
      plUserKey - - The User Key in the system
      psPassword - - The password to set as the Users OIM password
      changePasswordNextLogon - - Flag to change password on logon for Users
      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

      @Deprecated void setObjectPasswords(long plUserKey, long[] palObjInsUsrKeys, String psPassword) throws tcAPIException, tcPolicyFailedException, tcAPIException
      Deprecated.
      Sets the password for the user in the specified provisioned objects through OIM.
      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

      Thor.API.tcResultSet getObjectPasswordPolicy(long plObjectInstanceKey) throws 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

      Thor.API.tcResultSet getUserPasswordPolicy(long plUserKey) throws tcAPIException, tcAPIException
      Returns information about the OIM 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

    • getUserPasswordPolicyDescription

      HashMap getUserPasswordPolicyDescription(long userKey) throws tcAPIException, tcAPIException
      This method returns password policy description in hashmap that is applicable on 'Xellerate User' object
      Parameters:
      userKey - (long) for whom password policy is applicable
      Returns:
      hashmap containing password policy description
      Throws:
      com.thortech.xl.dataaccess.tcDataSetException
      tcAPIException
      tcAPIException

    • getObjectInstancePasswordPolicyDescription

      HashMap getObjectInstancePasswordPolicyDescription(long objectInstanceKey) throws tcAPIException, tcAPIException
      Returns password policy description in a map by object instance key.
      Parameters:
      objectInstanceKey -
      Returns:
      Throws:
      com.thortech.xl.dataaccess.tcDataSetException
      tcAPIException
      tcAPIException

    • getObjectPasswordPolicyDescription

      HashMap getObjectPasswordPolicyDescription(long objectKey) throws tcAPIException, tcAPIException
      This method returns password policy description in hashmap that is applicable on resource object for given object key
      Parameters:
      objectKey - (long) on which password policy is applicable
      Returns:
      hashmap containing password policy description
      Throws:
      com.thortech.xl.dataaccess.tcDataSetException
      tcAPIException
      tcAPIException

    • getObjectPasswordPolicyDescription

      HashMap getObjectPasswordPolicyDescription(long objectKey, long userKey) throws tcAPIException, tcAPIException
      This method returns password policy description in hashmap that is applicable on resource object for given object key
      Parameters:
      objectKey - (long) on which password policy is applicable
      userKey - (long) for whom password policy is applicable
      Returns:
      hashmap containing password policy description
      Throws:
      com.thortech.xl.dataaccess.tcDataSetException
      tcAPIException
      tcAPIException
      Since:
      9.1

    • getProcessPasswordPolicyDescription

      HashMap getProcessPasswordPolicyDescription(long processInstanceKey) throws tcAPIException, tcAPIException
      This method returns password policy description in hashmap that is applicable on resource object that is attached to a process of which this processInstanceKey is a key of process instance.
      Parameters:
      processInstanceKey - (long)
      Returns:
      hashmap containing password policy description
      Throws:
      com.thortech.xl.dataaccess.tcDataSetException
      tcAPIException
      tcAPIException