io.spine.server.event

Class EventFactory

java.lang.Object

io.spine.server.event.EventFactory

public class EventFactory
extends java.lang.Object

Produces events.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventFactory(EventOrigin origin, com.google.protobuf.Any producerId)

Method Summary

Modifier and Type	Method and Description
io.spine.core.Event	createEvent(io.spine.base.EventMessage message, @Nullable io.spine.core.Version version) Creates an event for the passed event message.
io.spine.core.Event	createRejectionEvent(io.spine.base.RejectionMessage message, @Nullable io.spine.core.Version version, io.spine.core.RejectionEventContext rejectionContext) Creates a rejection event for the passed rejection message.
static EventFactory	forImport(io.spine.core.ActorContext actorContext, com.google.protobuf.Any producerId) Creates a new event factory for producing events to be imported into a Bounded Context.
static EventFactory	on(MessageEnvelope origin, com.google.protobuf.Any producerId) Creates a new event factory for producing events in response to the passed message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventFactory

protected EventFactory(EventOrigin origin,
                       com.google.protobuf.Any producerId)

Method Detail

on

public static EventFactory on(MessageEnvelope origin,
                              com.google.protobuf.Any producerId)

Creates a new event factory for producing events in response to the passed message.

Parameters:

origin - the message in response to which events will be generated

producerId - the ID of the entity producing the events

Returns:

new event factory

forImport

public static EventFactory forImport(io.spine.core.ActorContext actorContext,
                                     com.google.protobuf.Any producerId)

Creates a new event factory for producing events to be imported into a Bounded Context.

Parameters:

actorContext - the description of the actor who imports the events

producerId - the ID of the system which produced the events

Returns:

new event factory

createEvent

public io.spine.core.Event createEvent(io.spine.base.EventMessage message,
                                       @Nullable io.spine.core.Version version)
                                throws io.spine.validate.ValidationException

Creates an event for the passed event message.

The message passed is validated according to the constraints set in its Protobuf definition. If the message is invalid, an exception is thrown.

In the message is an instance of Any, it is unpacked for validation.

Parameters:

message - the message of the event

version - the version of the entity which produces the event

Throws:

io.spine.validate.ValidationException - if the passed message does not satisfy the constraints set for it in its Protobuf definition

createRejectionEvent

public io.spine.core.Event createRejectionEvent(io.spine.base.RejectionMessage message,
                                                @Nullable io.spine.core.Version version,
                                                io.spine.core.RejectionEventContext rejectionContext)
                                         throws io.spine.validate.ValidationException

Creates a rejection event for the passed rejection message.

Parameters:

message - the rejection message

version - the version of the event to create

rejectionContext - the rejection context

Returns:

new rejection event

Throws:

io.spine.validate.ValidationException - if the passed message does not satisfy the constraints set for it in its Protobuf definition

See Also:

createEvent(Message, Version) - for general rules of the event construction