001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package org.apache.commons.net.chargen; 019 020import java.io.InputStream; 021 022import org.apache.commons.net.SocketClient; 023 024/** 025 * The CharGenTCPClient class is a TCP implementation of a client for the character generator protocol described in RFC 864. It can also be used for Systat (RFC 026 * 866), Quote of the Day (RFC 865), and netstat (port 15). All of these protocols involve connecting to the appropriate port, and reading data from an input 027 * stream. The chargen protocol actually sends data until the receiving end closes the connection. All the others send only a fixed amount of data and then 028 * close the connection. 029 * <p> 030 * To use the CharGenTCPClient class, just establish a connection with {@link org.apache.commons.net.SocketClient#connect connect } and call 031 * {@link #getInputStream getInputStream() } to access the data. Don't close the input stream when you're done with it. Rather, call 032 * {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly. 033 * 034 * @see CharGenUDPClient 035 */ 036 037public final class CharGenTCPClient extends SocketClient { 038 /** The systat port value of 11 according to RFC 866. */ 039 public static final int SYSTAT_PORT = 11; 040 /** The netstat port value of 19. */ 041 public static final int NETSTAT_PORT = 15; 042 /** The quote of the day port value of 17 according to RFC 865. */ 043 public static final int QUOTE_OF_DAY_PORT = 17; 044 /** The character generator port value of 19 according to RFC 864. */ 045 public static final int CHARGEN_PORT = 19; 046 /** The default chargen port. It is set to 19 according to RFC 864. */ 047 public static final int DEFAULT_PORT = 19; 048 049 /** 050 * The default constructor for CharGenTCPClient. It merely sets the default port to <code> DEFAULT_PORT </code>. 051 */ 052 public CharGenTCPClient() { 053 setDefaultPort(DEFAULT_PORT); 054 } 055 056 /** 057 * Returns an InputStream from which the server generated data can be read. You should NOT close the InputStream when you're finished reading from it. 058 * Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly. 059 * 060 * @return An InputStream from which the server generated data can be read. 061 */ 062 public InputStream getInputStream() { 063 return _input_; 064 } 065}