src/org/sonews/daemon/command/CapabilitiesCommand.java
author František Kučera <franta-hg@frantovo.cz>
Thu Jul 05 13:19:19 2012 +0200 (2012-07-05)
changeset 119 f5b57e221e38
parent 35 ed84c8bdd87b
permissions -rwxr-xr-x
mezery, tabulátory
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
cli@37
    45
	static final String[] CAPABILITIES = new String[] {
cli@37
    46
		"VERSION 2", // MUST be the first one; VERSION 2 refers to RFC3977
cli@37
    47
		"READER", // Server implements commands for reading
cli@37
    48
		"POST", // Server implements POST command
cli@37
    49
		"OVER" // Server implements OVER command
cli@37
    50
	};
chris@3
    51
cli@37
    52
	@Override
cli@37
    53
	public String[] getSupportedCommandStrings()
cli@37
    54
	{
cli@37
    55
		return new String[] {"CAPABILITIES"};
cli@37
    56
	}
chris@1
    57
cli@37
    58
	/**
cli@37
    59
	 * First called after one call to processLine().
cli@37
    60
	 * @return
cli@37
    61
	 */
cli@37
    62
	@Override
cli@37
    63
	public boolean hasFinished()
cli@37
    64
	{
cli@37
    65
		return true;
cli@37
    66
	}
chris@1
    67
cli@37
    68
	@Override
cli@37
    69
	public String impliedCapability()
cli@37
    70
	{
cli@37
    71
		return null;
cli@37
    72
	}
chris@3
    73
cli@37
    74
	@Override
cli@37
    75
	public boolean isStateful()
cli@37
    76
	{
cli@37
    77
		return false;
cli@37
    78
	}
chris@1
    79
cli@37
    80
	@Override
cli@37
    81
	public void processLine(NNTPConnection conn, final String line, byte[] raw)
cli@37
    82
		throws IOException
cli@37
    83
	{
cli@37
    84
		conn.println("101 Capabilities list:");
cli@37
    85
		for (String cap : CAPABILITIES) {
cli@37
    86
			conn.println(cap);
cli@37
    87
		}
cli@37
    88
		conn.println(".");
cli@37
    89
	}
chris@1
    90
}