Configure CertificateCheckUrl per container for curl-like TLS checks, classify Sonic permission errors, and extend setup wizard for container management. Co-authored-by: Cursor <cursoragent@cursor.com>
1101 lines
50 KiB
HTML
1101 lines
50 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.5.0_19) on Fri Aug 12 11:25:12 EDT 2011 -->
|
|
<TITLE>
|
|
MapMessage (Management Application API)
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="javax.jms.MapMessage interface">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="MapMessage (Management Application API)";
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="MapMessage.html#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
Sonic Management API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="JMSSecurityException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
|
<A HREF="Message.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html@javax%252Fjms%252FMapMessage.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="MapMessage.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="MapMessage.html#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="MapMessage.html#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
javax.jms</FONT>
|
|
<BR>
|
|
Interface MapMessage</H2>
|
|
<DL>
|
|
<DT><B>All Superinterfaces:</B> <DD><A HREF="Message.html" title="interface in javax.jms">Message</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>MapMessage</B><DT>extends <A HREF="Message.html" title="interface in javax.jms">Message</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
A <CODE>MapMessage</CODE> object is used to send a set of name-value pairs.
|
|
The names are <CODE>String</CODE> objects, and the values are primitive
|
|
data types in the Java programming language. The names must have a value that
|
|
is not null, and not an empty string. The entries can be accessed
|
|
sequentially or randomly by name. The order of the entries is undefined.
|
|
<CODE>MapMessage</CODE> inherits from the <CODE>Message</CODE> interface
|
|
and adds a message body that contains a Map.
|
|
|
|
<P>The primitive types can be read or written explicitly using methods
|
|
for each type. They may also be read or written generically as objects.
|
|
For instance, a call to <CODE>MapMessage.setInt("foo", 6)</CODE> is
|
|
equivalent to <CODE>MapMessage.setObject("foo", new Integer(6))</CODE>.
|
|
Both forms are provided, because the explicit form is convenient for
|
|
static programming, and the object form is needed when types are not known
|
|
at compile time.
|
|
|
|
<P>When a client receives a <CODE>MapMessage</CODE>, it is in read-only
|
|
mode. If a client attempts to write to the message at this point, a
|
|
<CODE>MessageNotWriteableException</CODE> is thrown. If
|
|
<CODE>clearBody</CODE> is called, the message can now be both read from and
|
|
written to.
|
|
|
|
<P><CODE>MapMessage</CODE> objects support the following conversion table.
|
|
The marked cases must be supported. The unmarked cases must throw a
|
|
<CODE>JMSException</CODE>. The <CODE>String</CODE>-to-primitive conversions
|
|
may throw a runtime exception if the primitive's <CODE>valueOf()</CODE>
|
|
method does not accept it as a valid <CODE>String</CODE> representation of
|
|
the primitive.
|
|
|
|
<P>A value written as the row type can be read as the column type.
|
|
|
|
<PRE>
|
|
| | boolean byte short char int long float double String byte[]
|
|
|----------------------------------------------------------------------
|
|
|boolean | X X
|
|
|byte | X X X X X
|
|
|short | X X X X
|
|
|char | X X
|
|
|int | X X X
|
|
|long | X X
|
|
|float | X X X
|
|
|double | X X
|
|
|String | X X X X X X X X
|
|
|byte[] | X
|
|
|----------------------------------------------------------------------
|
|
</PRE>
|
|
|
|
<P>Attempting to read a null value as a primitive type must be treated
|
|
as calling the primitive's corresponding <code>valueOf(String)</code>
|
|
conversion method with a null value. Since <code>char</code> does not
|
|
support a <code>String</code> conversion, attempting to read a null value
|
|
as a <code>char</code> must throw a <code>NullPointerException</code>.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="Session.html#createMapMessage()"><CODE>Session.createMapMessage()</CODE></A>,
|
|
<A HREF="BytesMessage.html" title="interface in javax.jms"><CODE>BytesMessage</CODE></A>,
|
|
<A HREF="Message.html" title="interface in javax.jms"><CODE>Message</CODE></A>,
|
|
<A HREF="ObjectMessage.html" title="interface in javax.jms"><CODE>ObjectMessage</CODE></A>,
|
|
<A HREF="StreamMessage.html" title="interface in javax.jms"><CODE>StreamMessage</CODE></A>,
|
|
<A HREF="TextMessage.html" title="interface in javax.jms"><CODE>TextMessage</CODE></A></DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="fields_inherited_from_class_javax.jms.Message"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Fields inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="Message.html#DEFAULT_DELIVERY_MODE">DEFAULT_DELIVERY_MODE</A>, <A HREF="Message.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</A>, <A HREF="Message.html#DEFAULT_TIME_TO_LIVE">DEFAULT_TIME_TO_LIVE</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getBoolean(java.lang.String)">getBoolean</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>boolean</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> byte</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getByte(java.lang.String)">getByte</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>byte</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> byte[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getBytes(java.lang.String)">getBytes</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the byte array value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> char</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getChar(java.lang.String)">getChar</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the Unicode character value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> double</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getDouble(java.lang.String)">getDouble</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>double</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getFloat(java.lang.String)">getFloat</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>float</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getInt(java.lang.String)">getInt</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>int</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getLong(java.lang.String)">getLong</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>long</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Enumeration</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getMapNames()">getMapNames</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns an <CODE>Enumeration</CODE> of all the names in the
|
|
<CODE>MapMessage</CODE> object.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getObject(java.lang.String)">getObject</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the value of the object with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> short</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getShort(java.lang.String)">getShort</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>short</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#getString(java.lang.String)">getString</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Returns the <CODE>String</CODE> value with the specified name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#itemExists(java.lang.String)">itemExists</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Indicates whether an item exists in this <CODE>MapMessage</CODE> object.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setBoolean(java.lang.String, boolean)">setBoolean</A></B>(java.lang.String name,
|
|
boolean value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>boolean</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setByte(java.lang.String, byte)">setByte</A></B>(java.lang.String name,
|
|
byte value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>byte</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setBytes(java.lang.String, byte[])">setBytes</A></B>(java.lang.String name,
|
|
byte[] value)</CODE>
|
|
|
|
<BR>
|
|
Sets a byte array value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setBytes(java.lang.String, byte[], int, int)">setBytes</A></B>(java.lang.String name,
|
|
byte[] value,
|
|
int offset,
|
|
int length)</CODE>
|
|
|
|
<BR>
|
|
Sets a portion of the byte array value with the specified name into the
|
|
Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setChar(java.lang.String, char)">setChar</A></B>(java.lang.String name,
|
|
char value)</CODE>
|
|
|
|
<BR>
|
|
Sets a Unicode character value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setDouble(java.lang.String, double)">setDouble</A></B>(java.lang.String name,
|
|
double value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>double</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setFloat(java.lang.String, float)">setFloat</A></B>(java.lang.String name,
|
|
float value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>float</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setInt(java.lang.String, int)">setInt</A></B>(java.lang.String name,
|
|
int value)</CODE>
|
|
|
|
<BR>
|
|
Sets an <CODE>int</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setLong(java.lang.String, long)">setLong</A></B>(java.lang.String name,
|
|
long value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>long</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setObject(java.lang.String, java.lang.Object)">setObject</A></B>(java.lang.String name,
|
|
java.lang.Object value)</CODE>
|
|
|
|
<BR>
|
|
Sets an object value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setShort(java.lang.String, short)">setShort</A></B>(java.lang.String name,
|
|
short value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>short</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="MapMessage.html#setString(java.lang.String, java.lang.String)">setString</A></B>(java.lang.String name,
|
|
java.lang.String value)</CODE>
|
|
|
|
<BR>
|
|
Sets a <CODE>String</CODE> value with the specified name into the Map.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_javax.jms.Message"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from interface javax.jms.<A HREF="Message.html" title="interface in javax.jms">Message</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="Message.html#acknowledge()">acknowledge</A>, <A HREF="Message.html#clearBody()">clearBody</A>, <A HREF="Message.html#clearProperties()">clearProperties</A>, <A HREF="Message.html#getBooleanProperty(java.lang.String)">getBooleanProperty</A>, <A HREF="Message.html#getByteProperty(java.lang.String)">getByteProperty</A>, <A HREF="Message.html#getDoubleProperty(java.lang.String)">getDoubleProperty</A>, <A HREF="Message.html#getFloatProperty(java.lang.String)">getFloatProperty</A>, <A HREF="Message.html#getIntProperty(java.lang.String)">getIntProperty</A>, <A HREF="Message.html#getJMSCorrelationID()">getJMSCorrelationID</A>, <A HREF="Message.html#getJMSCorrelationIDAsBytes()">getJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#getJMSDeliveryMode()">getJMSDeliveryMode</A>, <A HREF="Message.html#getJMSDestination()">getJMSDestination</A>, <A HREF="Message.html#getJMSExpiration()">getJMSExpiration</A>, <A HREF="Message.html#getJMSMessageID()">getJMSMessageID</A>, <A HREF="Message.html#getJMSPriority()">getJMSPriority</A>, <A HREF="Message.html#getJMSRedelivered()">getJMSRedelivered</A>, <A HREF="Message.html#getJMSReplyTo()">getJMSReplyTo</A>, <A HREF="Message.html#getJMSTimestamp()">getJMSTimestamp</A>, <A HREF="Message.html#getJMSType()">getJMSType</A>, <A HREF="Message.html#getLongProperty(java.lang.String)">getLongProperty</A>, <A HREF="Message.html#getObjectProperty(java.lang.String)">getObjectProperty</A>, <A HREF="Message.html#getPropertyNames()">getPropertyNames</A>, <A HREF="Message.html#getShortProperty(java.lang.String)">getShortProperty</A>, <A HREF="Message.html#getStringProperty(java.lang.String)">getStringProperty</A>, <A HREF="Message.html#propertyExists(java.lang.String)">propertyExists</A>, <A HREF="Message.html#setBooleanProperty(java.lang.String, boolean)">setBooleanProperty</A>, <A HREF="Message.html#setByteProperty(java.lang.String, byte)">setByteProperty</A>, <A HREF="Message.html#setDoubleProperty(java.lang.String, double)">setDoubleProperty</A>, <A HREF="Message.html#setFloatProperty(java.lang.String, float)">setFloatProperty</A>, <A HREF="Message.html#setIntProperty(java.lang.String, int)">setIntProperty</A>, <A HREF="Message.html#setJMSCorrelationID(java.lang.String)">setJMSCorrelationID</A>, <A HREF="Message.html#setJMSCorrelationIDAsBytes(byte[])">setJMSCorrelationIDAsBytes</A>, <A HREF="Message.html#setJMSDeliveryMode(int)">setJMSDeliveryMode</A>, <A HREF="Message.html#setJMSDestination(javax.jms.Destination)">setJMSDestination</A>, <A HREF="Message.html#setJMSExpiration(long)">setJMSExpiration</A>, <A HREF="Message.html#setJMSMessageID(java.lang.String)">setJMSMessageID</A>, <A HREF="Message.html#setJMSPriority(int)">setJMSPriority</A>, <A HREF="Message.html#setJMSRedelivered(boolean)">setJMSRedelivered</A>, <A HREF="Message.html#setJMSReplyTo(javax.jms.Destination)">setJMSReplyTo</A>, <A HREF="Message.html#setJMSTimestamp(long)">setJMSTimestamp</A>, <A HREF="Message.html#setJMSType(java.lang.String)">setJMSType</A>, <A HREF="Message.html#setLongProperty(java.lang.String, long)">setLongProperty</A>, <A HREF="Message.html#setObjectProperty(java.lang.String, java.lang.Object)">setObjectProperty</A>, <A HREF="Message.html#setShortProperty(java.lang.String, short)">setShortProperty</A>, <A HREF="Message.html#setStringProperty(java.lang.String, java.lang.String)">setStringProperty</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
|
|
getBoolean</H3>
|
|
<PRE>
|
|
boolean <B>getBoolean</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>boolean</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>boolean</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>boolean</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getByte(java.lang.String)"><!-- --></A><H3>
|
|
getByte</H3>
|
|
<PRE>
|
|
byte <B>getByte</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>byte</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>byte</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>byte</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getBytes(java.lang.String)"><!-- --></A><H3>
|
|
getBytes</H3>
|
|
<PRE>
|
|
byte[] <B>getBytes</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the byte array value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the byte array
|
|
<DT><B>Returns:</B><DD>a copy of the byte array value with the specified name; if there
|
|
is no
|
|
item by this name, a null value is returned.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getChar(java.lang.String)"><!-- --></A><H3>
|
|
getChar</H3>
|
|
<PRE>
|
|
char <B>getChar</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the Unicode character value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Unicode character
|
|
<DT><B>Returns:</B><DD>the Unicode character value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDouble(java.lang.String)"><!-- --></A><H3>
|
|
getDouble</H3>
|
|
<PRE>
|
|
double <B>getDouble</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>double</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>double</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>double</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getFloat(java.lang.String)"><!-- --></A><H3>
|
|
getFloat</H3>
|
|
<PRE>
|
|
float <B>getFloat</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>float</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>float</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>float</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInt(java.lang.String)"><!-- --></A><H3>
|
|
getInt</H3>
|
|
<PRE>
|
|
int <B>getInt</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>int</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>int</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>int</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLong(java.lang.String)"><!-- --></A><H3>
|
|
getLong</H3>
|
|
<PRE>
|
|
long <B>getLong</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>long</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>long</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>long</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMapNames()"><!-- --></A><H3>
|
|
getMapNames</H3>
|
|
<PRE>
|
|
java.util.Enumeration <B>getMapNames</B>()
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns an <CODE>Enumeration</CODE> of all the names in the
|
|
<CODE>MapMessage</CODE> object.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>an enumeration of all the names in this <CODE>MapMessage</CODE>
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getObject(java.lang.String)"><!-- --></A><H3>
|
|
getObject</H3>
|
|
<PRE>
|
|
java.lang.Object <B>getObject</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the value of the object with the specified name.
|
|
|
|
<P>This method can be used to return, in objectified format,
|
|
an object in the Java programming language ("Java object") that had
|
|
been stored in the Map with the equivalent
|
|
<CODE>setObject</CODE> method call, or its equivalent primitive
|
|
<CODE>set<I>type</I></CODE> method.
|
|
|
|
<P>Note that byte values are returned as <CODE>byte[]</CODE>, not
|
|
<CODE>Byte[]</CODE>.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Java object
|
|
<DT><B>Returns:</B><DD>a copy of the Java object value with the specified name, in
|
|
objectified format (for example, if the object was set as an
|
|
<CODE>int</CODE>, an <CODE>Integer</CODE> is returned); if there is no
|
|
item by this name, a null value is returned
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getShort(java.lang.String)"><!-- --></A><H3>
|
|
getShort</H3>
|
|
<PRE>
|
|
short <B>getShort</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>short</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>short</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>short</CODE> value with the specified name
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getString(java.lang.String)"><!-- --></A><H3>
|
|
getString</H3>
|
|
<PRE>
|
|
java.lang.String <B>getString</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Returns the <CODE>String</CODE> value with the specified name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>String</CODE>
|
|
<DT><B>Returns:</B><DD>the <CODE>String</CODE> value with the specified name; if there
|
|
is no item by this name, a null value is returned
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to read the message
|
|
due to some internal error.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if this type conversion is invalid.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="itemExists(java.lang.String)"><!-- --></A><H3>
|
|
itemExists</H3>
|
|
<PRE>
|
|
boolean <B>itemExists</B>(java.lang.String name)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Indicates whether an item exists in this <CODE>MapMessage</CODE> object.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the item to test
|
|
<DT><B>Returns:</B><DD>true if the item exists
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to determine if the
|
|
item exists due to some internal error.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setBoolean(java.lang.String, boolean)"><!-- --></A><H3>
|
|
setBoolean</H3>
|
|
<PRE>
|
|
void <B>setBoolean</B>(java.lang.String name,
|
|
boolean value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>boolean</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>boolean</CODE><DD><CODE>value</CODE> - the <CODE>boolean</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setByte(java.lang.String, byte)"><!-- --></A><H3>
|
|
setByte</H3>
|
|
<PRE>
|
|
void <B>setByte</B>(java.lang.String name,
|
|
byte value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>byte</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>byte</CODE><DD><CODE>value</CODE> - the <CODE>byte</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setBytes(java.lang.String, byte[])"><!-- --></A><H3>
|
|
setBytes</H3>
|
|
<PRE>
|
|
void <B>setBytes</B>(java.lang.String name,
|
|
byte[] value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a byte array value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the byte array<DD><CODE>value</CODE> - the byte array value to set in the Map; the array
|
|
is copied so that the value for <CODE>name</CODE> will
|
|
not be altered by future modifications
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.NullPointerException</CODE> - if the name is null, or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setBytes(java.lang.String, byte[], int, int)"><!-- --></A><H3>
|
|
setBytes</H3>
|
|
<PRE>
|
|
void <B>setBytes</B>(java.lang.String name,
|
|
byte[] value,
|
|
int offset,
|
|
int length)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a portion of the byte array value with the specified name into the
|
|
Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the byte array<DD><CODE>value</CODE> - the byte array value to set in the Map<DD><CODE>offset</CODE> - the initial offset within the byte array<DD><CODE>length</CODE> - the number of bytes to use
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setChar(java.lang.String, char)"><!-- --></A><H3>
|
|
setChar</H3>
|
|
<PRE>
|
|
void <B>setChar</B>(java.lang.String name,
|
|
char value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a Unicode character value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Unicode character<DD><CODE>value</CODE> - the Unicode character value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDouble(java.lang.String, double)"><!-- --></A><H3>
|
|
setDouble</H3>
|
|
<PRE>
|
|
void <B>setDouble</B>(java.lang.String name,
|
|
double value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>double</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>double</CODE><DD><CODE>value</CODE> - the <CODE>double</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setFloat(java.lang.String, float)"><!-- --></A><H3>
|
|
setFloat</H3>
|
|
<PRE>
|
|
void <B>setFloat</B>(java.lang.String name,
|
|
float value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>float</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>float</CODE><DD><CODE>value</CODE> - the <CODE>float</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInt(java.lang.String, int)"><!-- --></A><H3>
|
|
setInt</H3>
|
|
<PRE>
|
|
void <B>setInt</B>(java.lang.String name,
|
|
int value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets an <CODE>int</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>int</CODE><DD><CODE>value</CODE> - the <CODE>int</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLong(java.lang.String, long)"><!-- --></A><H3>
|
|
setLong</H3>
|
|
<PRE>
|
|
void <B>setLong</B>(java.lang.String name,
|
|
long value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>long</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>long</CODE><DD><CODE>value</CODE> - the <CODE>long</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setObject(java.lang.String, java.lang.Object)"><!-- --></A><H3>
|
|
setObject</H3>
|
|
<PRE>
|
|
void <B>setObject</B>(java.lang.String name,
|
|
java.lang.Object value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets an object value with the specified name into the Map.
|
|
|
|
<P>This method works only for the objectified primitive
|
|
object types (<code>Integer</code>, <code>Double</code>,
|
|
<code>Long</code> ...), <code>String</code> objects, and byte
|
|
arrays.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the Java object<DD><CODE>value</CODE> - the Java object value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageFormatException.html" title="class in javax.jms">MessageFormatException</A></CODE> - if the object is invalid.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setShort(java.lang.String, short)"><!-- --></A><H3>
|
|
setShort</H3>
|
|
<PRE>
|
|
void <B>setShort</B>(java.lang.String name,
|
|
short value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>short</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>short</CODE><DD><CODE>value</CODE> - the <CODE>short</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setString(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
setString</H3>
|
|
<PRE>
|
|
void <B>setString</B>(java.lang.String name,
|
|
java.lang.String value)
|
|
throws <A HREF="JMSException.html" title="class in javax.jms">JMSException</A></PRE>
|
|
<DL>
|
|
<DD>Sets a <CODE>String</CODE> value with the specified name into the Map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the <CODE>String</CODE><DD><CODE>value</CODE> - the <CODE>String</CODE> value to set in the Map
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="JMSException.html" title="class in javax.jms">JMSException</A></CODE> - if the JMS provider fails to write the message
|
|
due to some internal error.
|
|
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the name is null or if the name is
|
|
an empty string.
|
|
<DD><CODE><A HREF="MessageNotWriteableException.html" title="class in javax.jms">MessageNotWriteableException</A></CODE> - if the message is in read-only
|
|
mode.</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="MapMessage.html#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
Sonic Management API</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="JMSSecurityException.html" title="class in javax.jms"><B>PREV CLASS</B></A>
|
|
<A HREF="Message.html" title="interface in javax.jms"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html@javax%252Fjms%252FMapMessage.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="MapMessage.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="MapMessage.html#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="MapMessage.html#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
<font size="-1">Copyright © 2001-2011
|
|
<a href="http://www.progress.com" target="_top"> Progress Software Corporation</a>. All Rights Reserved.
|
|
<br>HTML formatted on 12-Aug-2011.</font>
|
|
</BODY>
|
|
</HTML>
|