| <!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.6.0_13) on Mon Dec 07 14:17:38 IST 2009 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| JMSUtils (Apache Axis2 - Transport - Root 1.0.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2009-12-07"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JMSUtils (Apache Axis2 - Transport - Root 1.0.0 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#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="class-use/JMSUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/axis2/transport/jms/JMSSender.html" title="class in org.apache.axis2.transport.jms"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/axis2/transport/jms/ServiceTaskManager.html" title="class in org.apache.axis2.transport.jms"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/axis2/transport/jms/JMSUtils.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JMSUtils.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#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"> |
| org.apache.axis2.transport.jms</FONT> |
| <BR> |
| Class JMSUtils</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html" title="class in org.apache.axis2.transport.base">org.apache.axis2.transport.base.BaseUtils</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.axis2.transport.jms.JMSUtils</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>JMSUtils</B><DT>extends <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html" title="class in org.apache.axis2.transport.base">BaseUtils</A></DL> |
| </PRE> |
| |
| <P> |
| Miscallaneous methods used for the JMS transport |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#JMSUtils()">JMSUtils</A></B>()</CODE> |
| |
| <BR> |
| </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>static javax.jms.Connection</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createConnection(javax.jms.ConnectionFactory, java.lang.String, java.lang.String, boolean, java.lang.Boolean)">createConnection</A></B>(javax.jms.ConnectionFactory conFac, |
| java.lang.String user, |
| java.lang.String pass, |
| boolean jmsSpec11, |
| java.lang.Boolean isQueue)</CODE> |
| |
| <BR> |
| This is a JMS spec independent method to create a Connection.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.MessageConsumer</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createConsumer(javax.jms.Session, javax.jms.Destination, java.lang.Boolean, java.lang.String, java.lang.String, boolean, boolean, boolean)">createConsumer</A></B>(javax.jms.Session session, |
| javax.jms.Destination destination, |
| java.lang.Boolean isQueue, |
| java.lang.String subscriberName, |
| java.lang.String messageSelector, |
| boolean pubSubNoLocal, |
| boolean isDurable, |
| boolean jmsSpec11)</CODE> |
| |
| <BR> |
| This is a JMS spec independent method to create a MessageConsumer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.MessageConsumer</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createConsumer(javax.jms.Session, javax.jms.Destination, java.lang.String)">createConsumer</A></B>(javax.jms.Session session, |
| javax.jms.Destination dest, |
| java.lang.String messageSelector)</CODE> |
| |
| <BR> |
| Create a MessageConsumer for the given Destination</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.MessageProducer</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createProducer(javax.jms.Session, javax.jms.Destination, java.lang.Boolean, boolean)">createProducer</A></B>(javax.jms.Session session, |
| javax.jms.Destination destination, |
| java.lang.Boolean isQueue, |
| boolean jmsSpec11)</CODE> |
| |
| <BR> |
| This is a JMS spec independent method to create a MessageProducer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.Session</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createSession(javax.jms.Connection, boolean, int, boolean, java.lang.Boolean)">createSession</A></B>(javax.jms.Connection connection, |
| boolean transacted, |
| int ackMode, |
| boolean jmsSpec11, |
| java.lang.Boolean isQueue)</CODE> |
| |
| <BR> |
| This is a JMS spec independent method to create a Session.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.Destination</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#createTemporaryDestination(javax.jms.Session)">createTemporaryDestination</A></B>(javax.jms.Session session)</CODE> |
| |
| <BR> |
| Create a temp queue or topic for synchronous receipt of responses, when a reply destination |
| is not specified</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getBodyLength(javax.jms.BytesMessage)">getBodyLength</A></B>(javax.jms.BytesMessage bMsg)</CODE> |
| |
| <BR> |
| Return the body length in bytes for a bytes message</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getDestination(java.lang.String)">getDestination</A></B>(java.lang.String url)</CODE> |
| |
| <BR> |
| Return the destination name from the given URL</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getDestinationTypeAsString(int)">getDestinationTypeAsString</A></B>(int destType)</CODE> |
| |
| <BR> |
| Return a String representation of the destination type</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getMessageSize(javax.jms.Message)">getMessageSize</A></B>(javax.jms.Message message)</CODE> |
| |
| <BR> |
| Get the length of the message in bytes</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getProperty(javax.jms.Message, java.lang.String)">getProperty</A></B>(javax.jms.Message message, |
| java.lang.String property)</CODE> |
| |
| <BR> |
| Get a String property from the JMS message</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#getTransportHeaders(javax.jms.Message)">getTransportHeaders</A></B>(javax.jms.Message message)</CODE> |
| |
| <BR> |
| Extract transport level headers for JMS from the given message into a Map</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#isJMSService(org.apache.axis2.description.AxisService)">isJMSService</A></B>(org.apache.axis2.description.AxisService service)</CODE> |
| |
| <BR> |
| Should this service be enabled over the JMS transport?</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#loadTransportHeaders(javax.jms.Message, org.apache.axis2.context.MessageContext)">loadTransportHeaders</A></B>(javax.jms.Message message, |
| org.apache.axis2.context.MessageContext responseMsgCtx)</CODE> |
| |
| <BR> |
| Read the transport headers from the JMS Message and set them to the axis2 message context</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> |
| <TR ALIGN="right" VALIGN=""> |
| <TD NOWRAP><FONT SIZE="-1"> |
| <CODE><T> T</CODE></FONT></TD> |
| </TR> |
| </TABLE> |
| </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#lookup(javax.naming.Context, java.lang.Class, java.lang.String)">lookup</A></B>(javax.naming.Context context, |
| java.lang.Class<T> clazz, |
| java.lang.String name)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.Destination</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#lookupDestination(javax.naming.Context, java.lang.String, java.lang.String)">lookupDestination</A></B>(javax.naming.Context context, |
| java.lang.String destinationName, |
| java.lang.String destinationType)</CODE> |
| |
| <BR> |
| Return the JMS destination with the given destination name looked up from the context</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static javax.jms.Destination</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#setReplyDestination(javax.jms.Destination, javax.jms.Session, javax.jms.Message)">setReplyDestination</A></B>(javax.jms.Destination replyDestination, |
| javax.jms.Session session, |
| javax.jms.Message message)</CODE> |
| |
| <BR> |
| Set the JMS ReplyTo for the message</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#setSOAPEnvelope(javax.jms.Message, org.apache.axis2.context.MessageContext, java.lang.String)">setSOAPEnvelope</A></B>(javax.jms.Message message, |
| org.apache.axis2.context.MessageContext msgContext, |
| java.lang.String contentType)</CODE> |
| |
| <BR> |
| Set the SOAPEnvelope to the Axis2 MessageContext, from the JMS Message passed in</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/axis2/transport/jms/JMSUtils.html#setTransportHeaders(org.apache.axis2.context.MessageContext, javax.jms.Message)">setTransportHeaders</A></B>(org.apache.axis2.context.MessageContext msgContext, |
| javax.jms.Message message)</CODE> |
| |
| <BR> |
| Set transport headers from the axis message context, into the JMS message</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.axis2.transport.base.BaseUtils"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.axis2.transport.base.<A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html" title="class in org.apache.axis2.transport.base">BaseUtils</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#getEnvelope(java.io.InputStream, java.lang.String)">getEnvelope</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#getEPRProperties(java.lang.String)">getEPRProperties</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#getMessageFormatter(org.apache.axis2.context.MessageContext)">getMessageFormatter</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#getOMOutputFormat(org.apache.axis2.context.MessageContext)">getOMOutputFormat</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#getQNameFromString(java.lang.Object)">getQNameFromString</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#handleException(java.lang.String)">handleException</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#handleException(java.lang.String, java.lang.Exception)">handleException</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#isBlank(java.lang.String)">isBlank</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#isUsingTransport(org.apache.axis2.description.AxisService, java.lang.String)">isUsingTransport</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#loadProperties(java.lang.String)">loadProperties</A>, <A HREF="../../../../../org/apache/axis2/transport/base/BaseUtils.html#markServiceAsFaulty(java.lang.String, java.lang.String, org.apache.axis2.engine.AxisConfiguration)">markServiceAsFaulty</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="JMSUtils()"><!-- --></A><H3> |
| JMSUtils</H3> |
| <PRE> |
| public <B>JMSUtils</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ 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="isJMSService(org.apache.axis2.description.AxisService)"><!-- --></A><H3> |
| isJMSService</H3> |
| <PRE> |
| public static boolean <B>isJMSService</B>(org.apache.axis2.description.AxisService service)</PRE> |
| <DL> |
| <DD>Should this service be enabled over the JMS transport? |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>service</CODE> - the Axis service |
| <DT><B>Returns:</B><DD>true if JMS should be enabled</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty(javax.jms.Message, java.lang.String)"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| public static java.lang.String <B>getProperty</B>(javax.jms.Message message, |
| java.lang.String property)</PRE> |
| <DL> |
| <DD>Get a String property from the JMS message |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - JMS message<DD><CODE>property</CODE> - property name |
| <DT><B>Returns:</B><DD>property value</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDestination(java.lang.String)"><!-- --></A><H3> |
| getDestination</H3> |
| <PRE> |
| public static java.lang.String <B>getDestination</B>(java.lang.String url)</PRE> |
| <DL> |
| <DD>Return the destination name from the given URL |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL |
| <DT><B>Returns:</B><DD>the destination name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSOAPEnvelope(javax.jms.Message, org.apache.axis2.context.MessageContext, java.lang.String)"><!-- --></A><H3> |
| setSOAPEnvelope</H3> |
| <PRE> |
| public static void <B>setSOAPEnvelope</B>(javax.jms.Message message, |
| org.apache.axis2.context.MessageContext msgContext, |
| java.lang.String contentType) |
| throws org.apache.axis2.AxisFault, |
| javax.jms.JMSException</PRE> |
| <DL> |
| <DD>Set the SOAPEnvelope to the Axis2 MessageContext, from the JMS Message passed in |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - the JMS message read<DD><CODE>msgContext</CODE> - the Axis2 MessageContext to be populated<DD><CODE>contentType</CODE> - content type for the message |
| <DT><B>Throws:</B> |
| <DD><CODE>org.apache.axis2.AxisFault</CODE> |
| <DD><CODE>javax.jms.JMSException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReplyDestination(javax.jms.Destination, javax.jms.Session, javax.jms.Message)"><!-- --></A><H3> |
| setReplyDestination</H3> |
| <PRE> |
| public static javax.jms.Destination <B>setReplyDestination</B>(javax.jms.Destination replyDestination, |
| javax.jms.Session session, |
| javax.jms.Message message)</PRE> |
| <DL> |
| <DD>Set the JMS ReplyTo for the message |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>replyDestination</CODE> - the JMS Destination where the reply is expected<DD><CODE>session</CODE> - the session to use to create a temp Queue if a response is expected |
| but a Destination has not been specified<DD><CODE>message</CODE> - the JMS message where the final Destinatio would be set as the JMS ReplyTo |
| <DT><B>Returns:</B><DD>the JMS ReplyTo Destination for the message</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTransportHeaders(org.apache.axis2.context.MessageContext, javax.jms.Message)"><!-- --></A><H3> |
| setTransportHeaders</H3> |
| <PRE> |
| public static void <B>setTransportHeaders</B>(org.apache.axis2.context.MessageContext msgContext, |
| javax.jms.Message message) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>Set transport headers from the axis message context, into the JMS message |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>msgContext</CODE> - the axis message context<DD><CODE>message</CODE> - the JMS Message |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE> - on exception</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadTransportHeaders(javax.jms.Message, org.apache.axis2.context.MessageContext)"><!-- --></A><H3> |
| loadTransportHeaders</H3> |
| <PRE> |
| public static void <B>loadTransportHeaders</B>(javax.jms.Message message, |
| org.apache.axis2.context.MessageContext responseMsgCtx) |
| throws org.apache.axis2.AxisFault</PRE> |
| <DL> |
| <DD>Read the transport headers from the JMS Message and set them to the axis2 message context |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - the JMS Message received<DD><CODE>responseMsgCtx</CODE> - the axis message context |
| <DT><B>Throws:</B> |
| <DD><CODE>org.apache.axis2.AxisFault</CODE> - on error</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTransportHeaders(javax.jms.Message)"><!-- --></A><H3> |
| getTransportHeaders</H3> |
| <PRE> |
| public static java.util.Map<java.lang.String,java.lang.Object> <B>getTransportHeaders</B>(javax.jms.Message message)</PRE> |
| <DL> |
| <DD>Extract transport level headers for JMS from the given message into a Map |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - the JMS message |
| <DT><B>Returns:</B><DD>a Map of the transport headers</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createConsumer(javax.jms.Session, javax.jms.Destination, java.lang.String)"><!-- --></A><H3> |
| createConsumer</H3> |
| <PRE> |
| public static javax.jms.MessageConsumer <B>createConsumer</B>(javax.jms.Session session, |
| javax.jms.Destination dest, |
| java.lang.String messageSelector) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>Create a MessageConsumer for the given Destination |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>session</CODE> - JMS Session to use<DD><CODE>dest</CODE> - Destination for which the Consumer is to be created<DD><CODE>messageSelector</CODE> - the message selector to be used if any |
| <DT><B>Returns:</B><DD>a MessageConsumer for the specified Destination |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createTemporaryDestination(javax.jms.Session)"><!-- --></A><H3> |
| createTemporaryDestination</H3> |
| <PRE> |
| public static javax.jms.Destination <B>createTemporaryDestination</B>(javax.jms.Session session) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>Create a temp queue or topic for synchronous receipt of responses, when a reply destination |
| is not specified |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>session</CODE> - the JMS Session to use |
| <DT><B>Returns:</B><DD>a temporary Queue or Topic, depending on the session |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBodyLength(javax.jms.BytesMessage)"><!-- --></A><H3> |
| getBodyLength</H3> |
| <PRE> |
| public static long <B>getBodyLength</B>(javax.jms.BytesMessage bMsg)</PRE> |
| <DL> |
| <DD>Return the body length in bytes for a bytes message |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bMsg</CODE> - the JMS BytesMessage |
| <DT><B>Returns:</B><DD>length of body in bytes</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMessageSize(javax.jms.Message)"><!-- --></A><H3> |
| getMessageSize</H3> |
| <PRE> |
| public static long <B>getMessageSize</B>(javax.jms.Message message) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>Get the length of the message in bytes |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>message</CODE> - |
| <DT><B>Returns:</B><DD>message size (or approximation) in bytes |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lookup(javax.naming.Context, java.lang.Class, java.lang.String)"><!-- --></A><H3> |
| lookup</H3> |
| <PRE> |
| public static <T> T <B>lookup</B>(javax.naming.Context context, |
| java.lang.Class<T> clazz, |
| java.lang.String name) |
| throws javax.naming.NamingException</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.naming.NamingException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createConnection(javax.jms.ConnectionFactory, java.lang.String, java.lang.String, boolean, java.lang.Boolean)"><!-- --></A><H3> |
| createConnection</H3> |
| <PRE> |
| public static javax.jms.Connection <B>createConnection</B>(javax.jms.ConnectionFactory conFac, |
| java.lang.String user, |
| java.lang.String pass, |
| boolean jmsSpec11, |
| java.lang.Boolean isQueue) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>This is a JMS spec independent method to create a Connection. Please be cautious when |
| making any changes |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>conFac</CODE> - the ConnectionFactory to use<DD><CODE>user</CODE> - optional user name<DD><CODE>pass</CODE> - optional password<DD><CODE>jmsSpec11</CODE> - should we use JMS 1.1 API ?<DD><CODE>isQueue</CODE> - is this to deal with a Queue? |
| <DT><B>Returns:</B><DD>a JMS Connection as requested |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE> - on errors, to be handled and logged by the caller</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createSession(javax.jms.Connection, boolean, int, boolean, java.lang.Boolean)"><!-- --></A><H3> |
| createSession</H3> |
| <PRE> |
| public static javax.jms.Session <B>createSession</B>(javax.jms.Connection connection, |
| boolean transacted, |
| int ackMode, |
| boolean jmsSpec11, |
| java.lang.Boolean isQueue) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>This is a JMS spec independent method to create a Session. Please be cautious when |
| making any changes |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>connection</CODE> - the JMS Connection<DD><CODE>transacted</CODE> - should the session be transacted?<DD><CODE>ackMode</CODE> - the ACK mode for the session<DD><CODE>jmsSpec11</CODE> - should we use the JMS 1.1 API?<DD><CODE>isQueue</CODE> - is this Session to deal with a Queue? |
| <DT><B>Returns:</B><DD>a Session created for the given information |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE> - on errors, to be handled and logged by the caller</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createConsumer(javax.jms.Session, javax.jms.Destination, java.lang.Boolean, java.lang.String, java.lang.String, boolean, boolean, boolean)"><!-- --></A><H3> |
| createConsumer</H3> |
| <PRE> |
| public static javax.jms.MessageConsumer <B>createConsumer</B>(javax.jms.Session session, |
| javax.jms.Destination destination, |
| java.lang.Boolean isQueue, |
| java.lang.String subscriberName, |
| java.lang.String messageSelector, |
| boolean pubSubNoLocal, |
| boolean isDurable, |
| boolean jmsSpec11) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>This is a JMS spec independent method to create a MessageConsumer. Please be cautious when |
| making any changes |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>session</CODE> - JMS session<DD><CODE>destination</CODE> - the Destination<DD><CODE>isQueue</CODE> - is the Destination a queue?<DD><CODE>subscriberName</CODE> - optional client name to use for a durable subscription to a topic<DD><CODE>messageSelector</CODE> - optional message selector<DD><CODE>pubSubNoLocal</CODE> - should we receive messages sent by us during pub-sub?<DD><CODE>isDurable</CODE> - is this a durable topic subscription?<DD><CODE>jmsSpec11</CODE> - should we use JMS 1.1 API ? |
| <DT><B>Returns:</B><DD>a MessageConsumer to receive messages |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE> - on errors, to be handled and logged by the caller</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createProducer(javax.jms.Session, javax.jms.Destination, java.lang.Boolean, boolean)"><!-- --></A><H3> |
| createProducer</H3> |
| <PRE> |
| public static javax.jms.MessageProducer <B>createProducer</B>(javax.jms.Session session, |
| javax.jms.Destination destination, |
| java.lang.Boolean isQueue, |
| boolean jmsSpec11) |
| throws javax.jms.JMSException</PRE> |
| <DL> |
| <DD>This is a JMS spec independent method to create a MessageProducer. Please be cautious when |
| making any changes |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>session</CODE> - JMS session<DD><CODE>destination</CODE> - the Destination<DD><CODE>isQueue</CODE> - is the Destination a queue?<DD><CODE>jmsSpec11</CODE> - should we use JMS 1.1 API ? |
| <DT><B>Returns:</B><DD>a MessageProducer to send messages to the given Destination |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.jms.JMSException</CODE> - on errors, to be handled and logged by the caller</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDestinationTypeAsString(int)"><!-- --></A><H3> |
| getDestinationTypeAsString</H3> |
| <PRE> |
| public static java.lang.String <B>getDestinationTypeAsString</B>(int destType)</PRE> |
| <DL> |
| <DD>Return a String representation of the destination type |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>destType</CODE> - the destination type indicator int |
| <DT><B>Returns:</B><DD>a descriptive String</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lookupDestination(javax.naming.Context, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| lookupDestination</H3> |
| <PRE> |
| public static javax.jms.Destination <B>lookupDestination</B>(javax.naming.Context context, |
| java.lang.String destinationName, |
| java.lang.String destinationType) |
| throws javax.naming.NamingException</PRE> |
| <DL> |
| <DD>Return the JMS destination with the given destination name looked up from the context |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>context</CODE> - the Context to lookup<DD><CODE>destinationName</CODE> - name of the destination to be looked up<DD><CODE>destinationType</CODE> - type of the destination to be looked up |
| <DT><B>Returns:</B><DD>the JMS destination, or null if it does not exist |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.naming.NamingException</CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#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="class-use/JMSUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/axis2/transport/jms/JMSSender.html" title="class in org.apache.axis2.transport.jms"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/axis2/transport/jms/ServiceTaskManager.html" title="class in org.apache.axis2.transport.jms"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/axis2/transport/jms/JMSUtils.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JMSUtils.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
