com.ibm.di.api.local
Interface SystemQueue

All Known Implementing Classes:
SystemQueueImpl

public interface SystemQueue

System Queue interface that defines public methods exposed through Server API local session.


Method Summary
 byte[] getBytesMessage(String aQueueName, int aTimeOut)
          Retrieves a BytesMessage from the specified System Queue
 Entry getEntry(String aQueueName, int aTimeOut)
          Retrieves an Entry object from the specified System Queue
 javax.jms.Message getMessage(String aQueueName, int aTimeOut)
          Retrieves a JMS Message from the specified System Queue
 String getTextMessage(String aQueueName, int aTimeOut)
          Retrieves a TextMessage from the specified System Queue
 void putBytesMessage(String aQueueName, byte[] aMessageBytes)
          Stores a BytesMessage in the specified System Queue
 void putEntry(String aQueueName, Entry aEntry)
          Stores an Entry object to the specified System Queue
 void putMessage(String aQueueName, javax.jms.Message aMessage)
          Stores a Message to the specified System Queue
 void putTextMessage(String aQueueName, String aMessageText)
          Stores a TextMessage to the System Queue
 

Method Detail

getMessage

javax.jms.Message getMessage(String aQueueName,
                             int aTimeOut)
                             throws DIException
Retrieves a JMS Message from the specified System Queue

Parameters:
aQueueName - - the name of the queue from which the message is retrieved
aTimeOut - - specifies the maximum time in seconds to wait for a new message; if 0 is specified - if there is no message available this method returns immediately; if a negative number is specified, this method will wait indefinitely or until a message becomes available
Returns:
the javax.jms.Message object.
Throws:
DIException - if an error occurs during receiving

putMessage

void putMessage(String aQueueName,
                javax.jms.Message aMessage)
                throws DIException
Stores a Message to the specified System Queue

Parameters:
aQueueName - - the name of the queue to which the message is to be stored
aMessage - - the Message object to be stored
Throws:
DIException - if an error occurs during storing

getTextMessage

String getTextMessage(String aQueueName,
                      int aTimeOut)
                      throws DIException
Retrieves a TextMessage from the specified System Queue

Parameters:
aQueueName - - the name of the queue from which the message is retrieved
aTimeOut - - specifies the maximum time in seconds to wait for a new message; if 0 is specified - if there is no message available this method returns immediately; if a negative number is specified, this method will wait indefinitely or until a message becomes available
Returns:
The text of the message
Throws:
DIException - if an error occurs during receiving

putTextMessage

void putTextMessage(String aQueueName,
                    String aMessageText)
                    throws DIException
Stores a TextMessage to the System Queue

Parameters:
aQueueName - - the name of the queue to which the message is to be stored
aMessageText - - the text to be stored
Throws:
DIException - if an error occurs during sending

getBytesMessage

byte[] getBytesMessage(String aQueueName,
                       int aTimeOut)
                       throws DIException
Retrieves a BytesMessage from the specified System Queue

Parameters:
aQueueName - - the name of the queue from which the message is retrieved
aTimeOut - - specifies the maximum time in seconds to wait for a new message; if 0 is specified - if there is no message available this method returns immediately; if a negative number is specified, this method will wait indefinitely or until a message becomes available
Returns:
The bytes of the message in a byte array
Throws:
DIException - if an error occurs during receiving

putBytesMessage

void putBytesMessage(String aQueueName,
                     byte[] aMessageBytes)
                     throws DIException
Stores a BytesMessage in the specified System Queue

Parameters:
aQueueName - - the name of the queue to which the message is to be stored
aMessageBytes - - the byte array to be stored
Throws:
DIException - if an error occurs during sending

getEntry

Entry getEntry(String aQueueName,
               int aTimeOut)
               throws DIException
Retrieves an Entry object from the specified System Queue

Parameters:
aQueueName - - the name of the queue from which the message is retrieved
aTimeOut - - specifies the maximum time in seconds to wait for a new message; if 0 is specified - if there is no message available this method returns immediately; if a negative number is specified, this method will wait indefinitely or until a message becomes available
Returns:
The retrieved com.ibm.di.entry.Entry object
Throws:
DIException - if an error occurs during receiving, or if the message retrieved is not an ObjectMessage or if the ObjectMessage retrieved does not store a com.ibm.di.entry.Entry object

putEntry

void putEntry(String aQueueName,
              Entry aEntry)
              throws DIException
Stores an Entry object to the specified System Queue

Parameters:
aQueueName - - the name of the queue to which the Entry is to be stored
aEntry - - the Entry object to be stored
Throws:
DIException - if an error occurs during sending