DeadLetterSchema (Axon Framework 4.12.1 API)

java.lang.Object
- org.axonframework.eventhandling.deadletter.jdbc.DeadLetterSchema

```
public class DeadLetterSchema
extends Object
```
Schema description for an EventMessage holding DeadLetter entry table in JDBC.

Since:

4.8.0

Author:

Steven van Beelen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeadLetterSchema.Builder
Instantiate a builder to construct a DeadLetterSchema.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeadLetterSchema.Builder` Instantiate a builder to construct a `DeadLetterSchema`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DeadLetterSchema(DeadLetterSchema.Builder builder)
Instantiate a DeadLetterSchema based on the given builder.

Constructors
Modifier	Constructor and Description
`protected`	`DeadLetterSchema(DeadLetterSchema.Builder builder)` Instantiate a `DeadLetterSchema` based on the given `builder`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`aggregateIdentifierColumn()` Returns the configured `aggregateIdentifier` column name.
`String`	`aggregateTypeColumn()` Returns the configured `aggregateType` column name.
`static DeadLetterSchema.Builder`	`builder()` Instantiate a builder to construct a `DeadLetterSchema`.
`String`	`causeMessageColumn()` Returns the configured `causeMessage` column name.
`String`	`causeTypeColumn()` Returns the configured `causeType` column name.
`String`	`deadLetterFields()` Return a comma separated list of dead letter column names to insert a dead letter into the `dead letter table`.
`String`	`deadLetterIdentifierColumn()` Returns the configured `deadLetterIdentifier` column name.
`String`	`deadLetterTable()` Returns the configured `deadLetter` table name.
`static DeadLetterSchema`	`defaultSchema()` Instantiate a default `DeadLetterSchema` using the pre-configured column names.
`String`	`diagnosticsColumn()` Returns the configured `diagnostics` column name.
`String`	`enqueuedAtColumn()` Returns the configured `enqueuedAt` column name.
`String`	`eventIdentifierColumn()` Returns the configured `eventIdentifier` column name.
`String`	`lastTouchedColumn()` Returns the configured `lastTouched` column name.
`String`	`messageTypeColumn()` Returns the configured `messageType` column name.
`String`	`metaDataColumn()` Returns the configured `metaData` column name.
`String`	`payloadColumn()` Returns the configured `payload` column name.
`String`	`payloadRevisionColumn()` Returns the configured `payloadRevision` column name.
`String`	`payloadTypeColumn()` Returns the configured `payloadType` column name.
`String`	`processingGroupColumn()` Returns the configured `processingGroup` column name.
`String`	`processingStartedColumn()` Returns the configured `processingStarted` column name.
`String`	`sequenceIdentifierColumn()` Returns the configured `sequenceIdentifier` column name.
`String`	`sequenceIndexColumn()` Returns the configured `sequenceIndex` column name.
`String`	`sequenceNumberColumn()` Returns the configured `sequenceNumber` column name.
`String`	`timestampColumn()` Returns the configured `timestamp` column name.
`String`	`tokenColumn()` Returns the configured `token` column name.
`String`	`tokenTypeColumn()` Returns the configured `tokenType` column name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DeadLetterSchema
```
protected DeadLetterSchema(DeadLetterSchema.Builder builder)
```
    Instantiate a DeadLetterSchema based on the given builder.
    
    Parameters:
    
    builder - The DeadLetterSchema.Builder used to instantiate a DeadLetterSchema instance.
- Method Detail
  - builder
```
public static DeadLetterSchema.Builder builder()
```
    Instantiate a builder to construct a DeadLetterSchema.
    All configurable columns default to their respective field name. Thus, the result of the diagnosticsColumn() defaults to diagnosticsColumn, etc.
    
    Returns:
    
    A Builder that can construct a DeadLetterSchema.
  - defaultSchema
```
public static DeadLetterSchema defaultSchema()
```
    Instantiate a default DeadLetterSchema using the pre-configured column names.
    
    Returns:
    
    A default DeadLetterSchema using the pre-configured column names
  - deadLetterTable
```
public String deadLetterTable()
```
    Returns the configured deadLetter table name.
    
    Returns:
    
    The configured deadLetter table name.
  - deadLetterIdentifierColumn
```
public String deadLetterIdentifierColumn()
```
    Returns the configured deadLetterIdentifier column name.
    
    Returns:
    
    The configured deadLetterIdentifier column name.
  - processingGroupColumn
```
public String processingGroupColumn()
```
    Returns the configured processingGroup column name.
    
    Returns:
    
    The configured processingGroup column name.
  - sequenceIdentifierColumn
```
public String sequenceIdentifierColumn()
```
    Returns the configured sequenceIdentifier column name.
    
    Returns:
    
    The configured sequenceIdentifier column name.
  - sequenceIndexColumn
```
public String sequenceIndexColumn()
```
    Returns the configured sequenceIndex column name.
    
    Returns:
    
    The configured sequenceIndex column name.
  - messageTypeColumn
```
public String messageTypeColumn()
```
    Returns the configured messageType column name.
    
    Returns:
    
    The configured messageType column name.
  - eventIdentifierColumn
```
public String eventIdentifierColumn()
```
    Returns the configured eventIdentifier column name.
    
    Returns:
    
    The configured eventIdentifier column name.
  - timestampColumn
```
public String timestampColumn()
```
    Returns the configured timestamp column name.
    
    Returns:
    
    The configured timestamp column name.
  - payloadTypeColumn
```
public String payloadTypeColumn()
```
    Returns the configured payloadType column name.
    
    Returns:
    
    The configured payloadType column name.
  - payloadRevisionColumn
```
public String payloadRevisionColumn()
```
    Returns the configured payloadRevision column name.
    
    Returns:
    
    The configured payloadRevision column name.
  - payloadColumn
```
public String payloadColumn()
```
    Returns the configured payload column name.
    
    Returns:
    
    The configured payload column name.
  - metaDataColumn
```
public String metaDataColumn()
```
    Returns the configured metaData column name.
    
    Returns:
    
    The configured metaData column name.
  - aggregateTypeColumn
```
public String aggregateTypeColumn()
```
    Returns the configured aggregateType column name.
    
    Returns:
    
    The configured aggregateType column name.
  - aggregateIdentifierColumn
```
public String aggregateIdentifierColumn()
```
    Returns the configured aggregateIdentifier column name.
    
    Returns:
    
    The configured aggregateIdentifier column name.
  - sequenceNumberColumn
```
public String sequenceNumberColumn()
```
    Returns the configured sequenceNumber column name.
    
    Returns:
    
    The configured sequenceNumber column name.
  - tokenTypeColumn
```
public String tokenTypeColumn()
```
    Returns the configured tokenType column name.
    
    Returns:
    
    The configured tokenType column name.
  - tokenColumn
```
public String tokenColumn()
```
    Returns the configured token column name.
    
    Returns:
    
    The configured token column name.
  - enqueuedAtColumn
```
public String enqueuedAtColumn()
```
    Returns the configured enqueuedAt column name.
    
    Returns:
    
    The configured enqueuedAt column name.
  - lastTouchedColumn
```
public String lastTouchedColumn()
```
    Returns the configured lastTouched column name.
    
    Returns:
    
    The configured lastTouched column name.
  - processingStartedColumn
```
public String processingStartedColumn()
```
    Returns the configured processingStarted column name.
    
    Returns:
    
    The configured processingStarted column name.
  - causeTypeColumn
```
public String causeTypeColumn()
```
    Returns the configured causeType column name.
    
    Returns:
    
    The configured causeType column name.
  - causeMessageColumn
```
public String causeMessageColumn()
```
    Returns the configured causeMessage column name.
    
    Returns:
    
    The configured causeMessage column name.
  - diagnosticsColumn
```
public String diagnosticsColumn()
```
    Returns the configured diagnostics column name.
    
    Returns:
    
    The configured diagnostics column name.
  - deadLetterFields
```
public String deadLetterFields()
```
    Return a comma separated list of dead letter column names to insert a dead letter into the dead letter table.
    
    Returns:
    
    A comma separated list of dead letter column names.

Class DeadLetterSchema

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeadLetterSchema

Method Detail

builder

defaultSchema

deadLetterTable

deadLetterIdentifierColumn

processingGroupColumn

sequenceIdentifierColumn

sequenceIndexColumn

messageTypeColumn

eventIdentifierColumn

timestampColumn

payloadTypeColumn

payloadRevisionColumn

payloadColumn

metaDataColumn

aggregateTypeColumn

aggregateIdentifierColumn

sequenceNumberColumn

tokenTypeColumn

tokenColumn

enqueuedAtColumn

lastTouchedColumn

processingStartedColumn

causeTypeColumn

causeMessageColumn

diagnosticsColumn

deadLetterFields