message.java

JAVA 消息服务(JMS)定义了Java 中访问消息中间件的接口,里边有实现消息服务的基础源码,可以开发高级应用

      * name.
      *  
      * @param name the name of the <CODE>float</CODE> property
      *  
      * @return the <CODE>float</CODE> property value for the specified name
      *  
      * @exception JMSException if the JMS provider fails to get the property
      *                         value due to some internal error.
      * @exception MessageFormatException if this type conversion is invalid.
      */ 

    float
    getFloatProperty(String name) throws JMSException;


    /** Returns the value of the <CODE>double</CODE> property with the specified
      * name.
      *  
      * @param name the name of the <CODE>double</CODE> property
      *  
      * @return the <CODE>double</CODE> property value for the specified name
      *  
      * @exception JMSException if the JMS provider fails to get the property
      *                         value due to some internal error.
      * @exception MessageFormatException if this type conversion is invalid.
      */ 

    double
    getDoubleProperty(String name) throws JMSException;


    /** Returns the value of the <CODE>String</CODE> property with the specified
      * name.
      *  
      * @param name the name of the <CODE>String</CODE> property
      *  
      * @return the <CODE>String</CODE> property value for the specified name;
      * if there is no property by this name, a null value is returned
      *  
      * @exception JMSException if the JMS provider fails to get the property
      *                         value due to some internal error.
      * @exception MessageFormatException if this type conversion is invalid.
      */ 

    String
    getStringProperty(String name) throws JMSException;


    /** Returns the value of the Java object property with the specified name.
      *  
      * <P>This method can be used to return, in objectified format,
      * an object that has been stored as a property in the message with the 
      * equivalent <CODE>setObjectProperty</CODE> method call, or its equivalent
      * primitive <CODE>set<I>type</I>Property</CODE> method.
      *  
      * @param name the name of the Java object property
      *  
      * @return the Java object property value with the specified name, in 
      * objectified format (for example, if the property was set as an 
      * <CODE>int</CODE>, an <CODE>Integer</CODE> is 
      * returned); if there is no property by this name, a null value 
      * is returned
      *  
      * @exception JMSException if the JMS provider fails to get the property
      *                         value due to some internal error.
      */ 

    Object
    getObjectProperty(String name) throws JMSException;


    /** Returns an <CODE>Enumeration</CODE> of all the property names.
      *
      * <P>Note that JMS standard header fields are not considered
      * properties and are not returned in this enumeration.
      *  
      * @return an enumeration of all the names of property values
      *  
      * @exception JMSException if the JMS provider fails to get the property
      *                          names due to some internal error.
      */ 
     
    Enumeration
    getPropertyNames() throws JMSException;


    /** Sets a <CODE>boolean</CODE> property value with the specified name into 
      * the message.
      *
      * @param name the name of the <CODE>boolean</CODE> property
      * @param value the <CODE>boolean</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setBooleanProperty(String name, boolean value)
                        throws JMSException;


    /** Sets a <CODE>byte</CODE> property value with the specified name into 
      * the message.
      *  
      * @param name the name of the <CODE>byte</CODE> property
      * @param value the <CODE>byte</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setByteProperty(String name, byte value)
                        throws JMSException;


    /** Sets a <CODE>short</CODE> property value with the specified name into
      * the message.
      *  
      * @param name the name of the <CODE>short</CODE> property
      * @param value the <CODE>short</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setShortProperty(String name, short value)
                        throws JMSException;


    /** Sets an <CODE>int</CODE> property value with the specified name into
      * the message.
      *  
      * @param name the name of the <CODE>int</CODE> property
      * @param value the <CODE>int</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setIntProperty(String name, int value)
                        throws JMSException;


    /** Sets a <CODE>long</CODE> property value with the specified name into 
      * the message.
      *  
      * @param name the name of the <CODE>long</CODE> property
      * @param value the <CODE>long</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setLongProperty(String name, long value)
                        throws JMSException;


    /** Sets a <CODE>float</CODE> property value with the specified name into 
      * the message.
      *  
      * @param name the name of the <CODE>float</CODE> property
      * @param value the <CODE>float</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setFloatProperty(String name, float value)
                        throws JMSException;


    /** Sets a <CODE>double</CODE> property value with the specified name into 
      * the message.
      *  
      * @param name the name of the <CODE>double</CODE> property
      * @param value the <CODE>double</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setDoubleProperty(String name, double value)
                        throws JMSException;


    /** Sets a <CODE>String</CODE> property value with the specified name into 
      * the message.
      *
      * @param name the name of the <CODE>String</CODE> property
      * @param value the <CODE>String</CODE> property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setStringProperty(String name, String value)
                        throws JMSException;


    /** Sets a Java object property value with the specified name into the 
      * message.
      *  
      * <P>Note that this method works only for the objectified primitive
      * object types (<CODE>Integer</CODE>, <CODE>Double</CODE>, 
      * <CODE>Long</CODE> ...) and <CODE>String</CODE> objects.
      *  
      * @param name the name of the Java object property
      * @param value the Java object property value to set
      *  
      * @exception JMSException if the JMS provider fails to set the property
      *                          due to some internal error.
      * @exception IllegalArgumentException if the name is null or if the name is
      *                          an empty string.
      * @exception MessageFormatException if the object is invalid
      * @exception MessageNotWriteableException if properties are read-only
      */ 

    void
    setObjectProperty(String name, Object value)
                        throws JMSException;


    /** Acknowledges all consumed messages of the session of this consumed 
      * message.
      *  
      * <P>All consumed JMS messages support the <CODE>acknowledge</CODE> 
      * method for use when a client has specified that its JMS session's 
      * consumed messages are to be explicitly acknowledged.  By invoking 
      * <CODE>acknowledge</CODE> on a consumed message, a client acknowledges 
      * all messages consumed by the session that the message was delivered to.
      * 
      * <P>Calls to <CODE>acknowledge</CODE> are ignored for both transacted 
      * sessions and sessions specified to use implicit acknowledgement modes.
      *
      * <P>A client may individually acknowledge each message as it is consumed,
      * or it may choose to acknowledge messages as an application-defined group 
      * (which is done by calling acknowledge on the last received message of the group,
      *  thereby acknowledging all messages consumed by the session.)
      *
      * <P>Messages that have been received but not acknowledged may be 
      * redelivered.
      *
      * @exception JMSException if the JMS provider fails to acknowledge the
      *                         messages due to some internal error.
      * @exception IllegalStateException if this method is called on a closed
      *                         session.
      *
      * @see javax.jms.Session#CLIENT_ACKNOWLEDGE
      */ 

    void
    acknowledge() throws JMSException;


    /** Clears out the message body. Clearing a message's body does not clear 
      * its header values or property entries.
      *
      * <P>If this message body was read-only, calling this method leaves
      * the message body in the same state as an empty body in a newly
      * created message.
      *
      * @exception JMSException if the JMS provider fails to clear the message
      *                         body due to some internal error.
      */

    void
    clearBody() throws JMSException;
}