io.dapr.actors.runtime.ActorRuntimeContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dapr-sdk-actors Show documentation
SDK for Actors on Dapr
There is a newer version: 1.13.0-rc-1
/*
 * Copyright 2021 The Dapr Authors
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
limitations under the License.
*/

package io.dapr.actors.runtime;

import io.dapr.actors.ActorTrace;
import io.dapr.serializer.DaprObjectSerializer;

/**
 * Provides the context for the Actor's runtime.
 *
 * @param  Actor's type for the context.
 */
public class ActorRuntimeContext {

  /**
   * Runtime.
   */
  private final ActorRuntime actorRuntime;

  /**
   * Serializer for transient objects.
   */
  private final DaprObjectSerializer objectSerializer;

  /**
   * Actor factory.
   */
  private final ActorFactory actorFactory;

  /**
   * Information of the Actor's type.
   */
  private final ActorTypeInformation actorTypeInformation;

  /**
   * Trace for Actor logs.
   */
  private final ActorTrace actorTrace;

  /**
   * Client to communicate to Dapr's API.
   */
  private final DaprClient daprClient;

  /**
   * State provider for given Actor Type.
   */
  private final DaprStateAsyncProvider stateProvider;

  /**
   * Instantiates a new runtime context for the Actor type.
   *
   * @param actorRuntime         Runtime.
   * @param objectSerializer     Serializer for transient objects.
   * @param actorFactory         Factory for Actors.
   * @param actorTypeInformation Information for Actor's type.
   * @param daprClient           Client to communicate to Dapr.
   * @param stateProvider        State provider for given Actor's type.
   */
  ActorRuntimeContext(ActorRuntime actorRuntime,
                      DaprObjectSerializer objectSerializer,
                      ActorFactory actorFactory,
                      ActorTypeInformation actorTypeInformation,
                      DaprClient daprClient,
                      DaprStateAsyncProvider stateProvider) {
    this.actorRuntime = actorRuntime;
    this.objectSerializer = objectSerializer;
    this.actorFactory = actorFactory;
    this.actorTypeInformation = actorTypeInformation;
    this.actorTrace = new ActorTrace();
    this.daprClient = daprClient;
    this.stateProvider = stateProvider;
  }

  /**
   * Gets the Actor's runtime.
   *
   * @return Actor's runtime.
   */
  ActorRuntime getActorRuntime() {
    return this.actorRuntime;
  }

  /**
   * Gets the Actor's serializer for transient objects.
   *
   * @return Actor's serializer for transient objects.
   */
  DaprObjectSerializer getObjectSerializer() {
    return this.objectSerializer;
  }

  /**
   * Gets the Actor's serializer.
   *
   * @return Actor's serializer.
   */
  ActorFactory getActorFactory() {
    return this.actorFactory;
  }

  /**
   * Gets the information about the Actor's type.
   *
   * @return Information about the Actor's type.
   */
  ActorTypeInformation getActorTypeInformation() {
    return this.actorTypeInformation;
  }

  /**
   * Gets the trace for Actor logs.
   *
   * @return Trace for Actor logs.
   */
  ActorTrace getActorTrace() {
    return this.actorTrace;
  }

  /**
   * Gets the client to communicate to Dapr's API.
   *
   * @return Client to communicate to Dapr's API.
   */
  DaprClient getDaprClient() {
    return this.daprClient;
  }

  /**
   * Gets the state provider for given Actor's type.
   *
   * @return State provider for given Actor's type.
   */
  DaprStateAsyncProvider getStateProvider() {
    return stateProvider;
  }
}