Package com.ibm.di.server

Interface CheckpointRestartInterface

  • @Deprecated
public interface CheckpointRestartInterface
    Deprecated.
    We no longer support Checkpoint/restart
    This interface is implemented by connectors and parsers that support checkpoint/restart.

    • Field Detail

      • RESTART_BEFORE

        static final int RESTART_BEFORE
        Deprecated.
        Restart before current point.
        See Also:
        Constant Field Values

      • RESTART_IN

        static final int RESTART_IN
        Deprecated.
        Restart at current point.
        See Also:
        Constant Field Values

      • RESTART_AFTER

        static final int RESTART_AFTER
        Deprecated.
        Restart after current point.
        See Also:
        Constant Field Values

    • Method Detail

      • isCheckpointRestartEnabled

        boolean isCheckpointRestartEnabled​(int mode)
        Deprecated.
        Components that support checkpoint/restart for a specific mode must return TRUE from this method. If a restart has no meaning for mode then the connector should still return TRUE.
        Parameters:
        mode - The mode the connector runs in
        Returns:
        true if checkpoint is supported in mode
        See Also:
        ServerConstants

      • getCheckpointInformation

        Entry getCheckpointInformation()
                        throws java.lang.Exception
        Deprecated.
        Returns the state information for the connector. If for some reason the connector decides that a restart is impossible it must throw an exception. The method is called immediately before any component methods are called. If there is no need to save any state information a null value should be returned.
        Returns:
        The entry the connector needs to do a restart or null if that is not needed.
        Throws:
        java.lang.Exception - if problem occurs

      • prepareForRestart

        void prepareForRestart​(ALState state,
                       Entry restartInfo,
                       int restartPoint)
                throws java.lang.Exception
        Deprecated.
        Notifies the connector of a restart situation. This method is called after the connector has been loaded and before any other method calls are made to the connector. If the connector decides it cannot restart it must throw an exception.
        Parameters:
        restartInfo - The last entry object returned by the connector in the getCheckpointInformation method
        state - The ALState object for the AssemblyLine
        restartPoint - The relative point where restarting is taking place (e.g. RESTART_BEFORE ...)
        Throws:
        java.lang.Exception - if problem occurs