Interface GroupChangesForSinglePeerStrategy

  • All Superinterfaces:
    SaveStrategy

    @API(type=EXTENDABLE,
         src=PUBLIC)
    public interface GroupChangesForSinglePeerStrategy
    extends SaveStrategy
    Details required when saving a concurrently edited document. Used to write document snapshots with changes made from the last save, where each snapshot is capturing changes made by a single peer. It facilitates tracking precise authorship of changes, each written revision containing changes by only one author.
    Since:
    23.1.1
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.net.URLConnection openConnection​(java.net.URL documentUrl, PeerContext author)
      This method will be called whenever a peer within a concurrent editing session triggers either a save or a auto-save.
    • Method Detail

      • openConnection

        java.net.URLConnection openConnection​(java.net.URL documentUrl,
                                              PeerContext author)
                                       throws java.io.IOException
        This method will be called whenever a peer within a concurrent editing session triggers either a save or a auto-save. It facilitates storing revisions for each peer individually.
        Parameters:
        documentUrl - The document URL. Note that it has the UserInfo stripped.
        author - The context of peer whose only changes are about to be saved onto the URL connection.
        Returns:
        A connection where to write the new revision.
        Throws:
        java.io.IOException - If fails to open the connect.