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