You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by di...@apache.org on 2005/11/21 21:47:31 UTC
svn commit: r347979 - in /webservices/axis2/trunk/java/modules:
core/src/org/apache/axis2/client/ xml/src/org/apache/axis2/attachments/utils/
Author: dims
Date: Mon Nov 21 12:47:18 2005
New Revision: 347979
URL: http://svn.apache.org/viewcvs?rev=347979&view=rev
Log:
more javadoc changes.
Modified:
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/AsyncResult.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Call.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Callback.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/CallbackReceiver.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOnlyMEPClient.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOutMEPClient.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/ListenerManager.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MEPClient.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MessageSender.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Stub.java
webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/TwoWayTransportBasedSender.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/utils/ImageIO.java
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/AsyncResult.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/AsyncResult.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/AsyncResult.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/AsyncResult.java Mon Nov 21 12:47:18 2005
@@ -19,8 +19,8 @@
import org.apache.axis2.soap.SOAPEnvelope;
/**
- * This Class represents the results of a Async Invocation, this is one return to the
- * Callback. This class is almost always created by the Axis2 and returned.
+ * This class represents the results of an asynchronous invocation. The axis engine
+ * reports back the results in this object via the callback function.
*/
public class AsyncResult {
@@ -44,6 +44,9 @@
}
+ /**
+ * @return MessageContext
+ */
public MessageContext getResponseMessageContext() {
return result;
}
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Call.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Call.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Call.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Call.java Mon Nov 21 12:47:18 2005
@@ -34,7 +34,7 @@
import javax.xml.namespace.QName;
/**
- * This class should be used only to invoke INOUT web services and will serve as a more convenient
+ * This class is used to invoke INOUT web services and serves as a convenience
* class to work with INOUT MEP.
*/
public class Call extends InOutMEPClient {
@@ -51,8 +51,7 @@
}
/**
- * This is used to create call object with client home , using only this constructor it can
- * able to engage modules , addning client side parameters
+ * This is used to create call object with client home.
*
* @param clientHome
* @throws AxisFault
@@ -70,10 +69,10 @@
}
/**
- * Invoke the blocking/Synchronous call
- *
- * @param axisop - this will be used to identify the operation in the client side, without dispatching
- * @param toSend - This should be OM Element (payload)
+ * Invokes the blocking/synchronous call.
+ *s
+ * @param axisop - this is used to identify the operation on the client side explicitly.
+ * @param toSend - data to be sent (OMElement).
* @return
* @throws AxisFault
*/
@@ -93,10 +92,10 @@
}
/**
- * Invoke the blocking/Synchronous call
+ * Invokes the blocking/synchronous call
*
- * @param axisop - this will be used to identify the operation in the client side, without dispatching
- * @param envelope - This should be SOAPEnvelope
+ * @param axisop - this is used to identify the operation on the client side explicitly.
+ * @param envelope - data to be sent (SOAPEnvelope).
* @return
* @throws AxisFault
*/
@@ -118,11 +117,10 @@
}
/**
- * Invoke the nonblocking/Asynchronous call
+ * Invokes the nonblocking/asynchronous call
*
* @param axisop
- * @param toSend - This should be OM Element (payload)
- * invocation behaves accordingly
+ * @param toSend - data to be sent (OMElement).
* @param callback
* @throws org.apache.axis2.AxisFault
*/
@@ -140,11 +138,10 @@
super.invokeNonBlocking(opDesc, msgctx, callback);
}
/**
- * Invoke the nonblocking/Asynchronous call
+ * Invokes the nonblocking/asynchronous call
*
* @param axisop
- * @param envelope - This should be a SOAP Envelope
- * invocation behaves accordingly
+ * @param envelope - data to be sent (SOAPEnvelope).
* @param callback
* @throws org.apache.axis2.AxisFault
*/
@@ -168,7 +165,9 @@
}
/**
- * This method create a operation desc if it null and copy the flows from the template operation
+ * Creates an operation description if it is null and copies the flows from
+ * the template operation.
+ *
* @param opDesc
* @param axisOp
*/
@@ -176,8 +175,8 @@
AxisOperation opDesc,
String axisOp , int mepURL) throws AxisFault {
if (opDesc == null) {
- //if the operation is not alrady define we will copy the
- //crated Phases from the templete operation to the this Operation
+ //if the operation is not already defined we will copy the
+ //created Phases from the template operation to this Operation
opDesc = AxisOperationFactory.getAxisOperation(mepURL);
opDesc.setName(new QName(axisOp));
@@ -194,7 +193,7 @@
}
/**
- * Assume the values for the ConfigurationContext and ServiceContext to make the NON WSDL cases simple.
+ * Assumes the values for the ConfigurationContext and ServiceContext to make the NON WSDL cases simple.
*
* @return ServiceContext that has a ConfigurationContext set in and has assumed values.
* @throws org.apache.axis2.AxisFault
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Callback.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Callback.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Callback.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Callback.java Mon Nov 21 12:47:18 2005
@@ -2,8 +2,8 @@
/**
- * This Class is the abstract representation of the Callback that would be called in the completion of a
- * Async invocation
+ * This Class is the abstract representation of a callback and is called at the completion of an
+ * asynchronous invocation.
*/
public abstract class Callback {
/**
@@ -13,23 +13,22 @@
/**
- * This Method is called by Axis2 once the Async Operation is sucessfully completed and the result returns
- *
+ * This method is invoked by Axis Engine once the asynchronous operation has completed sucessfully.
+ *
* @param result
*/
public abstract void onComplete(AsyncResult result);
/**
- * This Method is called by Axis2 once the Async Operation fails and the result returns
+ * This method is called by Axis Engine if the asynchronous operation fails.
*
* @param e
*/
public abstract void reportError(Exception e);
/**
- * This says has the Async Operation is completed or not. this could be useful for poleing
- * with a special callback written for poleing (checking repeatedly time to time).
- * e.g.
+ * Returns true if the asynchronous operation has completed, false otherwise. Typically this is
+ * used for polling. e.g.
* <code>
* <pre>
* while(!callback.isComplete()){
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/CallbackReceiver.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/CallbackReceiver.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/CallbackReceiver.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/CallbackReceiver.java Mon Nov 21 12:47:18 2005
@@ -8,14 +8,14 @@
import java.util.HashMap;
/**
- * This is a MessageReceiver that is used at the client side to accept the
- * Messages (response) that comes in the Client. This one correlated the incomming Message to
- * the related Messages and Call the correct callback.
+ * This is a MessageReceiver which is used on the client side to accept the
+ * messages (response) that come to the client. This correlates the incoming message to
+ * the related messages and makes a call to the appropriate callback.
*/
public class CallbackReceiver implements MessageReceiver {
- public static String SERVIC_NAME = "ClientService";
+ public static String SERVICE_NAME = "ClientService";
private HashMap callbackstore;
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOnlyMEPClient.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOnlyMEPClient.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOnlyMEPClient.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOnlyMEPClient.java Mon Nov 21 12:47:18 2005
@@ -32,7 +32,7 @@
import javax.xml.namespace.QName;
/**
- * This class Hnadles In-Only (fire and forget) MEP
+ * This class handles In-Only (fire and forget) MEP
*/
public class InOnlyMEPClient extends MEPClient {
protected TransportOutDescription senderTransport;
@@ -44,7 +44,7 @@
}
/**
- * Send the SOAP Message and forget about it. This is one way
+ * Sends the SOAP Message and forgets about it. This is one way
* @param axisop
* @param msgctx
* @throws AxisFault
@@ -78,9 +78,9 @@
/**
- * set the transport to used for sending the SOAP Message
+ * Sets the transport to be used for sending the SOAP Message
* @param senderTransport
- * @throws org.apache.axis2.AxisFault if the transport not found
+ * @throws org.apache.axis2.AxisFault if the transport is not found
*/
public void setSenderTransport(String senderTransport) throws AxisFault {
AxisConfiguration axisConfiguration =
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOutMEPClient.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOutMEPClient.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOutMEPClient.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/InOutMEPClient.java Mon Nov 21 12:47:18 2005
@@ -40,9 +40,9 @@
import javax.xml.namespace.QName;
/**
- * This Class capture handling the In-Out type Method invocations. this provides the
- * methods to do blocking and non blocking invocation. The basic API is based on the
- * MessageContext and the more convients API is provided by the Call
+ * This class captures the handling of In-Out type method invocations for both blocking
+ * and non-blocking calls. The basic API is based on MessageContext and
+ * provides more convenient APIs.
*/
public class InOutMEPClient extends MEPClient {
@@ -53,17 +53,16 @@
protected TransportListener listener;
/**
- * transport that should be used for sending and reciving the message
+ * This is used for sending and receiving messages.
*/
protected TransportOutDescription senderTransport;
protected TransportInDescription listenerTransport;
/**
- * Should the two SOAPMessage are sent over same channel over seperate channels.
- * The value of this variable depends on the transport specified.
- * e.g. If the transports are different this is true by default.
- * HTTP transport support both cases
- * SMTP transport support only two channel case
+ * Used to specify whether the two SOAP Messages are be sent over same channel
+ * or over separate channels.The value of this variable depends on the transport specified.
+ * For e.g., if the transports are different this is true by default.
+ * HTTP transport supports both cases while SMTP transport supports only two channel case.
*/
protected boolean useSeparateListener = false;
@@ -74,7 +73,7 @@
//variables use for internal implementations
/**
- * This is used for the Receiving the Async Messages
+ * This is used for the receiving the asynchronous messages.
*/
protected CallbackReceiver callbackReceiver;
@@ -85,22 +84,23 @@
private static final int DEFAULT_TIMEOUT_MILLISECONDS = 2000;
/**
- * This accepts a ServiceContext, and the ServiceContext should have all the parents set in to it right
- * Ideall this should be generated from a WSDL, we do not have it yet.
+ * Constructs a InOutMEPClient from a ServiceContext.
+ * Ideally this should be generated from a WSDL, we do not have it yet.
* <p/>
- * Follwoing code works for the time been
- * <code>
- * ConfigurationContextFactory efac = new ConfigurationContextFactory();
+ * Following code works for the time being. <p/>
+ * <blockquote><pre>
+ * ConfigurationContextFactory efac = new ConfigurationContextFactory();
+ * // Replace the null with your client repository if any
* ConfigurationContext sysContext = efac.buildClientConfigurationContext(null);
* // above line "null" may be a file name if you know the client repssitory
- * <p/>
+ *
* //create new service
* QName assumedServiceName = new QName("Your Service");
* AxisService axisService = new AxisService(assumedServiceName);
* sysContext.getEngineConfig().addService(axisService);
* ServiceContext service = sysContext.createServiceContext(assumedServiceName);
* return service;
- * <p/>
+ * </pre></blockquote>
* </code>
*
* @param serviceContext
@@ -114,13 +114,12 @@
/**
- * This invocation done via this method blocks till the result arrives, using this method does not indicate
- * anyhting about the transport used or the nature of the transport.
- * e.g. invocation done with this method might
+ * This method is used to make blocking calls. This is independent of the transport.
+ * For e.g. invocation done with this method might
* <ol>
- * <li>send request via http and recevie the response via the return path of the same http connection</li>
- * <li>send request via http and recevie the response different http connection</li>
- * <li>send request via a email smtp and recevie the response via a email</li>
+ * <li>send request via http and receive the response at the same http connection.</li>
+ * <li>send request via http and receive the response at a different http connection.</li>
+ * <li>send request via an email smtp and receive the response via an email.</li>
* </ol>
*/
@@ -208,8 +207,13 @@
}
/**
- * This invocation done via this method blocks till the result arrives, using this method does not indicate
- * anyhting about the transport used or the nature of the transport.
+ * This method is used to make non-blocking calls and is independent of the transport.
+ * For e.g. invocation done with this method might
+ * <ol>
+ * <li>send request via http and receive the response at the same http connection.</li>
+ * <li>send request via http and receive the response at a different http connection.</li>
+ * <li>send request via an email smtp and receive the response via an email.</li>
+ * </ol>
*/
public void invokeNonBlocking(final AxisOperation axisop,
final MessageContext msgctx,
@@ -227,7 +231,7 @@
msgctx.setMessageID(messageID);
////
if (useSeparateListener) {
- //the invocation happen via a seperate Channel, so we should set up the
+ //the invocation happen via a separate Channel, so we should set up the
//information need to correlated the response message and invoke the call back
axisop.setMessageReceiver(callbackReceiver);
@@ -270,14 +274,15 @@
}
/**
- * Set transport information to the the Call, for find how the each parameter acts see the commant at the instance
- * variables. The senarios supoorted are as follows.
+ * Sets transport information to the call. The senarios supported are as follows:
+ * <blockquote><pre>
* [senderTransport, listenerTransport, useSeparateListener]
* http, http, true
* http, http, false
* http,smtp,true
* smtp,http,true
* smtp,smtp,true
+ * </pre></blockquote>
*
* @param senderTransport
* @param listenerTransport
@@ -319,7 +324,7 @@
throw new AxisFault(Messages.getMessage("unknownTransport", listenerTransport));
}
- //if seperate transport is used, start the required listeners
+ //if separate transport is used, start the required listeners
if (useSeparateListener) {
if (!serviceContext
.getConfigurationContext()
@@ -333,7 +338,7 @@
}
/**
- * Check has the transports are identified correctly
+ * Checks if the transports are identified correctly.
*
* @param msgctx
* @throws AxisFault
@@ -360,7 +365,7 @@
}
/**
- * This Class act as the Callback that allow users to wait on the result
+ * This class acts as a callback that allows users to wait on the result.
*/
public class SyncCallBack extends Callback {
private SOAPEnvelope envelope;
@@ -376,16 +381,16 @@
}
/**
- * Closing the Call, this will stop the started Transport Listeners. If there are multiple
- * request to send the Call should be kept open closing only when done
+ * Closes the call initiated to the Transport Listeners. If there are multiple
+ * requests sent, the call should be closed only when all are are done.
*/
public void close() throws AxisFault {
ListenerManager.stop(listenerTransport.getName().getLocalPart());
}
/**
- * This Class is the workhorse for a Non Blocking invocation that uses a
- * two way transport
+ * This class is the workhorse for a non-blocking invocation that uses a
+ * two way transport.
*/
private class NonBlockingInvocationWorker implements Runnable {
@@ -433,8 +438,8 @@
}
/**
- * This will be used in invoke blocking scenario. Client will wait the amount of time specified here
- * and if there is no response, call will timeout. This should be given in multiples of 100 and defaults to 2000.
+ * This is used in blocking scenario. Client will time out after waiting this amount of time.
+ * The default is 2000 and must be provided in multiples of 100.
*
* @param timeOutInMilliSeconds
*/
@@ -443,8 +448,8 @@
}
/**
- * This will be used in invoke blocking scenario. Client will wait the amount of time specified here
- * and if there is no response, call will timeout. This should be given in multiples of 100 and defaults to 2000.
+ * Gets the wait time after which a client times out in a blocking scenario.
+ * The default is 2000.
*
* @return timeOutInMilliSeconds
*/
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/ListenerManager.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/ListenerManager.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/ListenerManager.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/ListenerManager.java Mon Nov 21 12:47:18 2005
@@ -29,8 +29,8 @@
import java.util.HashMap;
/**
- * This manages the Listners, this class havely depends on the static constructs and should be
- * re-architectured. This class only allow the Client to keep one ConfigurationContext in a given JVM.
+ * This class manages the listeners and depends heavily on static constructs and should be
+ * re-architectured. It allows the client to initialize only one ConfigurationContext in a given JVM.
*/
public class ListenerManager {
@@ -39,8 +39,7 @@
public static ConfigurationContext configurationContext;
/**
- * This Method starts a Listenet if it is not already started. But only a one listener started for
- * a given one transport.
+ * Starts a listener for a given transport if it has not already started.
* @param transport
* @param configurationContext
* @throws AxisFault
@@ -84,9 +83,11 @@
}
/**
+ * Returns the replyTo endpoint reference for the servicename/transport combination.
+ *
* @param serviceName
* @param transport
- * @return reply to URL return will direct the response for the message to the given transport listener
+ * @return endpoint reference
* @throws AxisFault
*/
public static EndpointReference replyToEPR(String serviceName,
@@ -107,7 +108,7 @@
return port;
}
/**
- * Class keep information about the listener for a given transport
+ * This class keeps information about the listener for a given transport.
*/
public static class TransportListenerState {
public TransportListenerState(TransportListener listener) {
@@ -119,7 +120,7 @@
}
/**
- * this method control the number of server sockets kept open
+ * Controls the number of server sockets kept open.
*/
public static ServerSocket openSocket(int port) throws AxisFault {
for (int i = 0; i < 5; i++) {
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MEPClient.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MEPClient.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MEPClient.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MEPClient.java Mon Nov 21 12:47:18 2005
@@ -38,7 +38,7 @@
import java.util.List;
/**
- * This is the Super Class for all the MEPClients, All the MEPClient will extend this.
+ * This is the super class for all the MEPClients.
*/
public abstract class MEPClient {
protected ServiceContext serviceContext;
@@ -71,8 +71,8 @@
}
/**
- * prepare the message context for invocation, here the properties kept in the
- * MEPClient copied to the MessageContext
+ * Prepares the message context for invocation. The properties in the
+ * MEPClient are copied to the MessageContext.
*/
protected void prepareInvocation(AxisOperation axisop, MessageContext msgCtx)
throws AxisFault {
@@ -126,7 +126,7 @@
}
/**
- * This class prepare the SOAP Envelope using the payload
+ * Prepares the SOAPEnvelope using the payload.
*
* @param toSend
* @return
@@ -144,9 +144,8 @@
}
/**
- * try to infer the transport looking at the URL, the URL can be http://
- * tcp:// mail:// local://. The method will look for the trnasport name as the
- * protocol part of the transport.
+ * Infers the transport by looking at the URL. The URL can be http://
+ * tcp:// mail:// local://.
*
* @param epr
* @return
@@ -173,7 +172,7 @@
}
/**
- * create write SOAPEvelope(in terms of version) based on the values set.
+ * Creates SOAPEvelope(in terms of version) from the values set.
*
* @return
* @throws AxisFault
@@ -189,9 +188,9 @@
}
/**
- * Engage a given Module to the current invocation. But to call this method the
- * Module *MUST* be enable (picked up by the deployment and known to Axis2) else
- * Exception will be thrown. To be detected put the moduels to the AXIS2_REPOSITORY/modules directory
+ * Engages a given module to the current invocation. But in order to call this method, the
+ * module *MUST* be enabled ( i.e. picked up by the deployment and known to Axis Engine). If not,
+ * an exception will be thrown. To be enabled, the modules are added to the AXIS2_REPOSITORY/modules directory.
*
* @param name
* @throws AxisFault
@@ -230,29 +229,23 @@
}
/**
- * @param string
- */
-
- /**
- * @param exceptionToBeThrownOnSOAPFault - If there is a SOAP Fault in the body of the incoming
- * SOAP Message, system can be configured to throw an exception with the details extracted from
- * the information from the fault message.
- * This boolean variable will enable that facility. If this is false, the response message will just
- * be returned to the application, irrespective of whether it has a Fault or not.
+ * Setting to configure if an exception is to be thrown when the SOAP message has a fault.
+ * If set to true, system throws an exeption with the details extracted from the fault message.
+ * Else the response message is returned to the application, irrespective of whether it has a Fault or not.
+ *
+ * @param exceptionToBeThrownOnSOAPFault
*/
public void setExceptionToBeThrownOnSOAPFault(boolean exceptionToBeThrownOnSOAPFault) {
isExceptionToBeThrownOnSOAPFault = exceptionToBeThrownOnSOAPFault;
}
/**
- * User might sometimes needs to add his own headers to the out going message from the client. This
- * method will facilitate that. But this is bit restrictive in the sense that user can only set a
- * header with only one text as a child. <HeaderBlockName>your text</HeaderBlockName>. If you want
- * a much flexible way to add a soap header block use addSOAPHeader(OMElement)
+ * Allows users to add their own headers to the out going message from the client. It is
+ * restrictive, in the sense, that user can set a
+ * header with only one text. <code><pre><HeaderBlockName>your text</HeaderBlockName></pre></code>. A more flexible
+ * way is to use addSOAPHeader(OMElement).
*
- * @param soapHeaderQName - During the creation of an OMElement from the given QName, we extract
- * the namespace information from the given QName and find whether there is an
- * already defined namespace. And if found that will be conneted with this.
+ * @param soapHeaderQName
* @param soapHeaderText
*/
public void addSOAPHeader(QName soapHeaderQName, String soapHeaderText) {
@@ -265,8 +258,7 @@
}
/**
- * This is much flexible than the other method and allows user to put anything in to the SOAP header
- * block.
+ * Allows users to add a SOAP header block.
* @param soapHeaderBlock
*/
public void addSOAPHeader(OMElement soapHeaderBlock) {
@@ -283,7 +275,9 @@
//==============================================================================
// Use these methods to set Addressing specific information to the SOAP envelope.
//===============================================================================
-
+ /**
+ * @param action
+ */
public void setWsaAction(String action) {
messageInformationHeaders.setAction(action);
}
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MessageSender.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MessageSender.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MessageSender.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/MessageSender.java Mon Nov 21 12:47:18 2005
@@ -36,15 +36,14 @@
import javax.xml.namespace.QName;
/**
- * Message Sender is the class simmiler to the Call, one that provides much simpler API
- * to users to work with.
+ * Message Sender is similar to the Call. Call is just a wrapper that provides a simple API.
*/
public class MessageSender extends InOnlyMEPClient {
protected static AxisOperation axisOperationTemplate;
/**
- * Service context of the Service this MessageSender handles, compare this with the Call, simpler method.
+ * Constructs a Message Sender from a Service Context.
*
* @param service
*/
@@ -57,7 +56,7 @@
}
/**
- * This constrctor is to take repository as aragumnet and build the Configurationcontext using that
+ * Constructs a Message Sender from a specified repository.
*
* @param repo repository location
* @throws AxisFault
@@ -68,7 +67,7 @@
}
/**
- * Send the SOAP Message, the actual worker
+ * Sends a SOAP elvelope created from an OMElement.
*
* @param opName
* @param toSend
@@ -114,7 +113,7 @@
}
/**
- * create a default service Context if the users are not intersted in the lower levels of control
+ * create a default service Context if the users are not interested in the lower levels of control
*
* @return
* @throws AxisFault
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Stub.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Stub.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Stub.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/Stub.java Mon Nov 21 12:47:18 2005
@@ -105,8 +105,8 @@
}
/**
- * If _maintainSession is set to True all the calls will use the same
- * ServiceContext and the user can Share information through that
+ * If _maintainSession is set to true, all the calls can use the same
+ * ServiceContext. The user can share information through this
* ServiceContext across operations.
*/
protected boolean _maintainSession = false;
@@ -117,7 +117,7 @@
}
/**
- * Set the soap version
+ * Sets the soap version.
* @param soapVersion
*/
public void setSOAPVersion(int soapVersion){
@@ -224,7 +224,7 @@
/**
- * Extract the correct element - A util method
+ * A util method that extracts the correct element.
* @param env
* @param type
* @return the relevant element to be databound
@@ -244,7 +244,7 @@
}
/**
- * get the message context
+ * Gets the message context.
*/
protected MessageContext getMessageContext() throws AxisFault {
return new MessageContext(_configurationContext);
Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/TwoWayTransportBasedSender.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/TwoWayTransportBasedSender.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/TwoWayTransportBasedSender.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/client/TwoWayTransportBasedSender.java Mon Nov 21 12:47:18 2005
@@ -25,7 +25,8 @@
import org.apache.axis2.transport.TransportUtils;
/**
- * This works for only a two way transport, this class send the SOAP Message and wait till the\result arrives
+ * This class is used for a two way transport.It sends the SOAP message and waits for a response.
+ *
*/
public class TwoWayTransportBasedSender {
public static MessageContext send(MessageContext msgctx,
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/utils/ImageIO.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/utils/ImageIO.java?rev=347979&r1=347978&r2=347979&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/utils/ImageIO.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/attachments/utils/ImageIO.java Mon Nov 21 12:47:18 2005
@@ -30,7 +30,7 @@
*/
public class ImageIO extends Component {
/**
- * Save an image.
+ * Saves an image.
*
* @param mimeType the mime-type of the format to save the image
* @param image the image to save
@@ -62,7 +62,7 @@
} // saveImage
/**
- * Load an Image.
+ * Loads an Image.
*
* @param in the stream to load the image
* @return the Image