com.hazelcast.instance.AddressPicker Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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 com.hazelcast.instance;
import com.hazelcast.cluster.Address;
import java.nio.channels.ServerSocketChannel;
import java.util.Map;
/**
* Strategy to select an {@link Address} that a Hazelcast cluster member binds its server socket to
* and a (potentially different) address that Hazelcast will advertise to other cluster members and clients.
*/
public interface AddressPicker {
/**
* Picks both server socket listener address and public address.
*
* @throws Exception if failure happened while picking an address.
*/
void pickAddress() throws Exception;
/**
* Returns a server socket listener address. The returned address for different {@link EndpointQualifier}s
* may be the same or different, depending on the actual network configuration.
*
* @return {@link Address} where the server socket was bound to or null if called before.
* {@link #pickAddress()}
* @since 3.12
*/
Address getBindAddress(EndpointQualifier qualifier);
/**
* Returns a public address to be advertised to other cluster members and clients.
*
* @return {@link Address} another members can use to connect to this member or null if called before
* {@link #pickAddress()}
* @since 3.12
*/
Address getPublicAddress(EndpointQualifier qualifier);
Map getPublicAddressMap();
/**
* Returns a server channel.
*
* @return ServerSocketChannel to be listened to by an acceptor or null if called before
* {@link #pickAddress()}
* @since 3.12
*/
ServerSocketChannel getServerSocketChannel(EndpointQualifier qualifier);
/**
* Returns all {@link ServerSocketChannel}s of this member, mapped by corresponding {@link EndpointQualifier}
*
* @return a {@code Map} of this member's server socket channels
* @since 3.12
*/
Map getServerSocketChannels();
}