com.ibm.itim.apps.identity

Class SelfRequest

  • java.lang.Object
    • com.ibm.itim.apps.identity.SelfRequest

  • public class SelfRequest
extends java.lang.Object
    Represents a request submitted to the provisioning platform.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int FAILED
      Constant identifying the failed status.
      static int IN_PROCESS
      Constant identifying the in-process status.
      static int NOT_STARTED
      Constant identifying the not-started status.
      static int SUCCEEDED
      Constant identifying the successfully completed status.
      static int WARNING
      Constant identifying the warning status.

    • Constructor Summary

      Constructors 
      Constructor and Description
      SelfRequest(PlatformContext platform, javax.security.auth.Subject subject, long id)
      Constructs with a platform, userId, and request id.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void abort()
      Aborts the request.
      long getID()
      Returns the ID of the request.
      int getStatus()
      Returns the status of the request.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • NOT_STARTED

        public static final int NOT_STARTED
        Constant identifying the not-started status.
        See Also:
        Constant Field Values

      • IN_PROCESS

        public static final int IN_PROCESS
        Constant identifying the in-process status.
        See Also:
        Constant Field Values

      • SUCCEEDED

        public static final int SUCCEEDED
        Constant identifying the successfully completed status.
        See Also:
        Constant Field Values

      • FAILED

        public static final int FAILED
        Constant identifying the failed status.
        See Also:
        Constant Field Values

      • WARNING

        public static final int WARNING
        Constant identifying the warning status.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SelfRequest

        public SelfRequest(PlatformContext platform,
                   javax.security.auth.Subject subject,
                   long id)
        Constructs with a platform, userId, and request id.
        Parameters:
        platform - PlatformContext holding platform connection information.
        subject - Authenticated user.
        id - Unique id of the request.

    • Method Detail

      • getID

        public long getID()
        Returns the ID of the request.
        Returns:
        ID of the request.

      • getStatus

        public int getStatus()
              throws java.rmi.RemoteException,
                     ApplicationException
        Returns the status of the request.
        Returns:
        Enumeration of the request status. The value may be one of the following: NOT_STARTED, IN_PROCESS, SUCCEEDED, WARNING, or FAILED.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if no request exists with the given ID.

      • abort

        public void abort()
           throws java.rmi.RemoteException,
                  ApplicationException
        Aborts the request.
        Throws:
        java.rmi.RemoteException - Thrown if unable to communicate with platform.
        ApplicationException - Thrown if no request exists with the given ID.
Skip navigation links