BoundedContextBuilder (server 1.8.2 API)

java.lang.Object
- io.spine.server.BoundedContextBuilder

All Implemented Interfaces:: io.spine.logging.Logging

public final class BoundedContextBuilder
extends java.lang.Object
implements io.spine.logging.Logging

A builder for producing BoundedContext instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<I,E extends Entity<I,?>> BoundedContextBuilder`	`add(java.lang.Class<E> entityClass)` Adds the default repository for the passed entity class to the repository registration list.
`BoundedContextBuilder`	`add(Repository<?,?> repository)` Adds the passed repository to the registration list which will be processed after the Bounded Context is created.
`BoundedContextBuilder`	`addCommandDispatcher(CommandDispatcher commandDispatcher)` Adds the passed command dispatcher to the dispatcher registration list which will be processed after the Bounded Context is created.
`BoundedContextBuilder`	`addCommandFilter(BusFilter<CommandEnvelope> filter)` Adds a filter for commands.
`BoundedContextBuilder`	`addCommandListener(Listener<CommandEnvelope> listener)` Adds a listener for commands posted to the `CommandBus` of the context being built.
`BoundedContextBuilder`	`addEventDispatcher(EventDispatcher eventDispatcher)` Adds the passed event dispatcher to the dispatcher registration list which will be processed after the Bounded Context is created.
`BoundedContextBuilder`	`addEventFilter(BusFilter<EventEnvelope> filter)` Adds a filter for events.
`BoundedContextBuilder`	`addEventListener(Listener<EventEnvelope> listener)` Adds a listener of the events posted to the `EventBus` of the context being built.
`BoundedContext`	`build()` Creates a new instance of `BoundedContext` with the set configurations.
`com.google.common.collect.ImmutableList<CommandDispatcher>`	`commandDispatchers()` Obtains the list of command dispatchers added to the builder by the time of the call.
`BoundedContextBuilder`	`enrichEventsUsing(EventEnricher enricher)` Sets a custom `Enricher` for events posted to the `EventBus` of the context being built.
`com.google.common.collect.ImmutableList<EventDispatcher>`	`eventDispatchers()` Obtains the list of event dispatchers added to the builder by the time of the call.
`java.util.Optional<EventEnricher>`	`eventEnricher()` Obtains `EventEnricher` assigned to the context to be built, or empty `Optional` if no enricher was assigned prior to this call.
`boolean`	`isMultitenant()`
`io.spine.core.BoundedContextName`	`name()` Returns the name of the resulting context.
`<I,E extends Entity<I,?>> BoundedContextBuilder`	`remove(java.lang.Class<E> entityClass)` Removes the repository from the registration list by the passed entity class.
`BoundedContextBuilder`	`remove(Repository<?,?> repository)` Removes the passed repository from the registration list.
`BoundedContextBuilder`	`removeCommandDispatcher(CommandDispatcher commandDispatcher)` Removes the passed command dispatcher from the corresponding registration list.
`BoundedContextBuilder`	`removeEventDispatcher(EventDispatcher eventDispatcher)` Removes the passed event dispatcher from the corresponding registration list.
`com.google.common.collect.ImmutableList<Repository<?,?>>`	`repositories()` Obtains the list of repositories added to the builder by the time of the call.
`BoundedContextBuilder`	`setAggregateRootDirectory(java.util.function.Supplier<AggregateRootDirectory> directory)` Sets the supplier of `AggregateRootDirectory`-s to use in the built context.
`BoundedContextBuilder`	`setTenantIndex(TenantIndex tenantIndex)`
`ContextSpec`	`spec()` Obtains the context spec.
`SystemSettings`	`systemSettings()` Obtains the configuration of the System context.
`java.util.Optional<? extends TenantIndex>`	`tenantIndex()` Obtains `TenantIndex` implementation associated with the Bounded Context.

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

Methods inherited from interface io.spine.logging.Logging
_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

- Method Detail
  - spec
```
public ContextSpec spec()
```
    Obtains the context spec.
  - name
```
public io.spine.core.BoundedContextName name()
```
    Returns the name of the resulting context.
  - isMultitenant
```
public boolean isMultitenant()
```
  - tenantIndex
```
public java.util.Optional<? extends TenantIndex> tenantIndex()
```
    Obtains TenantIndex implementation associated with the Bounded Context.
  - enrichEventsUsing
```
@CanIgnoreReturnValue
public BoundedContextBuilder enrichEventsUsing(EventEnricher enricher)
```
    Sets a custom Enricher for events posted to the EventBus of the context being built.
    If the Enricher is not set, the enrichments will NOT be supported in this context.
    
    Parameters:
    
    enricher - the Enricher for events or null if enrichment is not supported
  - eventEnricher
```
public java.util.Optional<EventEnricher> eventEnricher()
```
    Obtains EventEnricher assigned to the context to be built, or empty Optional if no enricher was assigned prior to this call.
  - setTenantIndex
```
@CanIgnoreReturnValue
public BoundedContextBuilder setTenantIndex(TenantIndex tenantIndex)
```
  - addCommandDispatcher
```
@CanIgnoreReturnValue
public BoundedContextBuilder addCommandDispatcher(CommandDispatcher commandDispatcher)
```
    Adds the passed command dispatcher to the dispatcher registration list which will be processed after the Bounded Context is created.
    
    API Note:
    
    This method is also capable of registering repositories that implement CommandDispatcher, but the BoundedContextBuilder.add(Repository) method should be preferred for this purpose.
  - addCommandFilter
```
@CanIgnoreReturnValue
public BoundedContextBuilder addCommandFilter(BusFilter<CommandEnvelope> filter)
```
    Adds a filter for commands.
    The order of appending the filters to the builder is the order of the filters in the CommandBus.
  - addCommandListener
```
public BoundedContextBuilder addCommandListener(Listener<CommandEnvelope> listener)
```
    Adds a listener for commands posted to the CommandBus of the context being built.
  - addEventDispatcher
```
@CanIgnoreReturnValue
public BoundedContextBuilder addEventDispatcher(EventDispatcher eventDispatcher)
```
    Adds the passed event dispatcher to the dispatcher registration list which will be processed after the Bounded Context is created.
    
    API Note:
    
    This method is also capable of registering repositories that implement EventDispatcher, but the BoundedContextBuilder.add(Repository) method should be preferred for this purpose.
  - addEventFilter
```
@CanIgnoreReturnValue
public BoundedContextBuilder addEventFilter(BusFilter<EventEnvelope> filter)
```
    Adds a filter for events.
    The order of appending the filters to the builder is the order of the filters in the EventBus.
    
    Parameters:
    
    filter - the filter to add
  - addEventListener
```
public BoundedContextBuilder addEventListener(Listener<EventEnvelope> listener)
```
    Adds a listener of the events posted to the EventBus of the context being built.
  - add
```
@CanIgnoreReturnValue
public <I,E extends Entity<I,?>> BoundedContextBuilder add(java.lang.Class<E> entityClass)
```
    Adds the default repository for the passed entity class to the repository registration list.
  - add
```
@CanIgnoreReturnValue
public BoundedContextBuilder add(Repository<?,?> repository)
```
    Adds the passed repository to the registration list which will be processed after the Bounded Context is created.
  - removeCommandDispatcher
```
@CanIgnoreReturnValue
public BoundedContextBuilder removeCommandDispatcher(CommandDispatcher commandDispatcher)
```
    Removes the passed command dispatcher from the corresponding registration list.
  - removeEventDispatcher
```
@CanIgnoreReturnValue
public BoundedContextBuilder removeEventDispatcher(EventDispatcher eventDispatcher)
```
    Removes the passed event dispatcher from the corresponding registration list.
  - remove
```
@CanIgnoreReturnValue
public <I,E extends Entity<I,?>> BoundedContextBuilder remove(java.lang.Class<E> entityClass)
```
    Removes the repository from the registration list by the passed entity class.
  - remove
```
@CanIgnoreReturnValue
public BoundedContextBuilder remove(Repository<?,?> repository)
```
    Removes the passed repository from the registration list.
  - repositories
```
public com.google.common.collect.ImmutableList<Repository<?,?>> repositories()
```
    Obtains the list of repositories added to the builder by the time of the call.
    Adding repositories to the builder after this method returns will not update the returned list.
  - commandDispatchers
```
public com.google.common.collect.ImmutableList<CommandDispatcher> commandDispatchers()
```
    Obtains the list of command dispatchers added to the builder by the time of the call.
    Adding dispatchers to the builder after this method returns will not update the returned list.
  - eventDispatchers
```
public com.google.common.collect.ImmutableList<EventDispatcher> eventDispatchers()
```
    Obtains the list of event dispatchers added to the builder by the time of the call.
    Adding dispatchers to the builder after this method returns will not update the returned list.
  - setAggregateRootDirectory
```
@CanIgnoreReturnValue
public BoundedContextBuilder setAggregateRootDirectory(java.util.function.Supplier<AggregateRootDirectory> directory)
```
    Sets the supplier of AggregateRootDirectory-s to use in the built context.
    By default, an in-mem implementation is used.
    
    Parameters:
    
    directory - the supplier of aggregate root directories
  - systemSettings
```
public SystemSettings systemSettings()
```
    Obtains the configuration of the System context.
    With it, users are able to change the behavior of the system context.
  - build
```
public BoundedContext build()
```
    Creates a new instance of BoundedContext with the set configurations.
    The resulting domain-specific Bounded Context has as internal System Bounded Context. The entities of the System domain describe the entities of the resulting Bounded Context.
    The System Bounded Context shares some configuration with the Domain Bounded Context, such as:
    - BoundedContextBuilder.tenantIndex() tenancy;
    - ServerEnvironment.transportFactory() transport facilities.
    All the other configuration is NOT shared.
    The name of the System Bounded Context is derived from the name of the Domain Bounded Context.
    Returns:
    
    new BoundedContext

Class BoundedContextBuilder

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.spine.logging.Logging

Method Detail

spec

name

isMultitenant

tenantIndex

enrichEventsUsing

eventEnricher

setTenantIndex

addCommandDispatcher

addCommandFilter

addCommandListener

addEventDispatcher

addEventFilter

addEventListener

add

add

removeCommandDispatcher

removeEventDispatcher

remove

remove

repositories

commandDispatchers

eventDispatchers

setAggregateRootDirectory

systemSettings

build