org.opennms.netmgt.icmp.proxy.LocationAwarePingClient Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2016 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2016 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing 
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.netmgt.icmp.proxy;

import java.net.InetAddress;

/**
 * Location Aware Client to make ping calls to the provided address.
 */
public interface LocationAwarePingClient {

    /**
     * Pings the given address.
     *
     * @param inetAddress The address to ping.
     * @return A request builder to provide additional request options.
     */
    PingRequestBuilder ping(InetAddress inetAddress);

    /**
     * Pings one or more ranges of addresses.
     *
     * @return A request builder to provide the ranges and additional request options.
     */
    PingSweepRequestBuilder sweep();

}