src/org/sonews/daemon/command/Command.java
author cli
Sun, 29 Aug 2010 17:28:58 +0200
changeset 35 ed84c8bdd87b
parent 20 org/sonews/daemon/command/Command.java@6ae5e4f8329b
child 37 74139325d305
permissions -rw-r--r--
Moving source files into src/-subdir.
chris@3
     1
/*
chris@3
     2
 *   SONEWS News Server
chris@3
     3
 *   see AUTHORS for the list of contributors
chris@3
     4
 *
chris@3
     5
 *   This program is free software: you can redistribute it and/or modify
chris@3
     6
 *   it under the terms of the GNU General Public License as published by
chris@3
     7
 *   the Free Software Foundation, either version 3 of the License, or
chris@3
     8
 *   (at your option) any later version.
chris@3
     9
 *
chris@3
    10
 *   This program is distributed in the hope that it will be useful,
chris@3
    11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@3
    12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@3
    13
 *   GNU General Public License for more details.
chris@3
    14
 *
chris@3
    15
 *   You should have received a copy of the GNU General Public License
chris@3
    16
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
chris@3
    17
 */
chris@3
    18
chris@3
    19
package org.sonews.daemon.command;
chris@3
    20
chris@3
    21
import java.io.IOException;
chris@3
    22
import org.sonews.daemon.NNTPConnection;
chris@3
    23
import org.sonews.storage.StorageBackendException;
chris@3
    24
chris@3
    25
/**
chris@3
    26
 * Interface for pluggable NNTP commands handling classes.
chris@3
    27
 * @author Christian Lins
chris@3
    28
 * @since sonews/0.6.0
chris@3
    29
 */
chris@3
    30
public interface Command
chris@3
    31
{
chris@3
    32
cli@20
    33
  /**
cli@20
    34
   * @return true if this instance can be reused.
cli@20
    35
   */
chris@3
    36
  boolean hasFinished();
chris@3
    37
cli@20
    38
  /**
cli@20
    39
   * Returns capability string that is implied by this command class.
cli@20
    40
   * MAY return null if the command is required by the NNTP standard.
cli@20
    41
   */
cli@20
    42
  String impliedCapability();
cli@20
    43
chris@3
    44
  boolean isStateful();
chris@3
    45
chris@3
    46
  String[] getSupportedCommandStrings();
chris@3
    47
chris@3
    48
  void processLine(NNTPConnection conn, String line, byte[] rawLine)
chris@3
    49
    throws IOException, StorageBackendException;
chris@3
    50
chris@3
    51
}