org.wildfly.clustering.registry.Registry Maven / Gradle / Ivy

Go to download

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

This module contains a public API for a variety of clustering capabilities for use by both applications and other subsystems.

There is a newer version: 26.1.3.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2013, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.wildfly.clustering.registry;

import java.util.Map;

import org.wildfly.clustering.Registrar;
import org.wildfly.clustering.group.Group;
import org.wildfly.clustering.group.Node;

/**
 * Clustered registry abstraction that stores a unique key/value per node.
 *
 * @param  the type of the registry entry key
 * @param  the type of the registry entry value
 * @author Paul Ferraro
 */
public interface Registry extends Registrar>, AutoCloseable {

    /**
     * @deprecated Replaced by {@link RegistryListener}.
     */
    @Deprecated interface Listener extends RegistryListener {
    }

    /**
     * Returns the group associated with this factory.
     *
     * @return a group
     */
    Group getGroup();

    /**
     * @deprecated Replaced by {@link #register(RegistryListener)}.
     */
    @Deprecated default void addListener(Listener listener) {
        this.register(listener);
    }

    /**
     * @deprecated Replaced by {@link org.wildfly.clustering.Registration#close()}.
     */
    @Deprecated default void removeListener(Listener listener) {
        // Do nothing
    }

    /**
     * Returns all registry entries in this group.
     *
     * @return a map for entries
     */
    Map getEntries();

    /**
     * Returns the registry entry for the specified node.
     *
     * @param node a node
     * @return the node's registry entry, or null if undefined
     */
    Map.Entry getEntry(Node node);

    /**
     * Removes our entry from the registry.
     * Once closed, the registry can no longer be accessed.
     */
    @Override
    void close();
}