client/io.spine.client/ActorRequestFactory

ActorRequestFactory

public class ActorRequestFactory

A factory for various requests fired from the client-side by an actor.

Constructors

ActorRequestFactory

protected void ActorRequestFactory(ActorRequestFactory.Builder builder)

Types

Builder

public class Builder

A builder for ActorRequestFactory.

Functions

actor

public UserId actor()

Obtains the ID of the user on behalf of whom the requests are created.

command

public CommandFactory command()

Creates an instance of CommandFactory based on configuration of this ActorRequestFactory instance.

createCommandContext

protected CommandContext createCommandContext()

Creates new CommandContext.

fromContext

public static ActorRequestFactory fromContext(ActorContext actorContext)

Creates an instance by the passed ActorContext.

newActorContext

public final ActorContext newActorContext()

Creates an actor context based on the factory properties.

newBuilder

public static ActorRequestFactory.Builder newBuilder()

Creates a builder for a new request factory.

query

public QueryFactory query()

Creates an instance of QueryFactory based on configuration of this ActorRequestFactory instance.

switchTimeZone

public ActorRequestFactory switchTimeZone(ZoneId zoneId)

Creates a copy of this factory placed at a new time zone with the passed ID.

public ActorRequestFactory switchTimeZone(ZoneOffset zoneOffset, ZoneId zoneId)

Creates a copy of this factory placed at a new time zone with the passed offset and ID.

tenantId

public TenantId tenantId()

Obtains the ID of the tenant to which the actor belongs or null for single-tenant execution context.

topic

public TopicFactory topic()

Creates an instance of TopicFactory based on configuration of this ActorRequestFactory instance.

zoneId

public ZoneId zoneId()

Obtains the ID of the time zone in which the actor works.

zoneOffset

public ZoneOffset zoneOffset()

Obtains the offset of the time zone in which the actor works.