com.safmq
Class Safmq

java.lang.Object
  com.safmq.Safmq

public class Safmq
extends java.lang.Object

Defines constants for use in the com.safmq package.

Field Summary

static byte	BT_BINARY Body is binary
static byte	BT_CHAR Body contains a single char (byte)
static byte	BT_LONG Body contains a single "int" integer
static byte	BT_NONE No body typeing.
static byte	BT_SHORT Body contains a single "short" integer
static byte	BT_TEXT Body contains text (single byte characters)
static byte	BT_WTEXT Body contains text (wide characters)
static int	EC_ALREADYCLOSED Resource has already been closed
static int	EC_ALREADYDEFINED Named resource already exists with the same name
static int	EC_ALREADYOPEN
static int	EC_CANNOTCHANGEGROUP User cannot change group permissions
static int	EC_CANNOTCHANGEUSER User cannot change user permissions
static int	EC_CURSORINVALIDATED The cursor has become invalid
static int	EC_DOESNOTEXIST Resource does not exist.
static int	EC_DUPLICATEMSGID The message id supplied is a duplicate of another message ID
static int	EC_ERROR Unknow error has occured.
static int	EC_FILESYSTEMERROR A file system error has occured
static int	EC_FORWARDNOTALLOWED System does not allow message forwarding (relaying)
static int	EC_INVALIDNAME Name supplied is invalid
static int	EC_NETWORKERROR A network error has occured
static int	EC_NOERROR No error occurd.
static int	EC_NOMOREMESSAGES No more messages are available.
static int	EC_NOTAUTHORIZED User not authorized to perform operation.
static int	EC_NOTIMPLEMENTED Request not implemented
static int	EC_NOTLOGGEDIN The user is not logged into the SAFMQ server
static int	EC_NOTOPEN Resource is not currently open.
static int	EC_QUEUEOPEN Could not delete queue, it is currently in use
static int	EC_SERVERUNAVAIL The server is unavilable
static int	EC_TIMEDOUT Operation timed out.
static int	EC_TTLEXPIRED The message's TTL has expired
static int	EC_UNSUPPORTED_PROTOCOL Wrong Protocol Version
static int	EC_WRONGMESSAGETYPE Wronge type for message
static int	MC_SYSTEMERRMSG System generated messages
static int	MC_USERMSG User generated messges (all messages not system generated)
static byte	MP_HIGH Messages with high priority.
static byte	MP_HIGHEST Messages with higest priority.
static byte	MP_LOW Messages with low priority, same as standard priority.
static byte	MP_MEDIUM Messages with medium priority.
static byte	MP_MEDIUMHIGH Messages with medium-high priority.
static byte	MP_MEDIUMLOW Messages with medium-low priority.
static byte	MP_STANDARD Messages with standard priority.
static int	SAFMQ_PROTOCOL_MAJOR_VERSION The Current SAFMQ Protocol Major Version.
static int	SAFMQ_PROTOCOL_MINOR_VERSION The Current SAFMQ Protocol Minor Version.
static int	SIZE_INT The size of an int basic type
static int	SIZE_SHORT The size of a short basic type

Constructor Summary

Safmq()

Method Summary

static java.lang.String	ecDecode(int error)
static java.lang.String	errorDecode(int error) This method provides a textual description of an error code generated by SAFMQ.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SAFMQ_PROTOCOL_MAJOR_VERSION

public static final int SAFMQ_PROTOCOL_MAJOR_VERSION

The Current SAFMQ Protocol Major Version. Note: Major Version will change when a previously established message buffer changes.

See Also:

Constant Field Values

SAFMQ_PROTOCOL_MINOR_VERSION

public static final int SAFMQ_PROTOCOL_MINOR_VERSION

The Current SAFMQ Protocol Minor Version. Note: Minor Version will change when a new message buffer is added.

See Also:

Constant Field Values

SIZE_INT

public static final int SIZE_INT

The size of an int basic type

See Also:

Constant Field Values

SIZE_SHORT

public static final int SIZE_SHORT

The size of a short basic type

See Also:

Constant Field Values

MC_SYSTEMERRMSG

public static final int MC_SYSTEMERRMSG

System generated messages

See Also:

Constant Field Values

MC_USERMSG

public static final int MC_USERMSG

User generated messges (all messages not system generated)

See Also:

Constant Field Values

BT_LONG

public static final byte BT_LONG

Body contains a single "int" integer

See Also:

Constant Field Values

BT_SHORT

public static final byte BT_SHORT

Body contains a single "short" integer

See Also:

Constant Field Values

BT_CHAR

public static final byte BT_CHAR

Body contains a single char (byte)

See Also:

Constant Field Values

BT_TEXT

public static final byte BT_TEXT

Body contains text (single byte characters)

See Also:

Constant Field Values

BT_WTEXT

public static final byte BT_WTEXT

Body contains text (wide characters)

See Also:

Constant Field Values

BT_BINARY

public static final byte BT_BINARY

Body is binary

See Also:

Constant Field Values

BT_NONE

public static final byte BT_NONE

No body typeing.

See Also:

Constant Field Values

MP_STANDARD

public static final byte MP_STANDARD

Messages with standard priority.

See Also:

Constant Field Values

MP_LOW

public static final byte MP_LOW

Messages with low priority, same as standard priority.

See Also:

Constant Field Values

MP_MEDIUMLOW

public static final byte MP_MEDIUMLOW

Messages with medium-low priority.

See Also:

Constant Field Values

MP_MEDIUM

public static final byte MP_MEDIUM

Messages with medium priority.

See Also:

Constant Field Values

MP_MEDIUMHIGH

public static final byte MP_MEDIUMHIGH

Messages with medium-high priority.

See Also:

Constant Field Values

MP_HIGH

public static final byte MP_HIGH

Messages with high priority.

See Also:

Constant Field Values

MP_HIGHEST

public static final byte MP_HIGHEST

Messages with higest priority.

See Also:

Constant Field Values

EC_NOERROR

public static final int EC_NOERROR

No error occurd.

See Also:

Constant Field Values

EC_TIMEDOUT

public static final int EC_TIMEDOUT

Operation timed out.

See Also:

Constant Field Values

EC_NOTAUTHORIZED

public static final int EC_NOTAUTHORIZED

User not authorized to perform operation.

See Also:

Constant Field Values

EC_ALREADYCLOSED

public static final int EC_ALREADYCLOSED

Resource has already been closed

See Also:

Constant Field Values

EC_DOESNOTEXIST

public static final int EC_DOESNOTEXIST

Resource does not exist.

See Also:

Constant Field Values

EC_NOTOPEN

public static final int EC_NOTOPEN

Resource is not currently open.

See Also:

Constant Field Values

EC_NETWORKERROR

public static final int EC_NETWORKERROR

A network error has occured

See Also:

Constant Field Values

EC_TTLEXPIRED

public static final int EC_TTLEXPIRED

The message's TTL has expired

See Also:

Constant Field Values

EC_CURSORINVALIDATED

public static final int EC_CURSORINVALIDATED

The cursor has become invalid

See Also:

Constant Field Values

EC_DUPLICATEMSGID

public static final int EC_DUPLICATEMSGID

The message id supplied is a duplicate of another message ID

See Also:

Constant Field Values

EC_SERVERUNAVAIL

public static final int EC_SERVERUNAVAIL

The server is unavilable

See Also:

Constant Field Values

EC_NOMOREMESSAGES

public static final int EC_NOMOREMESSAGES

No more messages are available.

See Also:

Constant Field Values

EC_FILESYSTEMERROR

public static final int EC_FILESYSTEMERROR

A file system error has occured

See Also:

Constant Field Values

EC_CANNOTCHANGEGROUP

public static final int EC_CANNOTCHANGEGROUP

User cannot change group permissions

See Also:

Constant Field Values

EC_CANNOTCHANGEUSER

public static final int EC_CANNOTCHANGEUSER

User cannot change user permissions

See Also:

Constant Field Values

EC_ALREADYDEFINED

public static final int EC_ALREADYDEFINED

Named resource already exists with the same name

See Also:

Constant Field Values

EC_NOTIMPLEMENTED

public static final int EC_NOTIMPLEMENTED

Request not implemented

See Also:

Constant Field Values

EC_QUEUEOPEN

public static final int EC_QUEUEOPEN

Could not delete queue, it is currently in use

See Also:

Constant Field Values

EC_NOTLOGGEDIN

public static final int EC_NOTLOGGEDIN

The user is not logged into the SAFMQ server

See Also:

Constant Field Values

EC_INVALIDNAME

public static final int EC_INVALIDNAME

Name supplied is invalid

See Also:

Constant Field Values

EC_FORWARDNOTALLOWED

public static final int EC_FORWARDNOTALLOWED

System does not allow message forwarding (relaying)

See Also:

Constant Field Values

EC_WRONGMESSAGETYPE

public static final int EC_WRONGMESSAGETYPE

Wronge type for message

See Also:

Constant Field Values

EC_UNSUPPORTED_PROTOCOL

public static final int EC_UNSUPPORTED_PROTOCOL

Wrong Protocol Version

See Also:

Constant Field Values

EC_ALREADYOPEN

public static final int EC_ALREADYOPEN

See Also:

Constant Field Values

EC_ERROR

public static final int EC_ERROR

Unknow error has occured.

See Also:

Constant Field Values

Constructor Detail

Safmq

public Safmq()

Method Detail

ecDecode

public static java.lang.String ecDecode(int error)

errorDecode

public static final java.lang.String errorDecode(int error)

This method provides a textual description of an error code generated by SAFMQ.

Parameters:

error - The error code retrieved from a call to an MQConnection method

Returns:

A textual description of the error code