com.softlayer.api.service.utility.Network Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.utility;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Utility_Network service allows users to send network diagnostic requests from SoftLayer's application servers to a given host on the Internet. 
 *
 * @see SoftLayer_Utility_Network
 */
@ApiType("SoftLayer_Utility_Network")
public class Network extends Entity {

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    /**
     * The SoftLayer_Utility_Network service allows users to send network diagnostic requests from SoftLayer's application servers to a given host on the Internet. 
     *
     * @see SoftLayer_Utility_Network
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Utility_Network")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * A method used to return the nameserver information for a given address
         *
         * @see SoftLayer_Utility_Network::nsLookup
         */
        @ApiMethod
        public String nsLookup(String address, String type);

        /**
         * Perform a WHOIS lookup from SoftLayer's application servers on the given IP address or hostname and return the raw results of that command. The returned result is similar to the result received from running the command `whois` from a UNIX command shell. A WHOIS lookup queries a host's registrar to retrieve domain registrant information including registration date, expiry date, and the administrative, technical, billing, and abuse contacts responsible for a domain. WHOIS lookups are useful for determining a physical contact responsible for a particular domain. WHOIS lookups are also useful for determining domain availability. Running a WHOIS lookup on an IP address queries ARIN for that IP block's ownership, and is helpful for determining a physical entity responsible for a certain IP address. 
         *
         * @see SoftLayer_Utility_Network::whois
         */
        @ApiMethod
        public String whois(String address);

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#nsLookup}
         */
        public Future nsLookup(String address, String type);

        public Future nsLookup(String address, String type, ResponseHandler callback);

        /**
         * Async version of {@link Service#whois}
         */
        public Future whois(String address);

        public Future whois(String address, ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

    }

}