Return-Path: Mailing-List: contact soap-dev-help@xml.apache.org; run by ezmlm Delivered-To: mailing list soap-dev@xml.apache.org Delivered-To: moderator for soap-dev@xml.apache.org Received: (qmail 49179 invoked by uid 500); 11 Nov 2002 14:34:51 -0000 Delivered-To: apmail-xml-soap-cvs@apache.org Received: (qmail 49165 invoked from network); 11 Nov 2002 14:34:48 -0000 Received: from icarus.apache.org (63.251.56.143) by daedalus.apache.org with SMTP; 11 Nov 2002 14:34:48 -0000 Received: (qmail 73627 invoked by uid 1527); 11 Nov 2002 14:34:47 -0000 Date: 11 Nov 2002 14:34:47 -0000 Message-ID: <20021111143447.73626.qmail@icarus.apache.org> From: snichol@apache.org To: xml-soap-cvs@apache.org Subject: cvs commit: xml-soap/java/src/org/apache/soap/rpc Call.java Parameter.java RPCMessage.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N snichol 2002/11/11 06:34:47 Modified: java/src/org/apache/soap/rpc Call.java Parameter.java RPCMessage.java Log: Added a little javadoc, mainly for ctors. Thanks to Jeremiah Johnson for pointing out the usefulness of this. Revision Changes Path 1.19 +35 -0 xml-soap/java/src/org/apache/soap/rpc/Call.java Index: Call.java =================================================================== RCS file: /home/cvs/xml-soap/java/src/org/apache/soap/rpc/Call.java,v retrieving revision 1.18 retrieving revision 1.19 diff -u -r1.18 -r1.19 --- Call.java 18 Oct 2002 13:36:00 -0000 1.18 +++ Call.java 11 Nov 2002 14:34:47 -0000 1.19 @@ -93,11 +93,30 @@ private int to = 0; private boolean useDocumentBuilder = true; + /** + * Creates a call for an RPC, and specifically the request message, specifying + * none of the attributes of the call. + */ public Call() { this(null, null, null, null, null); } + /** + * Creates a call for an RPC, and specifically the request message, creating + * a new SOAPContext. + * + * @param targetObjectURI URI to distinguish the service, also known as + * the namespace of the service in WSDL. + * @param methodName The name of the method to invoke. + * @param params The parameters for the message, either the call parameters + * for the request or the return value for the response. + * @param header The optional SOAP header element. + * @param encodingStyleURI The encoding style for the message, typically + * specifying SOAP encoding, literal XML encoding, + * or XMI encoding. Individual parameters can + * override this value. + */ public Call(String targetObjectURI, String methodName, Vector params, Header header, String encodingStyleURI) { @@ -105,6 +124,22 @@ new SOAPContext()); } + /** + * Creates a call for an RPC, and specifically the request message. + * + * @param targetObjectURI URI to distinguish the service, also known as + * the namespace of the service in WSDL. + * @param methodName The name of the method to invoke. + * @param params The parameters for the message, either the call parameters + * for the request or the return value for the response. + * @param header The optional SOAP header element. + * @param encodingStyleURI The encoding style for the message, typically + * specifying SOAP encoding, literal XML encoding, + * or XMI encoding. Individual parameters can + * override this value. + * @param ctx The context of the message, including information about + * the body and its serialization. + */ public Call(String targetObjectURI, String methodName, Vector params, Header header, String encodingStyleURI, SOAPContext ctx) { 1.4 +18 -0 xml-soap/java/src/org/apache/soap/rpc/Parameter.java Index: Parameter.java =================================================================== RCS file: /home/cvs/xml-soap/java/src/org/apache/soap/rpc/Parameter.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- Parameter.java 1 Sep 2000 03:52:50 -0000 1.3 +++ Parameter.java 11 Nov 2002 14:34:47 -0000 1.4 @@ -80,6 +80,24 @@ private Object value = null; private String encodingStyleURI = null; + /** + * Creates a parameter, specifying all of its attributes. + * + * @param name The name of the parameter, i.e. the name of the XML element + * serialized for this parameter. + * @param type The Java class of the parameter, which is used to pick a + * Java Serializer implementation and the xsi:type attribute + * value for the serialized XML element. + * @param value The Java value of the parameter. This typically must have + * a Java class the same as or a subclass of the type parameter. + * For primitive types, use a wrapper class, i.e. for an int, + * use an Integer. + * @param encodingStyleURI The encoding style for the parameter, typically + * specifying SOAP encoding, literal XML encoding, + * or XMI encoding. If this is null, the encoding + * style of the Call will apply (which is the typical + * case). + */ public Parameter(String name, Class type, Object value, 1.21 +28 -0 xml-soap/java/src/org/apache/soap/rpc/RPCMessage.java Index: RPCMessage.java =================================================================== RCS file: /home/cvs/xml-soap/java/src/org/apache/soap/rpc/RPCMessage.java,v retrieving revision 1.20 retrieving revision 1.21 diff -u -r1.20 -r1.21 --- RPCMessage.java 6 Nov 2002 15:11:08 -0000 1.20 +++ RPCMessage.java 11 Nov 2002 14:34:47 -0000 1.21 @@ -83,6 +83,22 @@ protected String encodingStyleURI; protected SOAPContext ctx; + /** + * Creates a message for the request or response of an RPC. + * + * @param targetObjectURI URI to distinguish the service, also known as + * the namespace of the service in WSDL. + * @param methodName The name of the method to invoke. + * @param params The parameters for the message, either the call parameters + * for the request or the return value for the response. + * @param header The optional SOAP header element. + * @param encodingStyleURI The encoding style for the message, typically + * specifying SOAP encoding, literal XML encoding, + * or XMI encoding. Individual parameters can + * override this value. + * @param ctx The context of the message, including information about + * the body and its serialization. + */ protected RPCMessage(String targetObjectURI, String methodName, Vector params, Header header, String encodingStyleURI, SOAPContext ctx) { @@ -94,6 +110,12 @@ this.ctx = ctx; } + /** + * Sets the URI to distinguish the service. + * + * @param targetObjectURI URI to distinguish the service, also known as + * the namespace of the service in WSDL. + */ public void setTargetObjectURI(String targetObjectURI) { // Any incoming URI must be the full URI this.fullTargetObjectURI = targetObjectURI; @@ -104,6 +126,12 @@ targetObjectURI); } + /** + * Gets the URI to distinguish the service. + * + * @return URI to distinguish the service, also known as + * the namespace of the service in WSDL. + */ public String getTargetObjectURI() { return targetObjectURI; }