001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.net.nntp;
019
020/**
021 * NNTPReply stores a set of constants for NNTP reply codes. To interpret the meaning of the codes, familiarity with RFC 977 is assumed. The mnemonic constant
022 * names are transcriptions from the code descriptions of RFC 977.
023 */
024public final class NNTPReply {
025
026    /** NNTP reply code {@value}. */
027    public static final int HELP_TEXT_FOLLOWS = 100;
028
029    /** NNTP reply code {@value}. */
030    public static final int DEBUG_OUTPUT = 199;
031
032    /** NNTP reply code {@value}. */
033    public static final int SERVER_READY_POSTING_ALLOWED = 200;
034
035    /** NNTP reply code {@value}. */
036    public static final int SERVER_READY_POSTING_NOT_ALLOWED = 201;
037
038    /** NNTP reply code {@value}. */
039    public static final int SLAVE_STATUS_NOTED = 202;
040
041    /** NNTP reply code {@value}. */
042    public static final int CLOSING_CONNECTION = 205;
043
044    /** NNTP reply code {@value}. */
045    public static final int GROUP_SELECTED = 211;
046
047    /** NNTP reply code {@value}. */
048    public static final int ARTICLE_RETRIEVED_HEAD_AND_BODY_FOLLOW = 220;
049
050    /** NNTP reply code {@value}. */
051    public static final int ARTICLE_RETRIEVED_HEAD_FOLLOWS = 221;
052
053    /** NNTP reply code {@value}. */
054    public static final int ARTICLE_RETRIEVED_BODY_FOLLOWS = 222;
055
056    /** NNTP reply code {@value}. */
057    public static final int ARTICLE_RETRIEVED_REQUEST_TEXT_SEPARATELY = 223;
058
059    /** NNTP reply code {@value}. */
060    public static final int ARTICLE_LIST_BY_MESSAGE_ID_FOLLOWS = 230;
061
062    /** NNTP reply code {@value}. */
063    public static final int NEW_NEWSGROUP_LIST_FOLLOWS = 231;
064
065    /** NNTP reply code {@value}. */
066    public static final int ARTICLE_TRANSFERRED_OK = 235;
067
068    /** NNTP reply code {@value}. */
069    public static final int ARTICLE_POSTED_OK = 240;
070
071    /** NNTP reply code {@value}. */
072    public static final int AUTHENTICATION_ACCEPTED = 281;
073
074    /** NNTP reply code {@value}. */
075    public static final int SEND_ARTICLE_TO_TRANSFER = 335;
076
077    /** NNTP reply code {@value}. */
078    public static final int SEND_ARTICLE_TO_POST = 340;
079
080    /** NNTP reply code {@value}. */
081    public static final int MORE_AUTH_INFO_REQUIRED = 381;
082
083    /** NNTP reply code {@value}. */
084    public static final int SERVICE_DISCONTINUED = 400;
085
086    /** NNTP reply code {@value}. */
087    public static final int NO_SUCH_NEWSGROUP = 411;
088
089    /** NNTP reply code {@value}. */
090    public static final int NO_NEWSGROUP_SELECTED = 412;
091
092    /** NNTP reply code {@value}. */
093    public static final int NO_CURRENT_ARTICLE_SELECTED = 420;
094
095    /** NNTP reply code {@value}. */
096    public static final int NO_NEXT_ARTICLE = 421;
097
098    /** NNTP reply code {@value}. */
099    public static final int NO_PREVIOUS_ARTICLE = 422;
100
101    /** NNTP reply code {@value}. */
102    public static final int NO_SUCH_ARTICLE_NUMBER = 423;
103
104    /** NNTP reply code {@value}. */
105    public static final int NO_SUCH_ARTICLE_FOUND = 430;
106
107    /** NNTP reply code {@value}. */
108    public static final int ARTICLE_NOT_WANTED = 435;
109
110    /** NNTP reply code {@value}. */
111    public static final int TRANSFER_FAILED = 436;
112
113    /** NNTP reply code {@value}. */
114    public static final int ARTICLE_REJECTED = 437;
115
116    /** NNTP reply code {@value}. */
117    public static final int POSTING_NOT_ALLOWED = 440;
118
119    /** NNTP reply code {@value}. */
120    public static final int POSTING_FAILED = 441;
121
122    /**
123     * NNTP reply code {@value}.
124     *
125     * @since 2.2 - corrected value to 480
126     */
127    public static final int AUTHENTICATION_REQUIRED = 480;
128
129    /** NNTP reply code {@value}. */
130    public static final int AUTHENTICATION_REJECTED = 482;
131
132    /** NNTP reply code {@value}. */
133    public static final int COMMAND_NOT_RECOGNIZED = 500;
134
135    /** NNTP reply code {@value}. */
136    public static final int COMMAND_SYNTAX_ERROR = 501;
137
138    /** NNTP reply code {@value}. */
139    public static final int PERMISSION_DENIED = 502;
140
141    /** NNTP reply code {@value}. */
142    public static final int PROGRAM_FAULT = 503;
143
144    /**
145     * Tests if a reply code is an informational response. All codes beginning with a 1 are positive informational responses. Informational responses are
146     * used to provide human-readable information such as help text.
147     *
148     * @param reply The reply code to test.
149     * @return True if a reply code is an informational response, false if not.
150     */
151    public static boolean isInformational(final int reply) {
152        return reply >= 100 && reply < 200;
153    }
154
155    /**
156     * Tests if a reply code is a negative permanent response. All codes beginning with a 5 are negative permanent responses. The NNTP server will send a
157     * negative permanent response when it does not implement a command, a command is incorrectly formatted, or a serious program error occurs.
158     *
159     * @param reply The reply code to test.
160     * @return True if a reply code is a negative permanent response, false if not.
161     */
162    public static boolean isNegativePermanent(final int reply) {
163        return reply >= 500 && reply < 600;
164    }
165
166    /**
167     * Tests if a reply code is a negative transient response. All codes beginning with a 4 are negative transient responses. The NNTP server will send a
168     * negative transient response on the failure of a correctly formatted command that could not be performed for some reason. For example, retrieving an
169     * article that does not exist will result in a negative transient response.
170     *
171     * @param reply The reply code to test.
172     * @return True if a reply code is a negative transient response, false if not.
173     */
174    public static boolean isNegativeTransient(final int reply) {
175        return reply >= 400 && reply < 500;
176    }
177
178    /**
179     * Tests if a reply code is a positive completion response. All codes beginning with a 2 are positive completion responses. The NNTP server will send a
180     * positive completion response on the final successful completion of a command.
181     *
182     * @param reply The reply code to test.
183     * @return True if a reply code is a positive completion response, false if not.
184     */
185    public static boolean isPositiveCompletion(final int reply) {
186        return reply >= 200 && reply < 300;
187    }
188
189    /**
190     * Tests if a reply code is a positive intermediate response. All codes beginning with a 3 are positive intermediate responses. The NNTP server will
191     * send a positive intermediate response on the successful completion of one part of a multipart command or sequence of commands. For example, after a
192     * successful POST command, a positive intermediate response will be sent to indicate that the server is ready to receive the article to be posted.
193     *
194     * @param reply The reply code to test.
195     * @return True if a reply code is a positive intermediate response, false if not.
196     */
197    public static boolean isPositiveIntermediate(final int reply) {
198        return reply >= 300 && reply < 400;
199    }
200
201    private NNTPReply() {
202    }
203
204}