Package com.ibm.di.api.remote

Interface SystemQueue

  • All Superinterfaces:
    java.rmi.Remote
    All Known Implementing Classes:
    SystemQueueImpl
    public interface SystemQueue
extends java.rmi.Remote
    System Queue inteface that defines public methods exposed through Server API remote session.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] getBytesMessage​(java.lang.String aQueueName, int aTimeOut)
      Retrieves a BytesMessage from the specified System Queue
      Entry getEntry​(java.lang.String aQueueName, int aTimeOut)
      Retrieves an Entry object from the specified System Queue
      javax.jms.Message getMessage​(java.lang.String aQueueName, int aTimeOut)
      Retrieves a JMS Message from the specified System Queue
      java.lang.String getTextMessage​(java.lang.String aQueueName, int aTimeOut)
      Retrieves a TextMessage from the specified System Queue
      void putBytesMessage​(java.lang.String aQueueName, byte[] aMessageBytes)
      Stores a BytesMessage in the specified System Queue
      void putEntry​(java.lang.String aQueueName, Entry aEntry)
      Stores an Entry object to the specified System Queue
      void putMessage​(java.lang.String aQueueName, javax.jms.Message aMessage)
      Stores a Message to the specified System Queue
      void putTextMessage​(java.lang.String aQueueName, java.lang.String aMessageText)
      Stores a TextMessage to the System Queue

    • Method Detail

      • getMessage

        javax.jms.Message getMessage​(java.lang.String aQueueName,
                             int aTimeOut)
                      throws DIException,
                             java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • putMessage

        void putMessage​(java.lang.String aQueueName,
                javax.jms.Message aMessage)
         throws DIException,
                java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • getTextMessage

        java.lang.String getTextMessage​(java.lang.String aQueueName,
                                int aTimeOut)
                         throws DIException,
                                java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • putTextMessage

        void putTextMessage​(java.lang.String aQueueName,
                    java.lang.String aMessageText)
             throws DIException,
                    java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • getBytesMessage

        byte[] getBytesMessage​(java.lang.String aQueueName,
                       int aTimeOut)
                throws DIException,
                       java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • putBytesMessage

        void putBytesMessage​(java.lang.String aQueueName,
                     byte[] aMessageBytes)
              throws DIException,
                     java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • getEntry

        Entry getEntry​(java.lang.String aQueueName,
               int aTimeOut)
        throws DIException,
               java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails

      • putEntry

        void putEntry​(java.lang.String aQueueName,
              Entry aEntry)
       throws DIException,
              java.rmi.RemoteException
        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
        java.rmi.RemoteException - If the Server API RMI connection fails