Skip to content

Commit

Permalink
reduce visibility of fields in DittoService to private where possible
Browse files Browse the repository at this point in the history
Signed-off-by: Yannic Klem <yannic.klem@bosch.io>
  • Loading branch information
Yannic92 committed Jul 20, 2022
1 parent 034ff5f commit 65e4e90
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 33 deletions.
Expand Up @@ -98,11 +98,11 @@ public abstract class DittoService<C extends ServiceSpecificConfig> {

protected static final String MONGO_URI_CONFIG_PATH = "akka.contrib.persistence.mongodb.mongo.mongouri";

protected final Config rawConfig;
protected final C serviceSpecificConfig;
private final Logger logger;
private final String serviceName;
private final String rootActorName;
private final Config rawConfig;
private final C serviceSpecificConfig;

@Nullable
private PrometheusReporter prometheusReporter;
Expand All @@ -129,12 +129,21 @@ protected DittoService(final Logger logger, final String serviceName, final Stri
logger.debug("Using service specific config: <{}>.", serviceSpecificConfig);
}

/**
* Starts this service. Any thrown {@code Throwable}s will be logged and re-thrown.
*
* @return the created ActorSystem during startup
*/
public ActorSystem start() {
return MainMethodExceptionHandler.getInstance(logger).call(this::doStart);
}

/**
* Determines the {@link com.typesafe.config.Config} of this service. May be overridden to change the way how the config is determined.
*
* @return the config of this service.
*/
protected Config determineRawConfig() {
private Config determineRawConfig() {
final var loadedConfig = RawConfigSupplier.of(serviceName).get();

if (logger.isDebugEnabled()) {
Expand Down Expand Up @@ -188,15 +197,6 @@ private static ScopedConfig getDittoConfigOrEmpty(final Config rawConfig) {
*/
protected abstract C getServiceSpecificConfig(ScopedConfig dittoConfig);

/**
* Starts this service. Any thrown {@code Throwable}s will be logged and re-thrown.
*
* @return the created ActorSystem during startup
*/
public ActorSystem start() {
return MainMethodExceptionHandler.getInstance(logger).call(this::doStart);
}

/**
* Starts this service.
* <p>
Expand All @@ -206,19 +206,17 @@ public ActorSystem start() {
*
* @return the created ActorSystem during startup
*/
protected ActorSystem doStart() {
private ActorSystem doStart() {
logRuntimeParameters();
final var actorSystemConfig =
appendDittoInfo(appendAkkaPersistenceMongoUriToRawConfig(rawConfig, serviceSpecificConfig));
final var actorSystemConfig = appendDittoInfo(appendAkkaPersistenceMongoUriToRawConfig());
startKamon();
final var actorSystem = createActorSystem(actorSystemConfig);
initializeActorSystem(actorSystem);
startKamonPrometheusHttpEndpoint(actorSystem);
return actorSystem;
}

@SuppressWarnings("unused")
protected Config appendAkkaPersistenceMongoUriToRawConfig(final Config rawConfig, final C serviceSpecificConfig) {
protected Config appendAkkaPersistenceMongoUriToRawConfig() {
return rawConfig;
}

Expand Down Expand Up @@ -272,7 +270,7 @@ private void startPrometheusReporter() {
*
* @param actorSystem the Akka ActorSystem to be initialized.
*/
protected void initializeActorSystem(final ActorSystem actorSystem) {
private void initializeActorSystem(final ActorSystem actorSystem) {
startAkkaManagement(actorSystem);
startClusterBootstrap(actorSystem);

Expand Down Expand Up @@ -318,7 +316,7 @@ private void startKamonPrometheusHttpEndpoint(final ActorSystem actorSystem) {
* @param config the configuration settings of this service.
* @return the actor system.
*/
protected ActorSystem createActorSystem(final Config config) {
private ActorSystem createActorSystem(final Config config) {
return ActorSystem.create(CLUSTER_NAME, config);
}

Expand Down Expand Up @@ -347,7 +345,7 @@ private void startClusterBootstrap(final ActorSystem actorSystem) {
*
* @param actorSystem Akka actor system for starting actors.
*/
protected void startStatusSupplierActor(final ActorSystem actorSystem) {
private void startStatusSupplierActor(final ActorSystem actorSystem) {
startActor(actorSystem, StatusSupplierActor.props(rootActorName), StatusSupplierActor.ACTOR_NAME);
}

Expand All @@ -366,7 +364,7 @@ private void logStartingActor(final String actorName) {
*
* @param actorSystem Akka actor system for starting actors.
*/
protected void startDevOpsCommandsActor(final ActorSystem actorSystem) {
private void startDevOpsCommandsActor(final ActorSystem actorSystem) {
startActor(actorSystem, DevOpsCommandsActor.props(LogbackLoggingFacade.newInstance(), serviceName,
InstanceIdentifierSupplier.getInstance().get()), DevOpsCommandsActor.ACTOR_NAME);
}
Expand All @@ -386,7 +384,7 @@ protected void startDevOpsCommandsActor(final ActorSystem actorSystem) {
* @param actorSystem Akka actor system for starting actors.
* @param serviceSpecificConfig the configuration settings of this service.
*/
protected void startServiceRootActors(final ActorSystem actorSystem, final C serviceSpecificConfig) {
private void startServiceRootActors(final ActorSystem actorSystem, final C serviceSpecificConfig) {
logger.info("Waiting for member to be up before proceeding with further initialisation.");

Cluster.get(actorSystem).registerOnMemberUp(() -> {
Expand All @@ -411,7 +409,7 @@ protected void startServiceRootActors(final ActorSystem actorSystem, final C ser
*
* @param serviceSpecificConfig the Ditto serviceSpecificConfig providing the limits from configuration
*/
protected void injectSystemPropertiesLimits(final C serviceSpecificConfig) {
private void injectSystemPropertiesLimits(final C serviceSpecificConfig) {
final var limitsConfig = serviceSpecificConfig.getLimitsConfig();
System.setProperty(DittoSystemProperties.DITTO_LIMITS_THINGS_MAX_SIZE_BYTES,
Long.toString(limitsConfig.getThingsMaxSize()));
Expand Down Expand Up @@ -447,7 +445,7 @@ protected abstract Props getMainRootActorProps(C serviceSpecificConfig,
* @param actorSystem Akka actor system for starting actors.
* @param mainRootActorProps the Props of the main root actor.
*/
protected ActorRef startMainRootActor(final ActorSystem actorSystem, final Props mainRootActorProps) {
private ActorRef startMainRootActor(final ActorSystem actorSystem, final Props mainRootActorProps) {
return startActor(actorSystem, mainRootActorProps, rootActorName);
}

Expand Down
Expand Up @@ -73,9 +73,7 @@ protected Props getMainRootActorProps(final ConnectivityConfig connectivityConfi
}

@Override
protected Config appendAkkaPersistenceMongoUriToRawConfig(final Config rawConfig,
final ConnectivityConfig serviceSpecificConfig) {

protected Config appendAkkaPersistenceMongoUriToRawConfig() {
final var mongoDbConfig = serviceSpecificConfig.getMongoDbConfig();
final String mongoDbUri = mongoDbConfig.getMongoDbUri();
return rawConfig.withValue(MONGO_URI_CONFIG_PATH, ConfigValueFactory.fromAnyRef(mongoDbUri));
Expand Down
Expand Up @@ -70,9 +70,7 @@ protected Props getMainRootActorProps(final PoliciesConfig policiesConfig,
}

@Override
protected Config appendAkkaPersistenceMongoUriToRawConfig(final Config rawConfig,
final PoliciesConfig serviceSpecificConfig) {

protected Config appendAkkaPersistenceMongoUriToRawConfig() {
final var mongoDbConfig = serviceSpecificConfig.getMongoDbConfig();
final String mongoDbUri = mongoDbConfig.getMongoDbUri();
return rawConfig.withValue(MONGO_URI_CONFIG_PATH, ConfigValueFactory.fromAnyRef(mongoDbUri));
Expand Down
Expand Up @@ -74,9 +74,7 @@ protected Props getMainRootActorProps(final ThingsConfig thingsConfig,
}

@Override
protected Config appendAkkaPersistenceMongoUriToRawConfig(final Config rawConfig,
final ThingsConfig serviceSpecificConfig) {

protected Config appendAkkaPersistenceMongoUriToRawConfig() {
final var mongoDbConfig = serviceSpecificConfig.getMongoDbConfig();
final String mongoDbUri = mongoDbConfig.getMongoDbUri();
return rawConfig.withValue(MONGO_URI_CONFIG_PATH, ConfigValueFactory.fromAnyRef(mongoDbUri));
Expand Down

0 comments on commit 65e4e90

Please sign in to comment.