dawidwys commented on pull request #17151:
URL: https://github.com/apache/flink/pull/17151#issuecomment-915964079


   This PR breaks the contract introduced in 
https://issues.apache.org/jira/browse/FLINK-11696. The javadoc states the 
`initializeBaseLocations` should be called before calling either of 
`initializeLocationForCheckpoint`, `initializeLocationForSavepoint`:
   ```
      /**
        * Initializes the necessary prerequisites for storage locations of 
checkpoints/savepoints.
        *
        * <p>For file-based checkpoint storage, this method would initialize 
essential base checkpoint
        * directories on checkpoint coordinator side and should be executed 
before calling {@link
        * #initializeLocationForCheckpoint(long)} and {@link 
#initializeLocationForSavepoint(long,
        * String)}.
        *
        * @throws IOException Thrown, if these base storage locations cannot be 
initialized due to an
        *     I/O exception.
        */
       void initializeBaseLocations() throws IOException;
   ```
   I think in the end there is no harm doing so, but a the very least the 
javadoc **must** be updated. I would even suggest renaming 
`initializeBaseLocations` to `initializeBaseLocationsForCheckpoints`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to