io.hekate.core.service.InitializationContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hekate-core Show documentation

Java library for cluster communications and computing.

There is a newer version: 4.1.3

/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project licenses this file to you 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.hekate.core.service;

import io.hekate.cluster.ClusterNode;
import io.hekate.core.Hekate;
import io.micrometer.core.instrument.MeterRegistry;

/**
 * Context for {@link InitializingService}.
 */
public interface InitializationContext {
    /**
     * Returns the cluster name.
     *
     * @return Cluster name.
     */
    String clusterName();

    /**
     * Returns the current state of {@link Hekate} instance that this service belongs to.
     *
     * @return State.
     */
    Hekate.State state();

    /**
     * Returns cluster context.
     *
     * @return Cluster context.
     */
    ClusterContext cluster();

    /**
     * Returns the cluster node.
     *
     * @return Cluster node.
     */
    ClusterNode localNode();

    /**
     * Returns the {@link Hekate} instance that this service belongs to.
     *
     * @return {@link Hekate} instance that this service belongs to.
     */
    Hekate hekate();

    /**
     * Instructs local node to asynchronously leave and rejoin to the cluster.
     */
    void rejoin();

    /**
     * Triggers asynchronous {@link Hekate#terminateAsync() termination} of the local node.
     */
    void terminate();

    /**
     * Triggers asynchronous {@link Hekate#terminateAsync() termination} of the local node with the specified error..
     *
     * @param e Cause of termination.
     */
    void terminate(Throwable e);

    /**
     * Returns metrics registry.
     *
     * @return Metrics registry.
     */
    MeterRegistry metrics();
}