Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.net.nntp
Class NNTPReply

    java.lang.Object
      |
      +--org.apache.commons.net.nntp.NNTPReply

public final class NNTPReply
extends java.lang.Object

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 names are transcriptions from the code descriptions of RFC 977. For those who think in terms of the actual reply code values, a set of CODE_NUM constants are provided where NUM is the numerical value of the code.

Author:
  Daniel F. Savarese

Field Summary
`static int` | `ARTICLE_LIST_BY_MESSAGE_ID_FOLLOWS`
`static int` | `ARTICLE_NOT_WANTED`
`static int` | `ARTICLE_POSTED_OK`
`static int` | `ARTICLE_REJECTED`
`static int` | `ARTICLE_RETRIEVED_BODY_FOLLOWS`
`static int` | `ARTICLE_RETRIEVED_HEAD_AND_BODY_FOLLOW`
`static int` | `ARTICLE_RETRIEVED_HEAD_FOLLOWS`
`static int` | `ARTICLE_RETRIEVED_REQUEST_TEXT_SEPARATELY`
`static int` | `ARTICLE_TRANSFERRED_OK`
`static int` | `CLOSING_CONNECTION`
`static int` | `CODE_100`
`static int` | `CODE_199`
`static int` | `CODE_200`
`static int` | `CODE_201`
`static int` | `CODE_202`
`static int` | `CODE_205`
`static int` | `CODE_211`
`static int` | `CODE_215`
`static int` | `CODE_220`
`static int` | `CODE_221`
`static int` | `CODE_222`
`static int` | `CODE_223`
`static int` | `CODE_230`
`static int` | `CODE_231`
`static int` | `CODE_235`
`static int` | `CODE_240`
`static int` | `CODE_335`
`static int` | `CODE_340`
`static int` | `CODE_400`
`static int` | `CODE_411`
`static int` | `CODE_412`
`static int` | `CODE_420`
`static int` | `CODE_421`
`static int` | `CODE_422`
`static int` | `CODE_423`
`static int` | `CODE_430`
`static int` | `CODE_435`
`static int` | `CODE_436`
`static int` | `CODE_437`
`static int` | `CODE_440`
`static int` | `CODE_441`
`static int` | `CODE_500`
`static int` | `CODE_501`
`static int` | `CODE_502`
`static int` | `CODE_503`
`static int` | `COMMAND_NOT_RECOGNIZED`
`static int` | `COMMAND_SYNTAX_ERROR`
`static int` | `DEBUG_OUTPUT`
`static int` | `GROUP_SELECTED`
`static int` | `HELP_TEXT_FOLLOWS`
`static int` | `NEW_NEWSGROUP_LIST_FOLLOWS`
`static int` | `NO_CURRENT_ARTICLE_SELECTED`
`static int` | `NO_NEWSGROUP_SELECTED`
`static int` | `NO_NEXT_ARTICLE`
`static int` | `NO_PREVIOUS_ARTICLE`
`static int` | `NO_SUCH_ARTICLE_FOUND`
`static int` | `NO_SUCH_ARTICLE_NUMBER`
`static int` | `NO_SUCH_NEWSGROUP`
`static int` | `PERMISSION_DENIED`
`static int` | `POSTING_FAILED`
`static int` | `POSTING_NOT_ALLOWED`
`static int` | `PROGRAM_FAULT`
`static int` | `SEND_ARTICLE_TO_POST`
`static int` | `SEND_ARTICLE_TO_TRANSFER`
`static int` | `SERVER_READY_POSTING_ALLOWED`
`static int` | `SERVER_READY_POSTING_NOT_ALLOWED`
`static int` | `SERVICE_DISCONTINUED`
`static int` | `SLAVE_STATUS_NOTED`
`static int` | `TRANSFER_FAILED`

Method Summary
`static boolean` | `isInformational(int reply)` Determine if a reply code is an informational response.
`static boolean` | `isNegativePermanent(int reply)` Determine if a reply code is a negative permanent response.
`static boolean` | `isNegativeTransient(int reply)` Determine if a reply code is a negative transient response.
`static boolean` | `isPositiveCompletion(int reply)` Determine if a reply code is a positive completion response.
`static boolean` | `isPositiveIntermediate(int reply)` Determine if a reply code is a positive intermediate response.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### CODE_100

    public static final int CODE_100

See Also:
  Constant Field Values

### CODE_199

    public static final int CODE_199

See Also:
  Constant Field Values

### CODE_200

    public static final int CODE_200

See Also:
  Constant Field Values

### CODE_201

    public static final int CODE_201

See Also:
  Constant Field Values

### CODE_202

    public static final int CODE_202

See Also:
  Constant Field Values

### CODE_205

    public static final int CODE_205

See Also:
  Constant Field Values

### CODE_211

    public static final int CODE_211

See Also:
  Constant Field Values

### CODE_215

    public static final int CODE_215

See Also:
  Constant Field Values

### CODE_220

    public static final int CODE_220

See Also:
  Constant Field Values

### CODE_221

    public static final int CODE_221

See Also:
  Constant Field Values

### CODE_222

    public static final int CODE_222

See Also:
  Constant Field Values

### CODE_223

    public static final int CODE_223

See Also:
  Constant Field Values

### CODE_230

    public static final int CODE_230

See Also:
  Constant Field Values

### CODE_231

    public static final int CODE_231

See Also:
  Constant Field Values

### CODE_235

    public static final int CODE_235

See Also:
  Constant Field Values

### CODE_240

    public static final int CODE_240

See Also:
  Constant Field Values

### CODE_335

    public static final int CODE_335

See Also:
  Constant Field Values

### CODE_340

    public static final int CODE_340

See Also:
  Constant Field Values

### CODE_400

    public static final int CODE_400

See Also:
  Constant Field Values

### CODE_411

    public static final int CODE_411

See Also:
  Constant Field Values

### CODE_412

    public static final int CODE_412

See Also:
  Constant Field Values

### CODE_420

    public static final int CODE_420

See Also:
  Constant Field Values

### CODE_421

    public static final int CODE_421

See Also:
  Constant Field Values

### CODE_422

    public static final int CODE_422

See Also:
  Constant Field Values

### CODE_423

    public static final int CODE_423

See Also:
  Constant Field Values

### CODE_430

    public static final int CODE_430

See Also:
  Constant Field Values

### CODE_435

    public static final int CODE_435

See Also:
  Constant Field Values

### CODE_436

    public static final int CODE_436

See Also:
  Constant Field Values

### CODE_437

    public static final int CODE_437

See Also:
  Constant Field Values

### CODE_440

    public static final int CODE_440

See Also:
  Constant Field Values

### CODE_441

    public static final int CODE_441

See Also:
  Constant Field Values

### CODE_500

    public static final int CODE_500

See Also:
  Constant Field Values

### CODE_501

    public static final int CODE_501

See Also:
  Constant Field Values

### CODE_502

    public static final int CODE_502

See Also:
  Constant Field Values

### CODE_503

    public static final int CODE_503

See Also:
  Constant Field Values

### HELP_TEXT_FOLLOWS

    public static final int HELP_TEXT_FOLLOWS

See Also:
  Constant Field Values

### DEBUG_OUTPUT

    public static final int DEBUG_OUTPUT

See Also:
  Constant Field Values

### SERVER_READY_POSTING_ALLOWED

    public static final int SERVER_READY_POSTING_ALLOWED

See Also:
  Constant Field Values

### SERVER_READY_POSTING_NOT_ALLOWED

    public static final int SERVER_READY_POSTING_NOT_ALLOWED

See Also:
  Constant Field Values

### SLAVE_STATUS_NOTED

    public static final int SLAVE_STATUS_NOTED

See Also:
  Constant Field Values

### CLOSING_CONNECTION

    public static final int CLOSING_CONNECTION

See Also:
  Constant Field Values

### GROUP_SELECTED

    public static final int GROUP_SELECTED

See Also:
  Constant Field Values

### ARTICLE_RETRIEVED_HEAD_AND_BODY_FOLLOW

    public static final int ARTICLE_RETRIEVED_HEAD_AND_BODY_FOLLOW

See Also:
  Constant Field Values

### ARTICLE_RETRIEVED_HEAD_FOLLOWS

    public static final int ARTICLE_RETRIEVED_HEAD_FOLLOWS

See Also:
  Constant Field Values

### ARTICLE_RETRIEVED_BODY_FOLLOWS

    public static final int ARTICLE_RETRIEVED_BODY_FOLLOWS

See Also:
  Constant Field Values

### ARTICLE_RETRIEVED_REQUEST_TEXT_SEPARATELY

    public static final int ARTICLE_RETRIEVED_REQUEST_TEXT_SEPARATELY

See Also:
  Constant Field Values

### ARTICLE_LIST_BY_MESSAGE_ID_FOLLOWS

    public static final int ARTICLE_LIST_BY_MESSAGE_ID_FOLLOWS

See Also:
  Constant Field Values

### NEW_NEWSGROUP_LIST_FOLLOWS

    public static final int NEW_NEWSGROUP_LIST_FOLLOWS

See Also:
  Constant Field Values

### ARTICLE_TRANSFERRED_OK

    public static final int ARTICLE_TRANSFERRED_OK

See Also:
  Constant Field Values

### ARTICLE_POSTED_OK

    public static final int ARTICLE_POSTED_OK

See Also:
  Constant Field Values

### SEND_ARTICLE_TO_TRANSFER

    public static final int SEND_ARTICLE_TO_TRANSFER

See Also:
  Constant Field Values

### SEND_ARTICLE_TO_POST

    public static final int SEND_ARTICLE_TO_POST

See Also:
  Constant Field Values

### SERVICE_DISCONTINUED

    public static final int SERVICE_DISCONTINUED

See Also:
  Constant Field Values

### NO_SUCH_NEWSGROUP

    public static final int NO_SUCH_NEWSGROUP

See Also:
  Constant Field Values

### NO_NEWSGROUP_SELECTED

    public static final int NO_NEWSGROUP_SELECTED

See Also:
  Constant Field Values

### NO_CURRENT_ARTICLE_SELECTED

    public static final int NO_CURRENT_ARTICLE_SELECTED

See Also:
  Constant Field Values

### NO_NEXT_ARTICLE

    public static final int NO_NEXT_ARTICLE

See Also:
  Constant Field Values

### NO_PREVIOUS_ARTICLE

    public static final int NO_PREVIOUS_ARTICLE

See Also:
  Constant Field Values

### NO_SUCH_ARTICLE_NUMBER

    public static final int NO_SUCH_ARTICLE_NUMBER

See Also:
  Constant Field Values

### NO_SUCH_ARTICLE_FOUND

    public static final int NO_SUCH_ARTICLE_FOUND

See Also:
  Constant Field Values

### ARTICLE_NOT_WANTED

    public static final int ARTICLE_NOT_WANTED

See Also:
  Constant Field Values

### TRANSFER_FAILED

    public static final int TRANSFER_FAILED

See Also:
  Constant Field Values

### ARTICLE_REJECTED

    public static final int ARTICLE_REJECTED

See Also:
  Constant Field Values

### POSTING_NOT_ALLOWED

    public static final int POSTING_NOT_ALLOWED

See Also:
  Constant Field Values

### POSTING_FAILED

    public static final int POSTING_FAILED

See Also:
  Constant Field Values

### COMMAND_NOT_RECOGNIZED

    public static final int COMMAND_NOT_RECOGNIZED

See Also:
  Constant Field Values

### COMMAND_SYNTAX_ERROR

    public static final int COMMAND_SYNTAX_ERROR

See Also:
  Constant Field Values

### PERMISSION_DENIED

    public static final int PERMISSION_DENIED

See Also:
  Constant Field Values

### PROGRAM_FAULT

    public static final int PROGRAM_FAULT

See Also:
  Constant Field Values

Method Detail

### isInformational

    public static boolean isInformational(int reply)

  Determine if a reply code is an informational response. All codes beginning with a 1 are positive informational responses. Informational responses are used to provide human readable information such as help text.

  Parameters:
    `reply` - The reply code to test.
  Returns:
    True if a reply code is an informational response, false if not.

### isPositiveCompletion

    public static boolean isPositiveCompletion(int reply)

  Determine 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 positive completion response on the final successful completion of a command.

  Parameters:
    `reply` - The reply code to test.
  Returns:
    True if a reply code is a postive completion response, false if not.

### isPositiveIntermediate

    public static boolean isPositiveIntermediate(int reply)

  Determine if a reply code is a positive intermediate response. All codes beginning with a 3 are positive intermediate responses. The NNTP server will send a positive intermediate response on the successful completion of one part of a multi-part command or sequence of commands. For example, after a successful POST command, a positive intermediate response will be sent to indicate that the server is ready to receive the article to be posted.

  Parameters:
    `reply` - The reply code to test.
  Returns:
    True if a reply code is a postive intermediate response, false if not.

### isNegativeTransient

    public static boolean isNegativeTransient(int reply)

  Determine 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 negative transient response on the failure of a correctly formatted command that could not be performed for some reason. For example, retrieving an article that does not exist will result in a negative transient response.

  Parameters:
    `reply` - The reply code to test.
  Returns:
    True if a reply code is a negative transient response, false if not.

### isNegativePermanent

    public static boolean isNegativePermanent(int reply)

  Determine 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 negative permanent response when it does not implement a command, a command is incorrectly formatted, or a serious program error occurs.

  Parameters:
    `reply` - The reply code to test.
  Returns:
    True if a reply code is a negative permanent response, false if not.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1997-2003 Apache Software Foundation. All Rights Reserved.