BoundedContext (server 1.8.2 API)

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

All Implemented Interfaces:

io.spine.logging.Logging, Closeable, java.lang.AutoCloseable
```
public abstract class BoundedContext
extends java.lang.Object
implements Closeable, io.spine.logging.Logging
```
A logical and structural boundary of a model.
Logically, a Bounded Context represents a sub-system built to be described with the same Ubiquitous Language. Any term within a single bounded context has a single meaning and may or may not map to another term in the language of another Bounded Context.
The Ubiquitous Language of a Bounded Context is represented by such concepts as the entity state, event, and command types, entity types, and others. An entity and its adjacent types belong to the Bounded Context which the entity Repository is registered in.
Structurally, a Bounded Context brings together all the infrastructure required for the components of a model to cooperate.
An instance of BoundedContext acts as a major point of configuration for all the model elements which belong to it.

See Also:

Martin Fowler on Bounded Contexts

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the `BoundedContext` performing all necessary clean-ups.
`CommandBus`	`commandBus()` Obtains instance of `CommandBus` of this `BoundedContext`.
`EventBus`	`eventBus()` Obtains instance of `EventBus` of this `BoundedContext`.
`boolean`	`hasEntitiesOfType(java.lang.Class<? extends Entity<?,?>> entityClass)` Verifies if this Bounded Context contains entities of the passed class.
`boolean`	`hasEntitiesWithState(java.lang.Class<? extends io.spine.base.EntityState> stateClass)` Verifies if this Bounded Context has entities with the state of the passed class.
`ImportBus`	`importBus()` Obtains instance of `ImportBus` of this `BoundedContext`.
`protected void`	`init()` Performs post-creation initialization of the instance.
`boolean`	`isMultitenant()` Returns `true` if the Bounded Context is designed to serve more than one tenant of the application, `false` otherwise.
`boolean`	`isOpen()` Tells if the object is still open.
`static BoundedContextBuilder`	`multitenant(java.lang.String name)` Creates a new builder for a multitenant `BoundedContext`.
`io.spine.core.BoundedContextName`	`name()` Obtains an ID of the Bounded Context.
`protected void`	`register(Repository<?,?> repository)` Adds the passed repository to the context.
`protected void`	`registerCommandDispatcher(CommandDispatcher dispatcher)` Registers the passed command dispatcher with the `CommandBus`.
`protected void`	`registerEventDispatcher(EventDispatcher dispatcher)` Registering the passed event dispatcher with the buses of this context.
`static BoundedContextBuilder`	`singleTenant(java.lang.String name)` Creates a new builder for a single tenant `BoundedContext`.
`ContextSpec`	`spec()` Obtains specification of this context.
`Stand`	`stand()` Obtains instance of `Stand` of this `BoundedContext`.
`java.util.Set<io.spine.type.TypeName>`	`stateTypes()` Obtains the set of all entity type names.
`java.util.Set<io.spine.type.TypeName>`	`stateTypes(io.spine.option.EntityOption.Visibility visibility)` Obtains a set of entity type names by their visibility.
`java.lang.String`	`toString()` Returns the name of this Bounded Context.

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

Methods inherited from interface io.spine.server.Closeable
checkOpen

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

- Method Detail
  - init
```
protected final void init()
```
    Performs post-creation initialization of the instance.
    This method must be called shortly after the constructor so that the instance can perform dependency injections steps that cannot be performed in the constructor.
  - singleTenant
```
public static BoundedContextBuilder singleTenant(java.lang.String name)
```
    Creates a new builder for a single tenant BoundedContext.
    
    Parameters:
    
    name - the name of the built context
    
    Returns:
    
    new builder instance
  - multitenant
```
public static BoundedContextBuilder multitenant(java.lang.String name)
```
    Creates a new builder for a multitenant BoundedContext.
    
    Parameters:
    
    name - the name of the built context
    
    Returns:
    
    new builder instance
  - register
```
protected final void register(Repository<?,?> repository)
```
    Adds the passed repository to the context.
  - registerCommandDispatcher
```
protected void registerCommandDispatcher(CommandDispatcher dispatcher)
```
    Registers the passed command dispatcher with the CommandBus.
    
    See Also:
    
    BoundedContext.registerCommandDispatcher(CommandDispatcherDelegate)
  - registerEventDispatcher
```
protected void registerEventDispatcher(EventDispatcher dispatcher)
```
    Registering the passed event dispatcher with the buses of this context.
    If the passed instance dispatches domestic events, registers it with the EventBus. If the passed instance dispatches external events, registers it with the IntegrationBroker.
    
    See Also:
    
    BoundedContext.registerEventDispatcher(EventDispatcherDelegate)
  - stateTypes
```
public java.util.Set<io.spine.type.TypeName> stateTypes(io.spine.option.EntityOption.Visibility visibility)
```
    Obtains a set of entity type names by their visibility.
  - stateTypes
```
public java.util.Set<io.spine.type.TypeName> stateTypes()
```
    Obtains the set of all entity type names.
  - hasEntitiesOfType
```
public boolean hasEntitiesOfType(java.lang.Class<? extends Entity<?,?>> entityClass)
```
    Verifies if this Bounded Context contains entities of the passed class.
    This method does not take into account visibility of entity states.
  - hasEntitiesWithState
```
public boolean hasEntitiesWithState(java.lang.Class<? extends io.spine.base.EntityState> stateClass)
```
    Verifies if this Bounded Context has entities with the state of the passed class.
    This method does not take into account visibility of entity states.
  - commandBus
```
public CommandBus commandBus()
```
    Obtains instance of CommandBus of this BoundedContext.
  - eventBus
```
public EventBus eventBus()
```
    Obtains instance of EventBus of this BoundedContext.
  - importBus
```
public ImportBus importBus()
```
    Obtains instance of ImportBus of this BoundedContext.
  - stand
```
public Stand stand()
```
    Obtains instance of Stand of this BoundedContext.
  - name
```
public io.spine.core.BoundedContextName name()
```
    Obtains an ID of the Bounded Context.
    The ID allows to identify a Bounded Context if a multi-context application. If the ID was not defined during the building process, the Bounded Context gets BoundedContextNames.assumingTests() name.
    
    Returns:
    
    the ID of this BoundedContext
  - spec
```
public ContextSpec spec()
```
    Obtains specification of this context.
  - isMultitenant
```
public boolean isMultitenant()
```
    Returns true if the Bounded Context is designed to serve more than one tenant of the application, false otherwise.
  - close
```
public void close()
           throws java.lang.Exception
```
    Closes the BoundedContext performing all necessary clean-ups.
    This method performs the following:
    1. Closes associated StorageFactory.
    2. Closes CommandBus.
    3. Closes EventBus.
    4. Closes IntegrationBroker.
    5. Closes EventStore.
    6. Closes Stand.
    7. Closes ImportBus.
    8. Closes TracerFactory if it is present.
    9. Closes all registered repositories.
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception - caused by closing one of the components
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Closeable
    
    Tells if the object is still open.
    Implementations must return false after AutoCloseable.close() is invoked.
    
    Specified by:
    
    isOpen in interface Closeable
  - toString
```
public java.lang.String toString()
```
    Returns the name of this Bounded Context.
    
    Overrides:
    
    toString in class java.lang.Object

Class BoundedContext

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.spine.server.Closeable

Methods inherited from interface io.spine.logging.Logging

Method Detail

init

singleTenant

multitenant

register

registerCommandDispatcher

registerEventDispatcher

stateTypes

stateTypes

hasEntitiesOfType

hasEntitiesWithState

commandBus

eventBus

importBus

stand

name

spec

isMultitenant

close

isOpen

toString