AddressTranslator.java

/*
 * Copyright (c) 2008-2017, 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.client.connection;

import com.hazelcast.nio.Address;

/**
 *  Address Translator is used for resolve private ip
 *  addresses of cloud services.
 */
public interface AddressTranslator {

    /**
     * Translates the given address to another address specific to
     * network or service
     *
     * @param address
     * @return new address if given address is known, otherwise return null
     */
    Address translate(Address address);

    /**
     * Refreshes the internal lookup table if necessary.
     */
    void refresh();

}