Class DeadLetterSchema.Builder

java.lang.Object
org.axonframework.eventhandling.deadletter.jdbc.DeadLetterSchema.Builder
Enclosing class:
DeadLetterSchema

public static class DeadLetterSchema.Builder extends Object
Instantiate a builder to construct a DeadLetterSchema.

All configurable columns default to their respective field name. Thus, the result of the DeadLetterSchema.diagnosticsColumn() defaults to diagnosticsColumn, etc.

  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • deadLetterTable

      public DeadLetterSchema.Builder deadLetterTable(String deadLetterTable)
      Sets the name of the dead-letter table. Defaults to DeadLetterEntry.
      Parameters:
      deadLetterTable - The name for the dead-letter table.
      Returns:
      The current Builder instance, for fluent interfacing.
    • deadLetterIdentifierColumn

      public DeadLetterSchema.Builder deadLetterIdentifierColumn(String deadLetterIdentifierColumn)
      Sets the name of the deadLetterIdentifier column. Defaults to deadLetterIdentifier.
      Parameters:
      deadLetterIdentifierColumn - The name for the deadLetterIdentifier column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • processingGroupColumn

      public DeadLetterSchema.Builder processingGroupColumn(String processingGroupColumn)
      Sets the name of the processingGroup column. Defaults to processingGroup.
      Parameters:
      processingGroupColumn - The name for the processingGroup column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • sequenceIdentifierColumn

      public DeadLetterSchema.Builder sequenceIdentifierColumn(String sequenceIdentifierColumn)
      Sets the name of the sequenceIdentifier column. Defaults to sequenceIdentifier.
      Parameters:
      sequenceIdentifierColumn - The name for the sequenceIdentifier column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • sequenceIndexColumn

      public DeadLetterSchema.Builder sequenceIndexColumn(String sequenceIndexColumn)
      Sets the name of the sequenceIndex column. Defaults to sequenceIndex.
      Parameters:
      sequenceIndexColumn - The name for the sequenceIndex column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • messageTypeColumn

      public DeadLetterSchema.Builder messageTypeColumn(String messageTypeColumn)
      Sets the name of the messageType column. Defaults to messageType.
      Parameters:
      messageTypeColumn - The name for the messageType column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • eventIdentifierColumn

      public DeadLetterSchema.Builder eventIdentifierColumn(String eventIdentifierColumn)
      Sets the name of the eventIdentifier column. Defaults to eventIdentifier.
      Parameters:
      eventIdentifierColumn - The name for the eventIdentifier column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • timestampColumn

      public DeadLetterSchema.Builder timestampColumn(String timestampColumn)
      Sets the name of the timestamp column. Defaults to timestamp.
      Parameters:
      timestampColumn - The name for the timeStamp column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • payloadTypeColumn

      public DeadLetterSchema.Builder payloadTypeColumn(String payloadTypeColumn)
      Sets the name of the payloadType column. Defaults to payloadType.
      Parameters:
      payloadTypeColumn - The name for the payloadType column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • payloadRevisionColumn

      public DeadLetterSchema.Builder payloadRevisionColumn(String payloadRevisionColumn)
      Sets the name of the payloadRevision column. Defaults to payloadRevision.
      Parameters:
      payloadRevisionColumn - The name for the payloadRevision column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • payloadColumn

      public DeadLetterSchema.Builder payloadColumn(String payloadColumn)
      Sets the name of the payload column. Defaults to payload.
      Parameters:
      payloadColumn - The name for the payload column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • metaDataColumn

      public DeadLetterSchema.Builder metaDataColumn(String metaDataColumn)
      Sets the name of the metaData column. Defaults to metaData.
      Parameters:
      metaDataColumn - The name for the metaData column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • aggregateTypeColumn

      public DeadLetterSchema.Builder aggregateTypeColumn(String aggregateTypeColumn)
      Sets the name of the aggregateType column. Defaults to type.
      Parameters:
      aggregateTypeColumn - The name for the aggregateType column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • aggregateIdentifierColumn

      public DeadLetterSchema.Builder aggregateIdentifierColumn(String aggregateIdentifierColumn)
      Sets the name of the aggregateIdentifier column. Defaults to aggregateIdentifier.
      Parameters:
      aggregateIdentifierColumn - The name for the aggregateIdentifier column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • sequenceNumberColumn

      public DeadLetterSchema.Builder sequenceNumberColumn(String sequenceNumberColumn)
      Sets the name of the sequenceNumber column. Defaults to sequenceNumber.
      Parameters:
      sequenceNumberColumn - The name for the sequenceNumber column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • tokenTypeColumn

      public DeadLetterSchema.Builder tokenTypeColumn(String tokenTypeColumn)
      Sets the name of the tokenType column. Defaults to tokenType.
      Parameters:
      tokenTypeColumn - The name for the tokenType column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • tokenColumn

      public DeadLetterSchema.Builder tokenColumn(String tokenColumn)
      Sets the name of the token column. Defaults to token.
      Parameters:
      tokenColumn - The name for the token column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • enqueuedAtColumn

      public DeadLetterSchema.Builder enqueuedAtColumn(String enqueuedAtColumn)
      Sets the name of the enqueuedAt column. Defaults to enqueuedAt.
      Parameters:
      enqueuedAtColumn - The name for the enqueuedAt column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • lastTouchedColumn

      public DeadLetterSchema.Builder lastTouchedColumn(String lastTouchedColumn)
      Sets the name of the lastTouched column. Defaults to lastTouched.
      Parameters:
      lastTouchedColumn - The name for the lastTouched column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • processingStartedColumn

      public DeadLetterSchema.Builder processingStartedColumn(String processingStartedColumn)
      Sets the name of the processingStarted column. Defaults to processingStarted.
      Parameters:
      processingStartedColumn - The name for the processingStarted column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • causeTypeColumn

      public DeadLetterSchema.Builder causeTypeColumn(String causeTypeColumn)
      Sets the name of the causeType column. Defaults to causeType.
      Parameters:
      causeTypeColumn - The name for the causeType column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • causeMessageColumn

      public DeadLetterSchema.Builder causeMessageColumn(String causeMessageColumn)
      Sets the name of the causeMessage column. Defaults to causeMessage.
      Parameters:
      causeMessageColumn - The name for the causeMessage column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • diagnosticsColumn

      public DeadLetterSchema.Builder diagnosticsColumn(String diagnosticsColumn)
      Sets the name of the diagnostics column. Defaults to diagnostics.
      Parameters:
      diagnosticsColumn - The name for the diagnostics column.
      Returns:
      The current Builder instance, for fluent interfacing.
    • build

      public DeadLetterSchema build()
      Initializes a DeadLetterSchema as specified through this Builder.
      Returns:
      A DeadLetterSchema as specified through this Builder.