org/sonews/daemon/command/CapabilitiesCommand.java
author cli
Mon Aug 24 13:00:05 2009 +0200 (2009-08-24)
changeset 20 6ae5e4f8329b
parent 3 2fdc9cc89502
permissions -rw-r--r--
Add stubs for org.sonews.acl and add method "impliedCapability" for org.sonews.command.Command interface.
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
chris@1
    24
/**
chris@1
    25
 * <pre>
cli@20
    26
 *  The CAPABILITIES command allows a client to determine the
cli@20
    27
 *  capabilities of the server at any given time.
chris@1
    28
 *
cli@20
    29
 *  This command MAY be issued at any time; the server MUST NOT require
cli@20
    30
 *  it to be issued in order to make use of any capability. The response
cli@20
    31
 *  generated by this command MAY change during a session because of
cli@20
    32
 *  other state information (which, in turn, may be changed by the
cli@20
    33
 *  effects of other commands or by external events).  An NNTP client is
cli@20
    34
 *  only able to get the current and correct information concerning
cli@20
    35
 *  available capabilities at any point during a session by issuing a
cli@20
    36
 *  CAPABILITIES command at that point of that session and processing the
cli@20
    37
 *  response.
chris@1
    38
 * </pre>
chris@1
    39
 * @author Christian Lins
chris@1
    40
 * @since sonews/0.5.0
chris@1
    41
 */
chris@3
    42
public class CapabilitiesCommand implements Command
chris@1
    43
{
chris@1
    44
chris@3
    45
  static final String[] CAPABILITIES = new String[]
chris@1
    46
    {
chris@1
    47
      "VERSION 2", // MUST be the first one; VERSION 2 refers to RFC3977
chris@1
    48
      "READER",    // Server implements commands for reading
chris@1
    49
      "POST",      // Server implements POST command
chris@1
    50
      "OVER"       // Server implements OVER command
chris@1
    51
    };
chris@3
    52
chris@3
    53
  @Override
chris@3
    54
  public String[] getSupportedCommandStrings()
chris@1
    55
  {
chris@3
    56
    return new String[] {"CAPABILITIES"};
chris@1
    57
  }
chris@1
    58
chris@1
    59
  /**
chris@1
    60
   * First called after one call to processLine().
chris@1
    61
   * @return
chris@1
    62
   */
chris@1
    63
  @Override
chris@1
    64
  public boolean hasFinished()
chris@1
    65
  {
chris@1
    66
    return true;
chris@1
    67
  }
chris@1
    68
chris@1
    69
  @Override
cli@20
    70
  public String impliedCapability()
cli@20
    71
  {
cli@20
    72
    return null;
cli@20
    73
  }
cli@20
    74
  
cli@20
    75
  @Override
chris@3
    76
  public boolean isStateful()
chris@3
    77
  {
chris@3
    78
    return false;
chris@3
    79
  }
chris@3
    80
chris@3
    81
  @Override
chris@3
    82
  public void processLine(NNTPConnection conn, final String line, byte[] raw)
chris@1
    83
    throws IOException
chris@1
    84
  {
chris@3
    85
    conn.println("101 Capabilities list:");
chris@1
    86
    for(String cap : CAPABILITIES)
chris@1
    87
    {
chris@3
    88
      conn.println(cap);
chris@1
    89
    }
chris@3
    90
    conn.println(".");
chris@1
    91
  }
chris@1
    92
chris@1
    93
}