src/org/sonews/daemon/command/Command.java
changeset 36 c404a87db5b7
parent 20 6ae5e4f8329b
child 37 74139325d305
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/org/sonews/daemon/command/Command.java	Sun Aug 29 17:43:58 2010 +0200
     1.3 @@ -0,0 +1,51 @@
     1.4 +/*
     1.5 + *   SONEWS News Server
     1.6 + *   see AUTHORS for the list of contributors
     1.7 + *
     1.8 + *   This program is free software: you can redistribute it and/or modify
     1.9 + *   it under the terms of the GNU General Public License as published by
    1.10 + *   the Free Software Foundation, either version 3 of the License, or
    1.11 + *   (at your option) any later version.
    1.12 + *
    1.13 + *   This program is distributed in the hope that it will be useful,
    1.14 + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.16 + *   GNU General Public License for more details.
    1.17 + *
    1.18 + *   You should have received a copy of the GNU General Public License
    1.19 + *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    1.20 + */
    1.21 +
    1.22 +package org.sonews.daemon.command;
    1.23 +
    1.24 +import java.io.IOException;
    1.25 +import org.sonews.daemon.NNTPConnection;
    1.26 +import org.sonews.storage.StorageBackendException;
    1.27 +
    1.28 +/**
    1.29 + * Interface for pluggable NNTP commands handling classes.
    1.30 + * @author Christian Lins
    1.31 + * @since sonews/0.6.0
    1.32 + */
    1.33 +public interface Command
    1.34 +{
    1.35 +
    1.36 +  /**
    1.37 +   * @return true if this instance can be reused.
    1.38 +   */
    1.39 +  boolean hasFinished();
    1.40 +
    1.41 +  /**
    1.42 +   * Returns capability string that is implied by this command class.
    1.43 +   * MAY return null if the command is required by the NNTP standard.
    1.44 +   */
    1.45 +  String impliedCapability();
    1.46 +
    1.47 +  boolean isStateful();
    1.48 +
    1.49 +  String[] getSupportedCommandStrings();
    1.50 +
    1.51 +  void processLine(NNTPConnection conn, String line, byte[] rawLine)
    1.52 +    throws IOException, StorageBackendException;
    1.53 +
    1.54 +}