/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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 org.apereo.portal.jgroups.protocols;

import java.util.Collection;
import java.util.Map;
import org.jgroups.Address;
import org.jgroups.PhysicalAddress;

/**
 * Shared persistent store used by {@link DAO_PING} to discover other cluster members.
 *
 */
public interface PingDao {
    /**
     * Add an address pair to the data store
     *
     * @param clusterName Name of the cluster the address is from
     * @param memberAddress The "unique within the cluster" address for the member
     * @param physicalAddress The physical address that the member can be contacted at
     */
    void addAddress(String clusterName, Address memberAddress, PhysicalAddress physicalAddress);

    /**
     * Get all of the members listed for the specified cluster.
     *
     * @param clusterName Name of the cluster to get member address information for
     * @return Map of unique member address to physical address
     */
    Map<Address, PhysicalAddress> getAddresses(String clusterName);

    /**
     * Remove all cluster members that are not listed in includedAddresses.
     *
     * @param clusterName Name of the cluster to purge addresses in
     * @param includedAddresses The addresses to keep
     */
    void purgeOtherAddresses(String clusterName, Collection<Address> includedAddresses);
}