View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.whois;
19  
20  import java.io.IOException;
21  import java.io.InputStream;
22  
23  import org.apache.commons.net.finger.FingerClient;
24  
25  /***
26   * The WhoisClient class implements the client side of the Internet Whois
27   * Protocol defined in RFC 954.   To query a host you create a
28   * WhoisClient instance, connect to the host, query the host, and finally
29   * disconnect from the host.  If the whois service you want to query is on
30   * a non-standard port, connect to the host at that port.
31   * Here's a sample use:
32   * <pre>
33   *    WhoisClient whois;
34   *
35   *    whois = new WhoisClient();
36   *
37   *    try {
38   *      whois.connect(WhoisClient.DEFAULT_HOST);
39   *      System.out.println(whois.query("foobar"));
40   *      whois.disconnect();
41   *    } catch(IOException e) {
42   *      System.err.println("Error I/O exception: " + e.getMessage());
43   *      return;
44   *    }
45   * </pre>
46   *
47   * <p>
48   * <p>
49   ***/
50  
51  public final class WhoisClient extends FingerClient
52  {
53      /***
54       * The default whois host to query.  It is set to whois.internic.net.
55       ***/
56      public static final String DEFAULT_HOST = "whois.internic.net";
57  
58      /***
59       * The default whois port.  It is set to 43 according to RFC 954.
60       ***/
61      public static final int DEFAULT_PORT = 43;
62  
63  
64      /***
65       * The default whois constructor.    Initializes the
66       * default port to <code> DEFAULT_PORT </code>.
67       ***/
68      public WhoisClient()
69      {
70          setDefaultPort(DEFAULT_PORT);
71      }
72  
73      /***
74       * Queries the connected whois server for information regarding
75       * the given handle.  It is up to the programmer to be familiar with the
76       * handle syntax of the whois server.  You must first connect to a whois
77       * server before calling this method, and you should disconnect afterward.
78       * <p>
79       * @param handle  The handle to lookup.
80       * @return The result of the whois query.
81       * @exception IOException  If an I/O error occurs during the operation.
82       ***/
83      public String query(String handle) throws IOException
84      {
85          return query(false, handle);
86      }
87  
88  
89      /***
90       * Queries the connected whois server for information regarding
91       * the given handle and returns the InputStream of the network connection.
92       * It is up to the programmer to be familiar with the handle syntax
93       * of the whois server.  You must first connect to a finger server before
94       * calling this method, and you should disconnect after finishing reading
95       * the stream.
96       * <p>
97       * @param handle  The handle to lookup.
98       * @return The InputStream of the network connection of the whois query.
99       *         Can be read to obtain whois results.
100      * @exception IOException  If an I/O error occurs during the operation.
101      ***/
102     public InputStream getInputStream(String handle) throws IOException
103     {
104         return getInputStream(false, handle);
105     }
106 
107 }
108