org.opentcs.kernel.extensions.rmi.RegistryProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-kernel-extension-rmi-services Show documentation

openTCS-Kernel-Extension-RMI-Services

There is a newer version: 6.2.0

Show newest version

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.kernel.extensions.rmi;

import static java.util.Objects.requireNonNull;

import jakarta.annotation.Nonnull;
import jakarta.inject.Inject;
import java.rmi.RemoteException;
import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import org.opentcs.access.rmi.factories.SocketFactoryProvider;
import org.opentcs.components.Lifecycle;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provides the one {@link Registry} instance used for RMI communication.
 */
public class RegistryProvider
    implements
      Lifecycle {

  /**
   * This class' logger.
   */
  private static final Logger LOG = LoggerFactory.getLogger(RegistryProvider.class);
  /**
   * Provides socket factories used to create RMI registries.
   */
  private final SocketFactoryProvider socketFactoryProvider;
  /**
   * This class' configuration.
   */
  private final RmiKernelInterfaceConfiguration configuration;
  /**
   * The actual registry instance.
   */
  private Registry registry;
  /**
   * Whether this provider is initialized or not.
   */
  private boolean initialized;

  /**
   * Creates a new instance.
   *
   * @param socketFactoryProvider The socket factory provider used for RMI.
   * @param configuration This class' configuration.
   */
  @Inject
  public RegistryProvider(
      @Nonnull
      SocketFactoryProvider socketFactoryProvider,
      @Nonnull
      RmiKernelInterfaceConfiguration configuration
  ) {
    this.socketFactoryProvider = requireNonNull(socketFactoryProvider, "socketFactoryProvider");
    this.configuration = requireNonNull(configuration, "configuration");
  }

  @Override
  public void initialize() {
    if (isInitialized()) {
      LOG.debug("Already initialized.");
      return;
    }

    installRegistry();

    initialized = true;
  }

  @Override
  public boolean isInitialized() {
    return initialized;
  }

  @Override
  public void terminate() {
    if (!isInitialized()) {
      LOG.debug("Not initialized.");
      return;
    }

    registry = null;

    initialized = false;
  }

  @Nonnull
  public Registry get() {
    return registry;
  }

  private void installRegistry() {
    try {
      LOG.debug("Trying to create a local registry...");
      registry = LocateRegistry.createRegistry(
          configuration.registryPort(),
          socketFactoryProvider.getClientSocketFactory(),
          socketFactoryProvider.getServerSocketFactory()
      );
      // Make sure the registry is running
      registry.list();
    }
    catch (RemoteException ex) {
      LOG.error("Couldn't create a working local registry.");
      registry = null;
      throw new RuntimeException(ex);
    }
  }
}