com.ibm.itim.apps.system

Class SystemUserMO

  • java.lang.Object
    • com.ibm.itim.apps.system.SystemUserMO


  • public class SystemUserMO
    extends java.lang.Object
    Managed object representing a TIM user.
    • Constructor Summary

      Constructors 
      Constructor and Description
      SystemUserMO(PlatformContext platform, javax.security.auth.Subject subject, DistinguishedName name)
      Constructs the the managed object with a platform context, a subject, and the distinguished name of the object to manage.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      SystemUser getData()
      Returns a current snapshot of the data defining the provisioning object.
      DistinguishedName getDistinguishedName()
      Returns the distinguished name of the managed object
      PersonMO getOwner()
      Returns the account owner.
      com.ibm.itim.dataservices.view.View getView()
      Returns the View defining the the set of tasks available to the user.
      boolean isChangePasswordRequired()
      This method returns true, if the Identity Governance account password must be changed.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SystemUserMO

        public SystemUserMO(PlatformContext platform,
                            javax.security.auth.Subject subject,
                            DistinguishedName name)
        Constructs the the managed object with a platform context, a subject, and the distinguished name of the object to manage.
        Parameters:
        platform - PlatformContext holding platform connection information.
        subject - Subject representing the authenticated caller.
        name - DistinguishedName identifying the system's user.
    • Method Detail

      • getDistinguishedName

        public DistinguishedName getDistinguishedName()
        Returns the distinguished name of the managed object
        Returns:
        DistinguishedName of the managed object.
      • getData

        public SystemUser getData()
                           throws java.rmi.RemoteException,
                                  ApplicationException
        Returns a current snapshot of the data defining the provisioning object.
        Returns:
        SystemUser object holding attribute information.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if unable to retrieve data. This exception is thrown also when the SystemUserMO contains a null DistinguishedName.
      • getOwner

        public PersonMO getOwner()
                          throws java.rmi.RemoteException,
                                 ApplicationException
        Returns the account owner.
        Returns:
        PersonMO representing the account owner.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if unable to retrieve the account owner. This exception is thrown also when the SystemUserMO contains a null DistinguishedName.
      • getView

        public com.ibm.itim.dataservices.view.View getView()
                                                    throws java.rmi.RemoteException,
                                                           ApplicationException
        Returns the View defining the the set of tasks available to the user.
        Returns:
        view for the user.
        Throws:
        java.rmi.RemoteException - if unable to communicate with the platform.
        ApplicationException - if unable to retrieve the view for the user. This exception is thrown also when the SystemUserMO contains a null DistinguishedName.
      • isChangePasswordRequired

        public boolean isChangePasswordRequired()
                                         throws ApplicationException
        This method returns true, if the Identity Governance account password must be changed. The Identity Governance account password must be changed, if the authentication user repository is a Security Identity Manager custom user repository and either of these two conditions exist.
           - The password of a Identity Governance system user is expired.
           - The Change password on next logon flag is set.
         
        Returns:
        This method returns true, if the Identity Governance account password must be changed; false, if otherwise.
        Throws:
        ApplicationException - This exception is thrown if the method is unable to obtain the system user information. This error might be caused by a communication error or by a missing system user.