org.neociclo.odetteftp.protocol
Enum NegativeResponseReason

java.lang.Object
  extended by java.lang.Enum<NegativeResponseReason>
      extended by org.neociclo.odetteftp.protocol.NegativeResponseReason
All Implemented Interfaces:
Serializable, Comparable<NegativeResponseReason>

public enum NegativeResponseReason
extends Enum<NegativeResponseReason>

The Negative Response Reason will specify why transmission cannot proceed or why processing of the file failed. It's supported since the ODETTE-FTP version 1.4.

In version 2.0 reason codes between 25 to 34 (inclusive) were added.


    Value  '03'  ESID received with reason code '03'
                  (user code not known)
           '04'  ESID received with reason code '04'
                  (invalid password)
           '09'  ESID received with reason code '99'
                  (unspecified reason)
           '11'  SFNA(RETRY=N) received with reason code '01'
                  (invalid file name)
           '12'  SFNA(RETRY=N) received with reason code '02'
                  (invalid destination)
           '13'  SFNA(RETRY=N) received with reason code '03'
                  (invalid origin)
           '14'  SFNA(RETRY=N) received with reason code '04'
                  (invalid storage record format)
           '15'  SFNA(RETRY=N) received with reason code '05'
                  (maximum record length not supported)
           '16'  SFNA(RETRY=N) received with reason code '06'
                  (file size too big)
           '20'  SFNA(RETRY=N) received with reason code '10'
                  (invalid record count)
           '21'  SFNA(RETRY=N) received with reason code '11'
                  (invalid byte count)
           '22'  SFNA(RETRY=N) received with reason code '12'
                  (access method failure)
           '23'  SFNA(RETRY=N) received with reason code '13'
                  (duplicate file)
           '24'  SFNA(RETRY=N) received with reason code '14'
                  (file direction refused)
           '25'  SFNA(RETRY=N) received with reason code '15'
                  (cipher suite not supported)
           '26'  SFNA(RETRY=N) received with reason code '16'
                  (encrypted file not allowed)
           '27'  SFNA(RETRY=N) received with reason code '17'
                  (unencrypted file not allowed)
           '28'  SFNA(RETRY=N) received with reason code '18'
                  (compression not allowed)
           '29'  SFNA(RETRY=N) received with reason code '19'
                  (signed file not allowed)
           '30'  SFNA(RETRY=N) received with reason code '20'
                  (unsigned file not allowed)
           '31'  File signature not valid.
           '32'  File decompression failed.
           '33'  File decryption failed.
           '34'  File processing failed.
           '35'  Not delivered to recipient.
           '36'  Not acknowledged by recipient.
           '50'  Transmission stopped by the operator.
           '90'  File size incompatible with recipient's
                  protocol version.
           '99'  Unspecified reason.
 

Version:
$Rev: 122 $ $Date: 2009-07-22 08:20:41 -0300 (Wed, 22 Jul 2009) $
Author:
Rafael Marins

Enum Constant Summary
ESID_INVALID_PASSWORD
          ESID received with reason code '04' (invalid password)
ESID_UNSPECIFIED_REASON
          ESID received with reason code '99' (unspecified reason)
ESID_USER_NOT_KNOWN
          ESID received with reason code '03' (user code not known)
FILE_DECOMPRESSION_FAILED
          File decompression failed.
FILE_DECRYPTION_FAILED
          File decryption failed.
FILE_PROCESSING_FAILED
          File processing failed.
INCOMPATIBLE_FILE_SIZE
          File size incompatible with recipient's protocol version.
INVALID_FILE_SIGNATURE
          File signature not valid.
NOT_ACKNOWLEDGED
          Not acknowledged by recipient.
NOT_DELIVERED
          Not delivered to recipient.
SFNA_ACCESS_METHOD_FAILURE
          SFNA(RETRY=N) received with reason code '12' (access method failure)
SFNA_CIPHER_NOT_SUPPORTED
          SFNA(RETRY=N) received with reason code '15' (cipher suite not supported)
SFNA_COMPRESSION_NOT_ALLOWED
          SFNA(RETRY=N) received with reason code '18' (compression not allowed)
SFNA_DUPLICATE_FILE
          SFNA(RETRY=N) received with reason code '13' (duplicate file)
SFNA_ENCRYPTED_FILE_NOT_ALLOWED
          SFNA(RETRY=N) received with reason code '16' (encrypted file not allowed)
SFNA_FILE_DIRECTION_REFUSED
          SFNA(RETRY=N) received with reason code '14' (file direction refused)
SFNA_FILE_SIZE_EXCEED
          SFNA(RETRY=N) received with reason code '06' (file size too big)
SFNA_INVALID_BYTE_COUNT
          SFNA(RETRY=N) received with reason code '11' (invalid byte count)
SFNA_INVALID_DESTINATION
          SFNA(RETRY=N) received with reason code '02' (invalid destination)
SFNA_INVALID_FILE_NAME
          SFNA(RETRY=N) received with reason code '01' (invalid file name)
SFNA_INVALID_ORIGIN
          SFNA(RETRY=N) received with reason code '03' (invalid origin)
SFNA_INVALID_RECORD_COUNT
          SFNA(RETRY=N) received with reason code '10' (invalid record count)
SFNA_SIGNED_FILE_NOT_ALLOWED
          SFNA(RETRY=N) received with reason code '19' (signed file not allowed)
SFNA_UNENCRYPTED_FILE_NOT_ALLOWED
          SFNA(RETRY=N) received with reason code '17' (unencrypted file not allowed)
SFNA_UNSIGNED_FILE_NOT_ALLOWED
          SFNA(RETRY=N) received with reason code '20' (unsigned file not allowed)
SFNA_UNSUPPORTED_MAXIMUM_RECORD_LENGTH
          SFNA(RETRY=N) received with reason code '05' (maximum record length not supported)
SFNA_UNSUPPORTED_STORAGE_RECORD_FORMAT
          SFNA(RETRY=N) received with reason code '04' (invalid storage record format)
TRANSMISSION_STOPPED
          Transmission stopped by the operator.
UNSPECIFIED_REASON
          Unspecified reason.
 
Method Summary
 String getCode()
          Return the protocol representation of NegativeResponseReason enum.
static NegativeResponseReason parse(String code)
          Convenient method for parsing the proper NegativeResponseReason enum given a identifier character.
static NegativeResponseReason valueOf(String name)
          Returns the enum constant of this type with the specified name.
static NegativeResponseReason[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ESID_INVALID_PASSWORD

public static final NegativeResponseReason ESID_INVALID_PASSWORD
ESID received with reason code '04' (invalid password)


ESID_UNSPECIFIED_REASON

public static final NegativeResponseReason ESID_UNSPECIFIED_REASON
ESID received with reason code '99' (unspecified reason)


ESID_USER_NOT_KNOWN

public static final NegativeResponseReason ESID_USER_NOT_KNOWN
ESID received with reason code '03' (user code not known)


INCOMPATIBLE_FILE_SIZE

public static final NegativeResponseReason INCOMPATIBLE_FILE_SIZE
File size incompatible with recipient's protocol version.


NOT_ACKNOWLEDGED

public static final NegativeResponseReason NOT_ACKNOWLEDGED
Not acknowledged by recipient.


NOT_DELIVERED

public static final NegativeResponseReason NOT_DELIVERED
Not delivered to recipient.


SFNA_ACCESS_METHOD_FAILURE

public static final NegativeResponseReason SFNA_ACCESS_METHOD_FAILURE
SFNA(RETRY=N) received with reason code '12' (access method failure)


SFNA_DUPLICATE_FILE

public static final NegativeResponseReason SFNA_DUPLICATE_FILE
SFNA(RETRY=N) received with reason code '13' (duplicate file)


SFNA_FILE_DIRECTION_REFUSED

public static final NegativeResponseReason SFNA_FILE_DIRECTION_REFUSED
SFNA(RETRY=N) received with reason code '14' (file direction refused)


SFNA_FILE_SIZE_EXCEED

public static final NegativeResponseReason SFNA_FILE_SIZE_EXCEED
SFNA(RETRY=N) received with reason code '06' (file size too big)


SFNA_INVALID_BYTE_COUNT

public static final NegativeResponseReason SFNA_INVALID_BYTE_COUNT
SFNA(RETRY=N) received with reason code '11' (invalid byte count)


SFNA_INVALID_DESTINATION

public static final NegativeResponseReason SFNA_INVALID_DESTINATION
SFNA(RETRY=N) received with reason code '02' (invalid destination)


SFNA_INVALID_FILE_NAME

public static final NegativeResponseReason SFNA_INVALID_FILE_NAME
SFNA(RETRY=N) received with reason code '01' (invalid file name)


SFNA_INVALID_ORIGIN

public static final NegativeResponseReason SFNA_INVALID_ORIGIN
SFNA(RETRY=N) received with reason code '03' (invalid origin)


SFNA_CIPHER_NOT_SUPPORTED

public static final NegativeResponseReason SFNA_CIPHER_NOT_SUPPORTED
SFNA(RETRY=N) received with reason code '15' (cipher suite not supported)


SFNA_ENCRYPTED_FILE_NOT_ALLOWED

public static final NegativeResponseReason SFNA_ENCRYPTED_FILE_NOT_ALLOWED
SFNA(RETRY=N) received with reason code '16' (encrypted file not allowed)


SFNA_UNENCRYPTED_FILE_NOT_ALLOWED

public static final NegativeResponseReason SFNA_UNENCRYPTED_FILE_NOT_ALLOWED
SFNA(RETRY=N) received with reason code '17' (unencrypted file not allowed)


SFNA_COMPRESSION_NOT_ALLOWED

public static final NegativeResponseReason SFNA_COMPRESSION_NOT_ALLOWED
SFNA(RETRY=N) received with reason code '18' (compression not allowed)


SFNA_SIGNED_FILE_NOT_ALLOWED

public static final NegativeResponseReason SFNA_SIGNED_FILE_NOT_ALLOWED
SFNA(RETRY=N) received with reason code '19' (signed file not allowed)


SFNA_UNSIGNED_FILE_NOT_ALLOWED

public static final NegativeResponseReason SFNA_UNSIGNED_FILE_NOT_ALLOWED
SFNA(RETRY=N) received with reason code '20' (unsigned file not allowed)


INVALID_FILE_SIGNATURE

public static final NegativeResponseReason INVALID_FILE_SIGNATURE
File signature not valid.


FILE_DECOMPRESSION_FAILED

public static final NegativeResponseReason FILE_DECOMPRESSION_FAILED
File decompression failed.


FILE_DECRYPTION_FAILED

public static final NegativeResponseReason FILE_DECRYPTION_FAILED
File decryption failed.


FILE_PROCESSING_FAILED

public static final NegativeResponseReason FILE_PROCESSING_FAILED
File processing failed.


SFNA_INVALID_RECORD_COUNT

public static final NegativeResponseReason SFNA_INVALID_RECORD_COUNT
SFNA(RETRY=N) received with reason code '10' (invalid record count)


SFNA_UNSUPPORTED_MAXIMUM_RECORD_LENGTH

public static final NegativeResponseReason SFNA_UNSUPPORTED_MAXIMUM_RECORD_LENGTH
SFNA(RETRY=N) received with reason code '05' (maximum record length not supported)


SFNA_UNSUPPORTED_STORAGE_RECORD_FORMAT

public static final NegativeResponseReason SFNA_UNSUPPORTED_STORAGE_RECORD_FORMAT
SFNA(RETRY=N) received with reason code '04' (invalid storage record format)


TRANSMISSION_STOPPED

public static final NegativeResponseReason TRANSMISSION_STOPPED
Transmission stopped by the operator.


UNSPECIFIED_REASON

public static final NegativeResponseReason UNSPECIFIED_REASON
Unspecified reason.

Method Detail

values

public static NegativeResponseReason[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (NegativeResponseReason c : NegativeResponseReason.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static NegativeResponseReason valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

parse

public static NegativeResponseReason parse(String code)
                                    throws OdetteFtpException
Convenient method for parsing the proper NegativeResponseReason enum given a identifier character.

Parameters:
code - The transfer mode character being evaluated
Returns:
NegativeResponseReason enum that correspond to the given code.
Throws:
OdetteFtpException
CommandNotRecognisedException - Code not recognized

getCode

public String getCode()
Return the protocol representation of NegativeResponseReason enum.

Returns:
String corresponding protocol code.


ACCORD