package lagompb
- Alphabetic
- By Inheritance
- lagompb
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract class AggregateRoot[S <: GeneratedMessage] extends AnyRef
LagompbAggregate abstract class encapsulate all the necessary setup required to create an aggregate in the lagom ecosystem.
LagompbAggregate abstract class encapsulate all the necessary setup required to create an aggregate in the lagom ecosystem. There are three main components an aggregate requires to be functional: a commands handler, an events handler and a state.
- S
the scala type of the aggregate state
- case class ApiSerializer[A <: GeneratedMessage]()(implicit evidence$1: GeneratedMessageCompanion[A]) extends StrictMessageSerializer[A] with GenericSerializers[A] with Product with Serializable
ApiSerializer helps serialize json REST payload into protobuf messages and vice versa.
- abstract class BaseApplication extends LagomApplication with PostgresPersistenceComponents with BaseApplicationComponents
LagompbApplication an abstract class that will be implemented to define the lagom application that needs akka persistence for journal and snapshot
- sealed trait BaseApplicationComponents extends AhcWSComponents with CORSComponents with AllowedHostsComponents with CSRFComponents with SecurityHeadersComponents
- trait BaseGrpcServiceImpl extends SharedBaseServiceImpl
BaseGrpcServiceImpl
- trait BaseService extends Service
Must be implemented by any lagom api without message broker integration
- abstract class BaseServiceImpl extends BaseService with SharedBaseServiceImpl
BaseServiceImpl abstract class.
BaseServiceImpl abstract class.
It must be implemented by any lagom REST based service
- abstract class BaseStatelessApplication extends LagomApplication with BaseApplicationComponents
LagompbStatelessApplication an abstract class that will be implemented to define the lagom application that does not need akka persistence.
LagompbStatelessApplication an abstract class that will be implemented to define the lagom application that does not need akka persistence. Therefore no events and state are persisted
- final case class Command(command: Any, replyTo: ActorRef[CommandReply], data: Map[String, String]) extends Product with Serializable
Defines the type of command to handle by the aggregate.
Defines the type of command to handle by the aggregate.
LagomPbCommand
is a wrapper around the actual command sent to aggregate.- command
the actual command. This is a protocol buffer message
- replyTo
the actor reference of the sender of the command.
- data
additional data that will be added to the state. This may be deprecated when the plugin architecture is in placed The CommandReply message type will be sent back that actor reference
- trait CommandHandler extends AnyRef
CommandHandler is a generic command handler
- sealed class CommandSerializer extends SerializerWithStringManifest
LagomPbCommandSerializer It is used internally by lagom-common to serialize commands and replies
- trait EventHandler extends AnyRef
EventHandler is a generic event handler
- final case class EventsConfig(tagName: String, numShards: Int) extends Product with Serializable
- sealed trait GenericSerializers[T <: GeneratedMessage] extends AnyRef
- final class GlobalException extends RuntimeException
GlobalException custom RuntimeException.
GlobalException custom RuntimeException. This is used for general exception
- implicit class Instants extends AnyRef
- final class InternalServerError extends TransportException
It used to return an HTTP 500 response
- final class InvalidCommandException extends RuntimeException
InvalidCommandException.
InvalidCommandException. This will be used to handle invalid command exception.
- sealed trait PostgresPersistenceComponents extends JdbcPersistenceComponents with SlickPersistenceComponents with HikariCPComponents with LagomKafkaComponents
- trait SendCommand extends AnyRef
- trait SharedBaseServiceImpl extends SendCommand
- final case class SnapshotCriteria(frequency: Int, retention: Int) extends Product with Serializable
- implicit class Timestamps extends AnyRef
- abstract class TypedCommandHandler[S <: GeneratedMessage] extends CommandHandler
TypedCommandHandler is a typed command handler.
TypedCommandHandler is a typed command handler. It makes use the protos registry to properly unpack the actual user command and state into a scalapb.GeneratedMessage that can be easily pattern match
- S
the aggregate state type
- abstract class TypedEventHandler[S <: GeneratedMessage] extends EventHandler
TypedEventHandler is a typed event handler.
TypedEventHandler is a typed event handler. It makes use the protos registry to properly unpack the actual user event and state into a scalapb.GeneratedMessage that can be easily pattern match
- S
the aggregate state type
Value Members
- object ConfigReader
- object InternalServerError extends Serializable
- object ProtosRegistry
Helpful registry of scalapb protobuf classes that can be used to find companion objects, do JSON serialization, and unpack "Any" messages