Class PendingDeposit

  • All Implemented Interfaces:
    java.io.Serializable

    public abstract class PendingDeposit
    extends java.lang.Object
    implements java.io.Serializable
    Container representing a single RDE or BRDA XML escrow deposit that needs to be created.

    There are some @Nullable fields here because Optionals aren't Serializable.

    See Also:
    Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      static PendingDeposit create​(java.lang.String tld, org.joda.time.DateTime watermark, RdeMode mode, Cursor.CursorType cursor, org.joda.time.Duration interval)  
      static PendingDeposit createInManualOperation​(java.lang.String tld, org.joda.time.DateTime watermark, RdeMode mode, java.lang.String directoryWithTrailingSlash, java.lang.Integer revision)  
      abstract Cursor.CursorType cursor()
      The cursor type to update (not used in manual operation).
      abstract java.lang.String directoryWithTrailingSlash()
      Subdirectory of bucket/manual in which files should be placed, including a trailing slash (used only in manual operation).
      abstract org.joda.time.Duration interval()
      Amount of time to increment the cursor (not used in manual operation).
      abstract boolean manual()
      True if deposits should be generated via manual operation, which does not update the cursor, and saves the generated deposits in a special manual subdirectory tree.
      abstract RdeMode mode()
      Which type of deposit to generate: full (RDE) or thin (BRDA).
      abstract java.lang.Integer revision()
      Revision number for generated files; if absent, use the next available in the sequence (used only in manual operation).
      abstract java.lang.String tld()
      TLD for which a deposit should be generated.
      abstract org.joda.time.DateTime watermark()
      Watermark date for which a deposit should be generated.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • manual

        public abstract boolean manual()
        True if deposits should be generated via manual operation, which does not update the cursor, and saves the generated deposits in a special manual subdirectory tree.
      • tld

        public abstract java.lang.String tld()
        TLD for which a deposit should be generated.
      • watermark

        public abstract org.joda.time.DateTime watermark()
        Watermark date for which a deposit should be generated.
      • mode

        public abstract RdeMode mode()
        Which type of deposit to generate: full (RDE) or thin (BRDA).
      • cursor

        @Nullable
        public abstract Cursor.CursorType cursor()
        The cursor type to update (not used in manual operation).
      • interval

        @Nullable
        public abstract org.joda.time.Duration interval()
        Amount of time to increment the cursor (not used in manual operation).
      • directoryWithTrailingSlash

        @Nullable
        public abstract java.lang.String directoryWithTrailingSlash()
        Subdirectory of bucket/manual in which files should be placed, including a trailing slash (used only in manual operation).
      • revision

        @Nullable
        public abstract java.lang.Integer revision()
        Revision number for generated files; if absent, use the next available in the sequence (used only in manual operation).
      • createInManualOperation

        public static PendingDeposit createInManualOperation​(java.lang.String tld,
                                                             org.joda.time.DateTime watermark,
                                                             RdeMode mode,
                                                             java.lang.String directoryWithTrailingSlash,
                                                             @Nullable
                                                             java.lang.Integer revision)