A B C D E G M O P Q R S T U W X

A

ActorPermissions - Class in com.safmq
This mutable object represents an Actor's Permissions when interacting with SAFMQ.
ActorPermissions() - Constructor for class com.safmq.ActorPermissions
Constructs the ActorPermissions object.
address - Variable in class com.safmq.ClientInfo
Client end point IP address
AddUserIdentity(String, String, String) - Method in class com.safmq.MQConnection
Adds an X509 digitital certificate identity mapping.
AdvanceCursor(CursorHandle) - Method in class com.safmq.MessageQueue
Advances the cursor to the next message in the queue.
AdvanceCursor(QueueHandle, CursorHandle) - Method in class com.safmq.MQConnection
Advances the cursor to the next message in the queue.

B

BeginTransaction() - Method in class com.safmq.MQConnection
Begins a transaction which causes all Retrieve & Enqueue operations to be committed atomically.
BT_BINARY - Static variable in class com.safmq.Safmq
Body is binary
BT_CHAR - Static variable in class com.safmq.Safmq
Body contains a single char (byte)
BT_LONG - Static variable in class com.safmq.Safmq
Body contains a single "int" integer
BT_NONE - Static variable in class com.safmq.Safmq
No body typeing.
BT_SHORT - Static variable in class com.safmq.Safmq
Body contains a single "short" integer
BT_TEXT - Static variable in class com.safmq.Safmq
Body contains text (single byte characters)
BT_WTEXT - Static variable in class com.safmq.Safmq
Body contains text (wide characters)
buildConnection(URI, String, String) - Static method in class com.safmq.MQBuilder
Constructs a MQConnection connection object connected to a SAFMQ server.
buildConnection(URI, String, String, SSLContext) - Static method in class com.safmq.MQBuilder
Constructs a MQConnection connection object connected to a SAFMQ server.
buildMessageQueue(URI, String, String) - Static method in class com.safmq.MQBuilder
Constructs a new MQConnection connection object and then a MessageQueue to wrap it.
buildMessageQueue(URI, String, String, SSLContext) - Static method in class com.safmq.MQBuilder
Constructs a new MQConnection connection object and then a MessageQueue to wrap it.

C

ClientInfo - Class in com.safmq
Details about a client connection
ClientInfo() - Constructor for class com.safmq.ClientInfo
 
clone() - Method in class com.safmq.UUID
Makes a clone copy of this object
Close() - Method in class com.safmq.MessageQueue
Closes the connection to the queue.
Close() - Method in class com.safmq.MQConnection
Closes the connection to the server.
CloseCursor(CursorHandle) - Method in class com.safmq.MessageQueue
Closes a cursor when it is no longer needed to access the queue.
CloseCursor(QueueHandle, CursorHandle) - Method in class com.safmq.MQConnection
Closes a cursor when it is no longer needed to access the queue.
CloseQueue(QueueHandle) - Method in class com.safmq.MQConnection
Closes a queue which was previously opened.
com.safmq - package com.safmq
This package contains objects for communicating with the SAFMQ message queue server.
CommitTransaction() - Method in class com.safmq.MQConnection
Commits a group of Retrieve & Enqueue operations atomically.
CreateGroup(String) - Method in class com.safmq.MQConnection
Creates a new security group on the SAFMQ server.
CreateQueue(String) - Method in class com.safmq.MQConnection
Creates a new queue on the SAFMQ server.
CreateTempQueue(String[], QueueHandle) - Method in class com.safmq.MQConnection
Creates a new temporary message queue.
CreateUser(String, String, String) - Method in class com.safmq.MQConnection
Create a new user by providing a user name, password and description.
CursorHandle - Class in com.safmq
This mutable object represents a handle to a cursor.
CursorHandle() - Constructor for class com.safmq.CursorHandle
Public constructor for the cursor handle.

D

d1 - Variable in class com.safmq.UUID
 
d2 - Variable in class com.safmq.UUID
 
d3 - Variable in class com.safmq.UUID
 
d4 - Variable in class com.safmq.UUID
 
DEF_PORT - Static variable in class com.safmq.MQBuilder
The number of the default port for SAFMQ servers.
DEF_SSL_PORT - Static variable in class com.safmq.MQBuilder
 
DeleteGroup(String) - Method in class com.safmq.MQConnection
Removes the security group from the SAFMQ server.
DeleteQueue(String) - Method in class com.safmq.MQConnection
Attempts to remove a queue fromt he SAFMQ server.
DeleteUser(String) - Method in class com.safmq.MQConnection
Delete a user from the SAFMQ server.

E

EC_ALREADYCLOSED - Static variable in class com.safmq.Safmq
Resource has already been closed
EC_ALREADYDEFINED - Static variable in class com.safmq.Safmq
Named resource already exists with the same name
EC_ALREADYOPEN - Static variable in class com.safmq.Safmq
 
EC_CANNOTCHANGEGROUP - Static variable in class com.safmq.Safmq
User cannot change group permissions
EC_CANNOTCHANGEUSER - Static variable in class com.safmq.Safmq
User cannot change user permissions
EC_CURSORINVALIDATED - Static variable in class com.safmq.Safmq
The cursor has become invalid
EC_DOESNOTEXIST - Static variable in class com.safmq.Safmq
Resource does not exist.
EC_DUPLICATEMSGID - Static variable in class com.safmq.Safmq
The message id supplied is a duplicate of another message ID
EC_ERROR - Static variable in class com.safmq.Safmq
Unknow error has occured.
EC_FILESYSTEMERROR - Static variable in class com.safmq.Safmq
A file system error has occured
EC_FORWARDNOTALLOWED - Static variable in class com.safmq.Safmq
System does not allow message forwarding (relaying)
EC_INVALIDNAME - Static variable in class com.safmq.Safmq
Name supplied is invalid
EC_NETWORKERROR - Static variable in class com.safmq.Safmq
A network error has occured
EC_NOERROR - Static variable in class com.safmq.Safmq
No error occurd.
EC_NOMOREMESSAGES - Static variable in class com.safmq.Safmq
No more messages are available.
EC_NOTAUTHORIZED - Static variable in class com.safmq.Safmq
User not authorized to perform operation.
EC_NOTIMPLEMENTED - Static variable in class com.safmq.Safmq
Request not implemented
EC_NOTLOGGEDIN - Static variable in class com.safmq.Safmq
The user is not logged into the SAFMQ server
EC_NOTOPEN - Static variable in class com.safmq.Safmq
Resource is not currently open.
EC_QUEUEOPEN - Static variable in class com.safmq.Safmq
Could not delete queue, it is currently in use
EC_SERVERUNAVAIL - Static variable in class com.safmq.Safmq
The server is unavilable
EC_TIMEDOUT - Static variable in class com.safmq.Safmq
Operation timed out.
EC_TTLEXPIRED - Static variable in class com.safmq.Safmq
The message's TTL has expired
EC_UNSUPPORTED_PROTOCOL - Static variable in class com.safmq.Safmq
Wrong Protocol Version
EC_WRONGMESSAGETYPE - Static variable in class com.safmq.Safmq
Wronge type for message
ecDecode(int) - Static method in class com.safmq.Safmq
 
EndTransaction() - Method in class com.safmq.MQConnection
Commits and closes a group of Retrieve & Enqueue operations.
Enqueue(QueueMessage) - Method in class com.safmq.MessageQueue
Places a message on the queue.
Enqueue(QueueHandle, QueueMessage) - Method in class com.safmq.MQConnection
Places a message on the queue.
enqueued10second - Variable in class com.safmq.QueueStatistics
Number of messages enqueued in the last 10 seconds
enqueued300second - Variable in class com.safmq.QueueStatistics
Number of messages enqueued in the last 300 seconds
enqueued60second - Variable in class com.safmq.QueueStatistics
Number of messages enqueued in the last 60 seconds
EnqueueWithRelay(URI, QueueMessage) - Method in class com.safmq.MQConnection
Enqueues a message for message relay forwarding to another queue/queue server.
EnumerateGroups(Vector) - Method in class com.safmq.MQConnection
Retrieves a list of all groups available on the SAFMQ server.
EnumerateQueues(Vector) - Method in class com.safmq.MQConnection
Retrieves a list of all queues served by the connection and the queue's owner.
EnumerateUserIdentities(String, Vector) - Method in class com.safmq.MQConnection
Lists a set of X509 subject name and issuer names associated with the passed SAFMQ user login id.
EnumerateUsers(Vector) - Method in class com.safmq.MQConnection
Retrieves a list of users which may access the SAFMQ server.
equals(Object) - Method in class com.safmq.MQConnection.UserDescription
 
equals(Object) - Method in class com.safmq.UUID
Compares this instance of UUID to another object.
equals(Object) - Method in class com.safmq.X509Identity
 
errorDecode(int) - Static method in class com.safmq.Safmq
This method provides a textual description of an error code generated by SAFMQ.

G

genDesc(String, String) - Method in class com.safmq.MQConnection
For external use of UserDescriptions.
getBodySize() - Method in class com.safmq.QueueMessage
Provides access to the size of the message body.
getBodyType() - Method in class com.safmq.QueueMessage
The body type as set by the member setBodyType.
getBufferSize() - Method in class com.safmq.QueueMessage
Provides the size of the buffer allocated.
getChangeSecurity() - Method in class com.safmq.MQConnection.QueuePermissions
Provides a flag whether the entity is allowed to change the security for the queue.
getConnection() - Method in class com.safmq.MessageQueue
 
getDescription() - Method in class com.safmq.MQConnection.UserDescription
Provides the description of the user
getDestroy() - Method in class com.safmq.MQConnection.QueuePermissions
Provides the flag whether this entity may remove the queue from the server.
getEntityName() - Method in class com.safmq.MQConnection.QueuePermissions
Provides the name of the entity these permissions pertain to.
getErrorcode() - Method in exception com.safmq.MQException
Provides the error code associated with the exception.
getInputStream() - Method in class com.safmq.QueueMessage
Provides an input stream to read the data in the message's body.
getIsGroup() - Method in class com.safmq.MQConnection.QueuePermissions
Provides a flag whether this entity is a group.
getIssuerDN() - Method in class com.safmq.X509Identity
Provides the Issuer DN
getLabel() - Method in class com.safmq.QueueMessage
Provides the label of the message.
getMessageClass() - Method in class com.safmq.QueueMessage
Provides the message class
getMessageID() - Method in class com.safmq.QueueMessage
Provides access to the message id, this value is generated by a successful call to MQConnection.Enqueue(QueueHandle,QueueMessage).
getMessagePriority() - Method in class com.safmq.QueueMessage
Provides the message's priority
getModifygroups() - Method in class com.safmq.ActorPermissions
 
getModifyqueues() - Method in class com.safmq.ActorPermissions
 
getModifyusers() - Method in class com.safmq.ActorPermissions
 
getName() - Method in class com.safmq.MQConnection.QueueData
Provides the queue's name.
getName() - Method in class com.safmq.MQConnection.UserDescription
Provides the name of the user
getOutputStream() - Method in class com.safmq.QueueMessage
Provides an output stream to write data into the QueueMessage message body.
getOwner() - Method in class com.safmq.MQConnection.QueueData
Provides the queue's owner's name.
GetQueueStatistics(boolean, boolean, QueueStatistics) - Method in class com.safmq.MessageQueue
Gets statistics about an open queue.
GetQueueStatistics(QueueHandle, boolean, boolean, QueueStatistics) - Method in class com.safmq.MQConnection
Gets statistics about an open queue.
getRead() - Method in class com.safmq.MQConnection.QueuePermissions
Provides a flag whether this entity is allowed to read from the queue.
getReciptID() - Method in class com.safmq.QueueMessage
Provides the recipt id of this message
getResponseQueueName() - Method in class com.safmq.QueueMessage
Provides the response queue name for this message
GetServerMajorProtocolVersion() - Method in class com.safmq.MQConnection
 
GetServerMinorProtocolVersion() - Method in class com.safmq.MQConnection
 
GetServerStatistics(QueueStatistics) - Method in class com.safmq.MQConnection
Gets statistics for an entire server.
getSubjectDN() - Method in class com.safmq.X509Identity
Provides the Subject DN
getTimeStamp() - Method in class com.safmq.QueueMessage
Provides the timestamp for this message.
getTimeToLiveSeconds() - Method in class com.safmq.QueueMessage
Provides the time to live in seconds for this message.
getTTLErrorWanted() - Method in class com.safmq.QueueMessage
Provids the flag indicating this message desires auto generated TTL messages.
getWrite() - Method in class com.safmq.MQConnection.QueuePermissions
Provides a flag whether this entity is allowed to write to the queue.
GroupAddUser(String, String) - Method in class com.safmq.MQConnection
Adds a user to a group.
GroupDeleteUser(String, String) - Method in class com.safmq.MQConnection
Deletes a user from a group.
GroupGetPermissions(String, ActorPermissions) - Method in class com.safmq.MQConnection
Retrieves the permissions of a specific group.
GroupGetUsers(String, Vector) - Method in class com.safmq.MQConnection
Retrieves a the list of users in a group.
GroupSetPermissions(String, boolean, boolean, boolean) - Method in class com.safmq.MQConnection
Changes the permissions for the specified group.

M

MC_SYSTEMERRMSG - Static variable in class com.safmq.Safmq
System generated messages
MC_USERMSG - Static variable in class com.safmq.Safmq
User generated messges (all messages not system generated)
messageBytes - Variable in class com.safmq.QueueStatistics
Number of bytes in the queue, does not included purged messages
messageCount - Variable in class com.safmq.QueueStatistics
Number of messages in a queue
MessageQueue - Class in com.safmq
This class represents a SAFMQ message queue by providing a facade in front of the MQConnection.
MessageQueue(String, MQConnection) - Constructor for class com.safmq.MessageQueue
Constructs the MessageQueue object, from the queue's name and a connection to the queue server.
MessageQueue(MQConnection, QueueHandle) - Constructor for class com.safmq.MessageQueue
Constructs the MessageQueue object, from an open handle to a message queue.
MP_HIGH - Static variable in class com.safmq.Safmq
Messages with high priority.
MP_HIGHEST - Static variable in class com.safmq.Safmq
Messages with higest priority.
MP_LOW - Static variable in class com.safmq.Safmq
Messages with low priority, same as standard priority.
MP_MEDIUM - Static variable in class com.safmq.Safmq
Messages with medium priority.
MP_MEDIUMHIGH - Static variable in class com.safmq.Safmq
Messages with medium-high priority.
MP_MEDIUMLOW - Static variable in class com.safmq.Safmq
Messages with medium-low priority.
MP_STANDARD - Static variable in class com.safmq.Safmq
Messages with standard priority.
MQBuilder - Class in com.safmq
A static builder class which builds connections to SAFMQ servers and message queues.
MQBuilder() - Constructor for class com.safmq.MQBuilder
 
MQConnection - Class in com.safmq
This class provides an interface to communicate with a SAFMQ message queue server.
MQConnection(Socket, String, String) - Constructor for class com.safmq.MQConnection
Constructs the object from the name of the server, the tcp/ip port to be used the user's name and password.
MQConnection.QueueData - Class in com.safmq
Result data from a call to MQConnection.EnumerateQueues(Vector).
MQConnection.QueuePermissions - Class in com.safmq
Contains an entity's permission when accessing a queue.
MQConnection.UserDescription - Class in com.safmq
Result data from a call to MQConnection.EnumerateUsers(Vector).
MQException - Exception in com.safmq
Exception thrown in cases where the SAFMQ queue server has responded with an error code from within a constructor.
MQException(String, int) - Constructor for exception com.safmq.MQException
Constructs the MQException from a description message and error code.

O

OpenCursor(CursorHandle) - Method in class com.safmq.MessageQueue
Opens a cursor for sequential reading of the queue.
OpenCursor(QueueHandle, CursorHandle) - Method in class com.safmq.MQConnection
Opens a cursor for sequential reading of the queue.
OpenQueue(String, QueueHandle) - Method in class com.safmq.MQConnection
Opens a queue for reading and writing.

P

PeekCursor(boolean, CursorHandle, QueueMessage) - Method in class com.safmq.MessageQueue
Retrieves the message pointed to by cursorID.
PeekCursor(QueueHandle, boolean, CursorHandle, QueueMessage) - Method in class com.safmq.MQConnection
Retrieves the message pointed to by cursorID.
peeked10second - Variable in class com.safmq.QueueStatistics
Number of messages "peeked" in the last 10 seconds
peeked300second - Variable in class com.safmq.QueueStatistics
Number of messages "peeked" in the last 300 seconds
peeked60second - Variable in class com.safmq.QueueStatistics
Number of messages "peeked" in the last 60 seconds
PeekFront(boolean, int, QueueMessage) - Method in class com.safmq.MessageQueue
Gathers the highest priority FIFO message present on the queue.
PeekFront(QueueHandle, boolean, int, QueueMessage) - Method in class com.safmq.MQConnection
Gathers the highest priority FIFO message present on the queue.
PeekID(boolean, UUID, int, QueueMessage) - Method in class com.safmq.MessageQueue
Gathers the message identified by id in the message's receipt id, set prior to the message having been enqueued (See: Enqueue(QueueMessage).
PeekID(QueueHandle, boolean, UUID, int, QueueMessage) - Method in class com.safmq.MQConnection
Gathers the message identified by id in the message's receipt id, set prior to the message having been enqueued (See: Enqueue(QueueMessage).
port - Variable in class com.safmq.ClientInfo
Client end point Port

Q

QueueDeleteGroupPermission(String, String) - Method in class com.safmq.MQConnection
Removes permissions for a specified group.
QueueDeleteUserPermission(String, String) - Method in class com.safmq.MQConnection
Removes permissions for a specified user.
QueueEnumeratePermissions(String, Vector) - Method in class com.safmq.MQConnection
Retrieves the permission profile for the specified queue.
QueueHandle - Class in com.safmq
Represents a reference to s SAFMQ queue via the MQConnection class.
QueueHandle() - Constructor for class com.safmq.QueueHandle
 
QueueMessage - Class in com.safmq
Represents a message to be sent or retrieved from a SAFMQ message queue server.
QueueMessage() - Constructor for class com.safmq.QueueMessage
Default Constructor.
QueueSetGroupPermission(String, String, boolean, boolean, boolean, boolean) - Method in class com.safmq.MQConnection
Attempts to set the security profile for a specified group.
QueueSetUserPermission(String, String, boolean, boolean, boolean, boolean) - Method in class com.safmq.MQConnection
Attempts to set the security profile for a specified user.
QueueStatistics - Class in com.safmq
Set of queue performance statistics.
QueueStatistics() - Constructor for class com.safmq.QueueStatistics
 

R

read(DataInput) - Method in class com.safmq.UUID
Reads the UUID from the DataInput.
RemoveUerIdentity(String, String) - Method in class com.safmq.MQConnection
Removes an X509 digitital certificate identity mapping.
resetBody() - Method in class com.safmq.QueueMessage
Resets the contents of the body.
Retrieve(boolean, int, QueueMessage) - Method in class com.safmq.MessageQueue
Retrieves the highest priority FIFO message present on the queue.
Retrieve(QueueHandle, boolean, int, QueueMessage) - Method in class com.safmq.MQConnection
Retrieves the highest priority FIFO message present on the queue.
RetrieveCursor(boolean, CursorHandle, QueueMessage) - Method in class com.safmq.MessageQueue
Retrieves the message pointed to by cursorID.
RetrieveCursor(QueueHandle, boolean, CursorHandle, QueueMessage) - Method in class com.safmq.MQConnection
Retrieves the message pointed to by cursorID.
retrieved10second - Variable in class com.safmq.QueueStatistics
Number of messages retrieved in the last 10 seconds
retrieved300second - Variable in class com.safmq.QueueStatistics
Number of messages retrieved in the last 300 seconds
retrieved60second - Variable in class com.safmq.QueueStatistics
Number of messages retrieved in the last 60 seconds
RetrieveID(boolean, UUID, int, QueueMessage) - Method in class com.safmq.MessageQueue
Retrieves the message identified by id in the message's receipt id, set prior to the message having been enqueued (See: Enqueue(QueueMessage).
RetrieveID(QueueHandle, boolean, UUID, int, QueueMessage) - Method in class com.safmq.MQConnection
Retrieves the message identified by id in the message's receipt id, set prior to the message having been enqueued (See: Enqueue(QueueMessage).
RollbackTransaction() - Method in class com.safmq.MQConnection
Rolls back or "undoes" a group of Retrieve & Enqueue operations atomically.

S

Safmq - Class in com.safmq
Defines constants for use in the com.safmq package.
Safmq() - Constructor for class com.safmq.Safmq
 
SAFMQ_PROTO - Static variable in class com.safmq.MQBuilder
 
SAFMQ_PROTOCOL_MAJOR_VERSION - Static variable in class com.safmq.Safmq
The Current SAFMQ Protocol Major Version.
SAFMQ_PROTOCOL_MINOR_VERSION - Static variable in class com.safmq.Safmq
The Current SAFMQ Protocol Minor Version.
SAFMQ_SSL_PROTO - Static variable in class com.safmq.MQBuilder
 
SeekID(UUID, int, CursorHandle) - Method in class com.safmq.MessageQueue
Attempts to locate the messaged indicated by id.
SeekID(QueueHandle, UUID, int, CursorHandle) - Method in class com.safmq.MQConnection
Attempts to locate the messaged indicated by id.
setBodyType(byte) - Method in class com.safmq.QueueMessage
Sets the message's body type.
setIssuerDN(String) - Method in class com.safmq.X509Identity
Sets the issuer DN
setLabel(String) - Method in class com.safmq.QueueMessage
Sets the label of the message.
setMessagePriority(byte) - Method in class com.safmq.QueueMessage
Sets the priority of the message.
setModifygroups(boolean) - Method in class com.safmq.ActorPermissions
 
setModifyqueues(boolean) - Method in class com.safmq.ActorPermissions
 
setModifyusers(boolean) - Method in class com.safmq.ActorPermissions
 
SetPassword(String, String) - Method in class com.safmq.MQConnection
Changes the password for the specified user.
setReciptID(UUID) - Method in class com.safmq.QueueMessage
Sets the recipt id of this message
setResponseQueueName(String) - Method in class com.safmq.QueueMessage
Sets the response queue name of this message
setSSLContext(SSLContext) - Static method in class com.safmq.MQBuilder
Sets the SSLContext object for use in SSL communications.
setSubjectDN(String) - Method in class com.safmq.X509Identity
Sets the Subject DN
setTimeStamp(long) - Method in class com.safmq.QueueMessage
Sets the timestamp for this message.
setTimeToLiveSeconds(int) - Method in class com.safmq.QueueMessage
Sets the time to live in seconds for this message
setTTLErrorWanted(boolean) - Method in class com.safmq.QueueMessage
Sets the flag indicating the auto generated TTL error message is wanted.
SIZE_INT - Static variable in class com.safmq.Safmq
The size of an int basic type
SIZE_SHORT - Static variable in class com.safmq.Safmq
The size of a short basic type
storageBytes - Variable in class com.safmq.QueueStatistics
Number of bytes on disk, includes purged messages still on disk

T

TestCursor(CursorHandle) - Method in class com.safmq.MessageQueue
Determines whether the cursor indicated by cursorID is still a valid cursor, and has not been invalidated by other queue readers.
TestCursor(QueueHandle, CursorHandle) - Method in class com.safmq.MQConnection
Determines whether the cursor indicated by cursorID is still a valid cursor, and has not been invalidated by other queue readers.
toString() - Method in class com.safmq.MQConnection.UserDescription
 
toString() - Method in class com.safmq.UUID
Prepares a string representation of this instance of UUID.

U

UserGetGroups(String, Vector) - Method in class com.safmq.MQConnection
Retrieves a the list of groups the in which the user resides.
UserGetPermissions(String, ActorPermissions) - Method in class com.safmq.MQConnection
Retrieve the permissions for a specific user.
username - Variable in class com.safmq.ClientInfo
User Name for the client connection
UserSetPermissions(String, boolean, boolean, boolean) - Method in class com.safmq.MQConnection
Change the user's permissions to those specified.
UUID - Class in com.safmq
An object to represent a universally unique identifier (UUID).
UUID() - Constructor for class com.safmq.UUID
Default Constructor
UUID(int, short, short, byte[]) - Constructor for class com.safmq.UUID
Constructs the UUID from the passed values
UUID(String) - Constructor for class com.safmq.UUID
Constructs from the String representation of a UUID.

W

write(DataOutput) - Method in class com.safmq.UUID
Writes the UUID to a DataOutput object.

X

X509Identity - Class in com.safmq
Represents an identity presented by an X509 Digital Certificate
X509Identity(String, String) - Constructor for class com.safmq.X509Identity
Constructs the identity from a subject distinguished name and and issuer distinguished name.

A B C D E G M O P Q R S T U W X
Copyright Matthew J. Battey, 2004-2010;
Powered By: Get SAFMQ: Store and Forward Message Queue at SourceForge.net. Fast, secure and Free Open Source software downloads