io.spine.client

Class ActorRequestFactory

java.lang.Object

io.spine.client.ActorRequestFactory

public class ActorRequestFactory
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActorRequestFactory.Builder A builder for ActorRequestFactory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActorRequestFactory(ActorRequestFactory.Builder builder)

Method Summary

Modifier and Type	Method and Description
io.spine.core.UserId	actor() Obtains the ID of the user on behalf of whom the requests are created.
CommandFactory	command() Creates an instance of CommandFactory based on configuration of this ActorRequestFactory instance.
protected io.spine.core.CommandContext	createCommandContext() Creates new CommandContext.
static ActorRequestFactory	fromContext(io.spine.core.ActorContext actorContext) Creates an instance by the passed ActorContext.
static ActorRequestFactory.Builder	newBuilder() Creates a builder for a new request factory.
QueryFactory	query() Creates an instance of QueryFactory based on configuration of this ActorRequestFactory instance.
ActorRequestFactory	switchTimeZone(io.spine.time.ZoneId zoneId) Creates a copy of this factory placed at a new time zone with the passed ID.
ActorRequestFactory	switchTimeZone(io.spine.time.ZoneOffset zoneOffset, io.spine.time.ZoneId zoneId) Creates a copy of this factory placed at a new time zone with the passed offset and ID.
@Nullable io.spine.core.TenantId	tenantId() Obtains the ID of the tenant to which the actor belongs or null for single-tenant execution context.
TopicFactory	topic() Creates an instance of TopicFactory based on configuration of this ActorRequestFactory instance.
io.spine.time.ZoneId	zoneId() Obtains the ID of the time zone in which the actor works.
io.spine.time.ZoneOffset	zoneOffset() Obtains the offset of the time zone in which the actor works.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorRequestFactory

protected ActorRequestFactory(ActorRequestFactory.Builder builder)

Method Detail

newBuilder

public static ActorRequestFactory.Builder newBuilder()

Creates a builder for a new request factory.

fromContext

public static ActorRequestFactory fromContext(io.spine.core.ActorContext actorContext)

Creates an instance by the passed ActorContext.

actor

public io.spine.core.UserId actor()

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

zoneOffset

public io.spine.time.ZoneOffset zoneOffset()

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

zoneId

public io.spine.time.ZoneId zoneId()

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

tenantId

public @Nullable io.spine.core.TenantId tenantId()

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

switchTimeZone

public ActorRequestFactory switchTimeZone(io.spine.time.ZoneOffset zoneOffset,
                                          io.spine.time.ZoneId zoneId)

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

Use this method for obtaining new request factory as the user moves to a new location.

Parameters:

zoneOffset - the offset of the new time zone

zoneId - the ID of the new time zone

Returns:

new factory at the new time zone

switchTimeZone

public ActorRequestFactory switchTimeZone(io.spine.time.ZoneId zoneId)

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

The zone offset is calculated using the current time.

Parameters:

zoneId - the ID of the new time zone

Returns:

new factory at the new time zone

query

public QueryFactory query()

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

Returns:

an instance of QueryFactory

topic

public TopicFactory topic()

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

Returns:

an instance of TopicFactory

command

public CommandFactory command()

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

Returns:

an instance of CommandFactory

createCommandContext

protected io.spine.core.CommandContext createCommandContext()

Creates new CommandContext.

See Also:

CommandFactory.createContext()