org.apache.commons.net

Class WhoisClient


public final class WhoisClient
extends FingerClient

The WhoisClient class implements the client side of the Internet Whois Protocol defined in RFC 954. To query a host you create a WhoisClient instance, connect to the host, query the host, and finally disconnect from the host. If the whois service you want to query is on a non-standard port, connect to the host at that port. Here's a sample use:
    WhoisClient whois;

    whois = new WhoisClient();

    try {
      whois.connect(WhoisClient.DEFAULT_HOST);
      System.out.println(whois.query("foobar"));
      whois.disconnect();
    } catch(IOException e) {
      System.err.println("Error I/O exception: " + e.getMessage());
      return;
    }
 

Field Summary

static String
DEFAULT_HOST
The default whois host to query.
static int
DEFAULT_PORT
The default whois port.

Fields inherited from class org.apache.commons.net.FingerClient

DEFAULT_PORT

Fields inherited from class org.apache.commons.net.SocketClient

NETASCII_EOL, _defaultPort_, _input_, _isConnected_, _output_, _socketFactory_, _socket_, _timeout_

Constructor Summary

WhoisClient()
The default whois constructor.

Method Summary

InputStream
getInputStream(String handle)
Queries the connected whois server for information regarding the given handle and returns the InputStream of the network connection.
String
query(String handle)
Queries the connected whois server for information regarding the given handle.

Methods inherited from class org.apache.commons.net.FingerClient

getInputStream, getInputStream, query, query

Methods inherited from class org.apache.commons.net.SocketClient

_connectAction_, connect, connect, connect, connect, connect, connect, disconnect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSoLinger, setSoTimeout, setSocketFactory, setTcpNoDelay, verifyRemote

Field Details

DEFAULT_HOST

public static final String DEFAULT_HOST
The default whois host to query. It is set to whois.internic.net.

DEFAULT_PORT

public static final int DEFAULT_PORT
The default whois port. It is set to 43 according to RFC 954.
Field Value:
43

Constructor Details

WhoisClient

public WhoisClient()
The default whois constructor. Initializes the default port to DEFAULT_PORT .

Method Details

getInputStream

public InputStream getInputStream(String handle)
            throws IOException
Queries the connected whois server for information regarding the given handle and returns the InputStream of the network connection. It is up to the programmer to be familiar with the handle syntax of the whois server. You must first connect to a finger server before calling this method, and you should disconnect after finishing reading the stream.

Parameters:
handle - The handle to lookup.
Returns:
The InputStream of the network connection of the whois query. Can be read to obtain whois results.

query

public String query(String handle)
            throws IOException
Queries the connected whois server for information regarding the given handle. It is up to the programmer to be familiar with the handle syntax of the whois server. You must first connect to a whois server before calling this method, and you should disconnect afterward.

Parameters:
handle - The handle to lookup.
Returns:
The result of the whois query.