Package org.apache.flink.runtime.highavailability.nonha.embedded

Class EmbeddedHaServices

java.lang.Object
org.apache.flink.runtime.highavailability.nonha.AbstractNonHaServices
org.apache.flink.runtime.highavailability.nonha.embedded.EmbeddedHaServices
All Implemented Interfaces:
AutoCloseable, GloballyCleanableResource, ClientHighAvailabilityServices, HighAvailabilityServices
Direct Known Subclasses:
EmbeddedHaServicesWithLeadershipControl
public class EmbeddedHaServices extends AbstractNonHaServices
An implementation of the HighAvailabilityServices for the non-high-availability case where all participants (ResourceManager, JobManagers, TaskManagers) run in the same process.

This implementation has no dependencies on any external services. It returns a fix pre-configured ResourceManager, and stores checkpoints and metadata simply on the heap or on a local file system and therefore in a storage without guarantees.

  • Constructor Details

    • EmbeddedHaServices

      public EmbeddedHaServices(Executor executor)

  • Method Details

    • getResourceManagerLeaderRetriever

      public LeaderRetrievalService getResourceManagerLeaderRetriever()
      Description copied from interface: HighAvailabilityServices
      Gets the leader retriever for the cluster's resource manager.

    • getDispatcherLeaderRetriever

      public LeaderRetrievalService getDispatcherLeaderRetriever()
      Description copied from interface: HighAvailabilityServices
      Gets the leader retriever for the dispatcher. This leader retrieval service is not always accessible.

    • getResourceManagerLeaderElection

      public LeaderElection getResourceManagerLeaderElection()
      Description copied from interface: HighAvailabilityServices
      Gets the LeaderElection for the cluster's resource manager.

    • getDispatcherLeaderElection

      public LeaderElection getDispatcherLeaderElection()
      Description copied from interface: HighAvailabilityServices
      Gets the LeaderElection for the cluster's dispatcher.

    • getJobManagerLeaderRetriever

      public LeaderRetrievalService getJobManagerLeaderRetriever(org.apache.flink.api.common.JobID jobID)
      Description copied from interface: HighAvailabilityServices
      Gets the leader retriever for the job JobMaster which is responsible for the given job.
      Parameters:
      jobID - The identifier of the job.
      Returns:
      Leader retrieval service to retrieve the job manager for the given job

    • getJobManagerLeaderRetriever

      public LeaderRetrievalService getJobManagerLeaderRetriever(org.apache.flink.api.common.JobID jobID, String defaultJobManagerAddress)
      Description copied from interface: HighAvailabilityServices
      Gets the leader retriever for the job JobMaster which is responsible for the given job.
      Parameters:
      jobID - The identifier of the job.
      defaultJobManagerAddress - JobManager address which will be returned by a static leader retrieval service.
      Returns:
      Leader retrieval service to retrieve the job manager for the given job

    • getClusterRestEndpointLeaderRetriever

      public LeaderRetrievalService getClusterRestEndpointLeaderRetriever()
      Description copied from interface: ClientHighAvailabilityServices
      Get the leader retriever for the cluster's rest endpoint.
      Returns:
      the leader retriever for cluster's rest endpoint.

    • getJobManagerLeaderElection

      public LeaderElection getJobManagerLeaderElection(org.apache.flink.api.common.JobID jobID)
      Description copied from interface: HighAvailabilityServices
      Gets the LeaderElection for the job with the given JobID.

    • getClusterRestEndpointLeaderElection

      public LeaderElection getClusterRestEndpointLeaderElection()
      Description copied from interface: HighAvailabilityServices
      Gets the LeaderElection for the cluster's rest endpoint.

    • close

      public void close() throws Exception
      Description copied from interface: HighAvailabilityServices
      Closes the high availability services, releasing all resources.

      This method does not delete or clean up any data stored in external stores (file systems, ZooKeeper, etc). Another instance of the high availability services will be able to recover the job.

      If an exception occurs during closing services, this method will attempt to continue closing other services and report exceptions only after all services have been attempted to be closed.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface HighAvailabilityServices
      Overrides:
      close in class AbstractNonHaServices
      Throws:
      Exception - Thrown, if an exception occurred while closing these services.