org.fossilec.odettej.service
Class EndSessionReason

java.lang.Object
  extended by org.fossilec.odettej.service.EndSessionReason

public final class EndSessionReason
extends java.lang.Object

Enumeration representing each End Session Reason avaiable.

Code table:

          Value: 00 - Normal session termination.
                 01 - Command not recognised.
                 02 - Protocol violation.
                 03 - User code not known.
                 04 - Invalid password.
                 05 - Local site emergency close down.
                 06 - Command contained invalid data.
                 07 - Exchange Buffer size error.
                 08 - Resources not available.
                 09 - Time out.
                 10 - Mode or capabilities incompatible.
                 99 - Unspecified Abort code.
 

Author:
Rafael Marins

Field Summary
static EndSessionReason COMMAND_NOT_RECOGNISED
          Command not recognised.
static EndSessionReason EMERGENCY_CLOSE_DOWN
          Local site emergency close down.
static EndSessionReason EXCHANGE_BUFFER_SIZE_ERROR
          Exchange Buffer size error.
static EndSessionReason INCOMPATIBLE_MODE
          Mode or capabilities are incompatible.
static EndSessionReason INVALID_COMMAND_DATA
          Command contained invalid data.
static EndSessionReason INVALID_PASSWORD
          Invalid password.
static EndSessionReason NORMAL_TERMINATION
          Normal session termination.
static EndSessionReason PROTOCOL_VIOLATION
          Protocol violation.
static EndSessionReason RESOURCES_NOT_AVAIABLE
          Resources not avaiable.
static EndSessionReason TIME_OUT
          Time out.
static EndSessionReason UNKNOWN_USER_CODE
          User code not known.
static EndSessionReason UNSPECIFIED_ABORT
          Unspecified Abort code.
 
Method Summary
 java.lang.String getCode()
          Return the protocol representation of EndSessionReason enum.
static EndSessionReason parse(java.lang.String code)
          Convenient method for parsing the proper TransferMode instance given a identifier character.
static java.util.Collection values()
          Return a collection of the avaiable typed enumerations.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORMAL_TERMINATION

public static final EndSessionReason NORMAL_TERMINATION
Normal session termination.


COMMAND_NOT_RECOGNISED

public static final EndSessionReason COMMAND_NOT_RECOGNISED
Command not recognised.

An Exchange Buffer contains an invalid command identifier (1st octet of the buffer).


PROTOCOL_VIOLATION

public static final EndSessionReason PROTOCOL_VIOLATION
Protocol violation.

An Exchange Buffer contains an invalid command for the current state of the receiver.


UNKNOWN_USER_CODE

public static final EndSessionReason UNKNOWN_USER_CODE
User code not known.

A Start Session (SSID) command contains an unknown or invalid Identification Code.


INVALID_PASSWORD

public static final EndSessionReason INVALID_PASSWORD
Invalid password.

A Start Session (SSID) command contains an invalid password for the specified user identification.


EMERGENCY_CLOSE_DOWN

public static final EndSessionReason EMERGENCY_CLOSE_DOWN
Local site emergency close down.

The local site has entered an emergency close down mode. Communications are being forcibly terminated.


INVALID_COMMAND_DATA

public static final EndSessionReason INVALID_COMMAND_DATA
Command contained invalid data.

A field within a Command Exchange buffer contains invalid data.


EXCHANGE_BUFFER_SIZE_ERROR

public static final EndSessionReason EXCHANGE_BUFFER_SIZE_ERROR
Exchange Buffer size error.

The length of the Exchange Buffer as determined by the Stream Transmission Header is different to the length implied by the Command Code.


RESOURCES_NOT_AVAIABLE

public static final EndSessionReason RESOURCES_NOT_AVAIABLE
Resources not avaiable.

The request for connection has been denied due to a resource shortage. The connection attempt should be retried later.


TIME_OUT

public static final EndSessionReason TIME_OUT
Time out.


INCOMPATIBLE_MODE

public static final EndSessionReason INCOMPATIBLE_MODE
Mode or capabilities are incompatible.


UNSPECIFIED_ABORT

public static final EndSessionReason UNSPECIFIED_ABORT
Unspecified Abort code.

An error was detected for which no specific code is defined.

Method Detail

getCode

public java.lang.String getCode()
Return the protocol representation of EndSessionReason enum.

Returns:
String corresponding protocol code.

parse

public static EndSessionReason parse(java.lang.String code)
Convenient method for parsing the proper TransferMode instance given a identifier character.

Parameters:
code - The transfer mode character being evaluated
Returns:
CommandIdentifier Instance that correspond to the parameter
Throws:
CommandNotRecognisedException - Command not recognised

values

public static java.util.Collection values()
Return a collection of the avaiable typed enumerations.

Returns:


Copyright © 2005 ObjectWeb Consortium. All Rights Reserved.