Package com.identityworksllc.iiq.common.service

Interface BaseServiceImplementation

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void afterExecution​(sailpoint.api.SailPointContext context)
      Hook to execute after execution of the service implementation.
      default void beforeExecution​(sailpoint.api.SailPointContext context)
      Hook to execute before execution of the service implementation.
      void execute​(sailpoint.api.SailPointContext context)
      The main entry point of the service, invoked by the Servicer
      sailpoint.object.ServiceDefinition getDefinition()
      Gets the service definition
      void implementation​(sailpoint.api.SailPointContext context)
      Your code goes here and will be invoked by execute(SailPointContext) after some setup and validation
      void incrementExecutions()
      Increments the execution count and sets the executed-once flag to true
      default int skipExecutionCount()
      Return the number of executions that should be skipped on service startup.

    • Method Detail

      • afterExecution

        default void afterExecution​(sailpoint.api.SailPointContext context)
                     throws sailpoint.tools.GeneralException
        Hook to execute after execution of the service implementation.

        If you override this, be sure to invoke super.afterExecution() so that the default behaviors still occur.

        Parameters:
        context - The IIQ context
        Throws:
        sailpoint.tools.GeneralException - if anything goes wrong

      • beforeExecution

        default void beforeExecution​(sailpoint.api.SailPointContext context)
                      throws sailpoint.tools.GeneralException
        Hook to execute before execution of the service implementation.

        If you override this, be sure to invoke super.afterExecution() so that the default behaviors still occur.

        Parameters:
        context - The IIQ context
        Throws:
        sailpoint.tools.GeneralException - if anything goes wrong

      • getDefinition

        sailpoint.object.ServiceDefinition getDefinition()
        Gets the service definition
        Returns:
        The service definition, supplied by the Servicer at runtime

      • execute

        void execute​(sailpoint.api.SailPointContext context)
      throws sailpoint.tools.GeneralException
        The main entry point of the service, invoked by the Servicer
        Parameters:
        context - The IIQ context for this service run
        Throws:
        sailpoint.tools.GeneralException - if the service execution failed

      • implementation

        void implementation​(sailpoint.api.SailPointContext context)
             throws sailpoint.tools.GeneralException
        Your code goes here and will be invoked by execute(SailPointContext) after some setup and validation
        Parameters:
        context - IIQ context
        Throws:
        sailpoint.tools.GeneralException - if any failures occur

      • incrementExecutions

        void incrementExecutions()
        Increments the execution count and sets the executed-once flag to true

      • skipExecutionCount

        default int skipExecutionCount()
        Return the number of executions that should be skipped on service startup.

        This can allow the IIQ server to start up without having to worry about this service doing weird stuff during initialization or heavy startup load.

        The subclass can override this, or the ServiceDefinition can specify ‘skipExecutionCount’ as an attribute.

        Returns:
        The number of executions that should be skipped, default 0