org.wildfly.clustering.singleton.SingletonState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-clustering-singleton-api Show documentation

Public API for installing singleton MSC services.

There is a newer version: 35.0.0.Final

Show newest version

/*
 * Copyright The WildFly Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package org.wildfly.clustering.singleton;

import java.util.Optional;
import java.util.Set;

import org.wildfly.clustering.server.GroupMember;

/**
 * An immutable snapshot of the state of a singleton.
 * @author Paul Ferraro
 */
public interface SingletonState extends SingletonStatus {
    /**
     * Returns the primary provider of the singleton, if one is present.
     * @return the primary provider of the singleton when present
     */
    Optional getPrimaryProvider();

    /**
     * Returns the set of members that provide the singleton, including the primary provider.
     * @return a set of cluster members
     */
    Set getProviders();
}