src/org/sonews/daemon/command/Command.java
author cli
Sat, 10 Sep 2011 18:18:05 +0200
changeset 45 7e24949b87b0
parent 37 74139325d305
permissions -rwxr-xr-x
HSQLDB backend support completed, but untested.
     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.storage.StorageBackendException;
    24 
    25 /**
    26  * Interface for pluggable NNTP commands handling classes.
    27  * @author Christian Lins
    28  * @since sonews/0.6.0
    29  */
    30 public interface Command
    31 {
    32 
    33 	/**
    34 	 * @return true if this instance can be reused.
    35 	 */
    36 	boolean hasFinished();
    37 
    38 	/**
    39 	 * Returns capability string that is implied by this command class.
    40 	 * MAY return null if the command is required by the NNTP standard.
    41 	 */
    42 	String impliedCapability();
    43 
    44 	boolean isStateful();
    45 
    46 	String[] getSupportedCommandStrings();
    47 
    48 	void processLine(NNTPConnection conn, String line, byte[] rawLine)
    49 		throws IOException, StorageBackendException;
    50 }