Package com.github.toolarium.processing.unit.runtime.runnable

Interface IProcessingUnitProxy

  • All Known Implementing Classes:
    ProcessingUnitProxy
    public interface IProcessingUnitProxy
    Defines the IProcessingUnit proxy. It manages the full handling for startup, possible suspends/resumes and ending even the validation.

    • Method Detail

      • getId

        java.lang.String getId()
        Get the runnable id
        Returns:
        the runnable id

      • getName

        java.lang.String getName()
        Get the runnable name or null
        Returns:
        the name or null

      • getParameterDefinition

        java.util.List<ParameterDefinition> getParameterDefinition()
        Gets the parameter definition list of the processing.
        Returns:
        the parameter definition list or null in case of no parameters

      • getProcessingUnitProgress

        IProcessingUnitProgress getProcessingUnitProgress()
        Gets the processing unit progress
        Returns:
        the processing unit progress

      • getMaxNumberOfProcessingUnitCallsPerSecond

        java.lang.Long getMaxNumberOfProcessingUnitCallsPerSecond()
        Get the max number of processing unit calls per seconds
        Returns:
        The max number of processing unit calls per seconds

      • processUnit

        boolean processUnit()
        Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false or an exception occurs: RuntimeException will abort; ValidationException or ProcessingException depends on the value returned by the method abortProcessing. Important: this method have to process the sequential or in a small block size.
        Returns:
        true to continue the processing; otherwise false

      • onEnding

        void onEnding()
        This method is called on ending after a successful end (status ending) before the resources are released.

      • onAborting

        void onAborting()
        This method is called in case of an abort (status aborting) before the resources are released.

      • suspendProcessing

        byte[] suspendProcessing()
                  throws ProcessingException
        Suspends the processing: The processing is able to persist its state with the help of the IProcessingUnitPersistence object. On a resume this instance of the IProcessingUnitPersistence will be returned (see method below).
        Returns:
        the processing persistence which contains all information to resume processing later (see resumeProcessing).
        Throws:
        ProcessingException - Throws this exception in case of while suspend the processing any failures occurs.

      • releaseResource

        void releaseResource()
              throws ProcessingException
        Release resources will be called to release all internal referenced resources after a processing success, error or by a suspendProcessing (see method below). It will be called after onEnding() or onAborting().
        Throws:
        ProcessingException - Throws this exception in case of releasing failure.