View Javadoc
1 package org.apache.commons.net; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Commons" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.IOException; 58 import java.io.InputStream; 59 60 /**** 61 * The WhoisClient class implements the client side of the Internet Whois 62 * Protocol defined in RFC 954. To query a host you create a 63 * WhoisClient instance, connect to the host, query the host, and finally 64 * disconnect from the host. If the whois service you want to query is on 65 * a non-standard port, connect to the host at that port. 66 * Here's a sample use: 67 * <pre> 68 * WhoisClient whois; 69 * 70 * whois = new WhoisClient(); 71 * 72 * try { 73 * whois.connect(WhoisClient.DEFAULT_HOST); 74 * System.out.println(whois.query("foobar")); 75 * whois.disconnect(); 76 * } catch(IOException e) { 77 * System.err.println("Error I/O exception: " + e.getMessage()); 78 * return; 79 * } 80 * </pre> 81 * 82 * <p> 83 * <p> 84 * @author Daniel F. Savarese 85 ***/ 86 87 public final class WhoisClient extends FingerClient 88 { 89 /**** 90 * The default whois host to query. It is set to whois.internic.net. 91 ***/ 92 public static final String DEFAULT_HOST = "whois.internic.net"; 93 94 /**** 95 * The default whois port. It is set to 43 according to RFC 954. 96 ***/ 97 public static final int DEFAULT_PORT = 43; 98 99 100 /**** 101 * The default whois constructor. Initializes the 102 * default port to <code> DEFAULT_PORT </code>. 103 ***/ 104 public WhoisClient() 105 { 106 setDefaultPort(DEFAULT_PORT); 107 } 108 109 /**** 110 * Queries the connected whois server for information regarding 111 * the given handle. It is up to the programmer to be familiar with the 112 * handle syntax of the whois server. You must first connect to a whois 113 * server before calling this method, and you should disconnect afterward. 114 * <p> 115 * @param handle The handle to lookup. 116 * @return The result of the whois query. 117 * @exception IOException If an I/O error occurs during the operation. 118 ***/ 119 public String query(String handle) throws IOException 120 { 121 return query(false, handle); 122 } 123 124 125 /**** 126 * Queries the connected whois server for information regarding 127 * the given handle and returns the InputStream of the network connection. 128 * It is up to the programmer to be familiar with the handle syntax 129 * of the whois server. You must first connect to a finger server before 130 * calling this method, and you should disconnect after finishing reading 131 * the stream. 132 * <p> 133 * @param handle The handle to lookup. 134 * @return The InputStream of the network connection of the whois query. 135 * Can be read to obtain whois results. 136 * @exception IOException If an I/O error occurs during the operation. 137 ***/ 138 public InputStream getInputStream(String handle) throws IOException 139 { 140 return getInputStream(false, handle); 141 } 142 143 } 144

This page was automatically generated by Maven