org/sonews/daemon/command/HelpCommand.java
author cli
Mon Aug 24 13:00:05 2009 +0200 (2009-08-24)
changeset 20 6ae5e4f8329b
parent 3 2fdc9cc89502
child 26 407c428adb5b
permissions -rw-r--r--
Add stubs for org.sonews.acl and add method "impliedCapability" for org.sonews.command.Command interface.
     1 /*
     2  *   SONEWS News Server
     3  *   see AUTHORS for the list of contributors
     4  *
     5  *   This program is free software: you can redistribute it and/or modify
     6  *   it under the terms of the GNU General Public License as published by
     7  *   the Free Software Foundation, either version 3 of the License, or
     8  *   (at your option) any later version.
     9  *
    10  *   This program is distributed in the hope that it will be useful,
    11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  *   GNU General Public License for more details.
    14  *
    15  *   You should have received a copy of the GNU General Public License
    16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  */
    18 
    19 package org.sonews.daemon.command;
    20 
    21 import java.io.IOException;
    22 import org.sonews.daemon.NNTPConnection;
    23 import org.sonews.util.io.Resource;
    24 
    25 /**
    26  * This command provides a short summary of the commands that are
    27  * understood by this implementation of the server.  The help text will
    28  * be presented as a multi-line data block following the 100 response
    29  * code (taken from RFC).
    30  * @author Christian Lins
    31  * @since sonews/0.5.0
    32  */
    33 public class HelpCommand implements Command
    34 {
    35 
    36   @Override
    37   public boolean hasFinished()
    38   {
    39     return true;
    40   }
    41 
    42   @Override
    43   public String impliedCapability()
    44   {
    45     return null;
    46   }
    47 
    48   @Override
    49   public boolean isStateful()
    50   {
    51     return true;
    52   }
    53 
    54   @Override
    55   public String[] getSupportedCommandStrings()
    56   {
    57     return new String[]{"HELP"};
    58   }
    59   
    60   @Override
    61   public void processLine(NNTPConnection conn, final String line, byte[] raw)
    62     throws IOException
    63   {
    64     conn.println("100 help text follows");
    65     
    66     final String[] help = Resource
    67       .getAsString("helpers/helptext", true).split("\n");
    68     for(String hstr : help)
    69     {
    70       conn.println(hstr);
    71     }
    72     
    73     conn.println(".");
    74   }
    75   
    76 }