You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ba...@apache.org on 2006/10/18 19:53:09 UTC
svn commit: r465316 -
/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/
Author: barrettj
Date: Wed Oct 18 10:53:08 2006
New Revision: 465316
URL: http://svn.apache.org/viewvc?view=rev&rev=465316
Log:
Cleanup class comments and minor code cleanup.
Modified:
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/DescriptionUtils.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointDescription.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointInterfaceDescription.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/FaultDescription.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/OperationDescription.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ParameterDescription.java
webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ServiceDescription.java
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/DescriptionUtils.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/DescriptionUtils.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/DescriptionUtils.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/DescriptionUtils.java Wed Oct 18 10:53:08 2006
@@ -21,7 +21,7 @@
import javax.xml.namespace.QName;
/**
- *
+ * Utilities used throughout the Description package.
*/
public class DescriptionUtils {
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointDescription.java Wed Oct 18 10:53:08 2006
@@ -60,29 +60,27 @@
* Provider-based and SEI-based (aka Endpoint-based or Java-based) enpdoints.
* SEI-based endpoints (whether they have an explicit or implcit SEI) will have
* addtional metadata information in an EndpointInterfaceDescription class and
- * sub-hierachy; Provider-based endpoitns to not have such a hierachy.
- */
-
-/*
-Working-design information.
-
-Java Name: none [client]; Endpoint implementation class [server]
-
-Axis2 Delegate: AxisService
-
-JSR-181 Annotations: TBD
-
-WSDL Elements
-<port
-
-JAX-WS Annotations:
-@ServiceMode (value) [Server, jaxws.Provider?]
-@WebServiceProvider(wsdllocation, serviceName, portName, targetNamespace) [Server, jaxws.Provider]
-@BindingType(value) [Server, endpoint impl]
-TBD
-
-Properties available to JAXWS runtime: TBD
-
+ * sub-hierachy; Provider-based endpoitns do not have such a hierachy.
+ *
+ * <pre>
+ * <b>EndpointDescription details</b>
+ *
+ * CORRESPONDS TO: The endpoint (both Client and Server)
+ *
+ * AXIS2 DELEGATE: AxisService
+ *
+ * CHILDREN: 0..1 EndpointInterfaceDescription
+ *
+ * ANNOTATIONS:
+ * WebService [181]
+ * WebServiceProvider [224]
+ * ServicMode [224]
+ * BindingType [224]
+ *
+ * WSDL ELEMENTS:
+ * port
+ *
+ * </pre>
*/
/*
* TODO: EndpointDescription should be created via AxisService objects and not directly from WSDL
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointInterfaceDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointInterfaceDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointInterfaceDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/EndpointInterfaceDescription.java Wed Oct 18 10:53:08 2006
@@ -45,6 +45,23 @@
* to an SEI-based (aka Endpoint-based or Java-based) enpdoint; Provider-based
* endpoint, which are not operation based and do not have an associated SEI,
* will not have an an EndpointInterfaceDescription class and sub-hierachy.
+ *
+ * <pre>
+ * <b>EndpointInterfaceDescription details</b>
+ *
+ * CORRESPONDS TO: An SEI (on both Client and Server)
+ *
+ * AXIS2 DELEGATE: none
+ *
+ * CHILDREN: 1..n OperationDescription
+ *
+ * ANNOTATIONS:
+ * SOAPBinding [181]
+ *
+ * WSDL ELEMENTS:
+ * portType
+ *
+ * </pre>
*/
/*
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/FaultDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/FaultDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/FaultDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/FaultDescription.java Wed Oct 18 10:53:08 2006
@@ -19,28 +19,31 @@
package org.apache.axis2.jaxws.description;
/**
+ * A FaultDescription corresponds to a fault that can be thrown from an operation. NOTE this it not
+ * implemented yet!
*
+ * FaultDescriptons contain information that is only relevent for and SEI-based service, i.e. one that is invoked via specific
+ * methods. This class does not exist for Provider-based services (i.e. those that specify WebServiceProvider)
+ *
+ * <pre>
+ * <b>OperationDescription details</b>
+ *
+ * CORRESPONDS TO: An exception thrown by an operation on an SEI (on both Client and Server)
+ *
+ * AXIS2 DELEGATE: None
+ *
+ * CHILDREN: None
+ * None
+ *
+ * ANNOTATIONS:
+ * WebFault [224]
+ *
+ * WSDL ELEMENTS:
+ * fault message
+ *
+ * </pre>
*/
-/*
-Workign-design information.
-
-Java Name: Exception class name
-
-Exception Holder Type
-Exception Holder Held Type
-
-Axis2 Delegate: TBD
-
-JSR-181 Annotations: TBD
-
-WSDL Elements: TBD
-
-JAX-WS Annotations:
-@WebFault(name, targetNamespace, faultBean)
-
-Properties available to JAXWS runtime: TBD
-
- */
+// TODO: This class is not implemented yet or used from OperationDescription
public class FaultDescription {
}
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/OperationDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/OperationDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/OperationDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/OperationDescription.java Wed Oct 18 10:53:08 2006
@@ -22,7 +22,6 @@
import java.lang.reflect.Method;
import java.lang.reflect.Type;
import java.util.ArrayList;
-import java.util.HashMap;
import javax.jws.Oneway;
import javax.jws.WebMethod;
@@ -39,47 +38,37 @@
/**
* An OperationDescripton corresponds to a method on an SEI. That SEI could be explicit
- * (i.e. @WebService.endpointInterface=sei.class) or implicit (i.e. public methods on the service implementation
+ * (i.e. WebService.endpointInterface=sei.class) or implicit (i.e. public methods on the service implementation
* are the contract and thus the implicit SEI). Note that while OperationDescriptions are created on both the client
* and service side, implicit SEIs will only occur on the service side.
*
* OperationDescriptons contain information that is only relevent for and SEI-based service, i.e. one that is invoked via specific
- * methods. This class does not exist for Provider-based services (i.e. those that specify @WebServiceProvider)
+ * methods. This class does not exist for Provider-based services (i.e. those that specify WebServiceProvider)
+ *
+ * <pre>
+ * <b>OperationDescription details</b>
+ *
+ * CORRESPONDS TO: A single operation on an SEI (on both Client and Server)
+ *
+ * AXIS2 DELEGATE: AxisOperation
+ *
+ * CHILDREN: 0..n ParameterDescription
+ * 0..n FaultDescription (Note: Not fully implemented)
+ *
+ * ANNOTATIONS:
+ * WebMethod [181]
+ * SOAPBinding [181]
+ * Oneway [181]
+ * WebResult [181]
+ * RequestWrapper [224]
+ * ResponseWrapper [224]
+ *
+ * WSDL ELEMENTS:
+ * operation
+ *
+ * </pre>
*/
-/*
-Java Name: Method name from SEI
-
-Axis2 Delegate: AxisOperation
-JSR-181 Annotations:
-@WebMethod
-- operationName
-- action
-- exclude
-@Oneway So basically even if an operation has a return parameter it could be one way and in this case should we set the AxisOperatio mep to oneway?[NT]
-TBD
-
-WSDL Elements
-<portType <operation
-
-JAX-WS Annotations
-@RequestWrapper
-- localName
-- targetNamespace
-- className
-@ResponseWrapper
-- localName
-- targetNamespace
-- className
-TBD
-
-Properties available to JAXWS runtime:
-isWrapper()
-String getRequestWrapper JAXB Class
-String getResponseWrapper JAXB Class
-TBD
-
- */
// TODO: Axis2 does not support overloaded operations, although EndpointInterfaceDescription.addOperation() does support overloading
// of methods represented by OperationDescription classes. However, the AxisOperation contained in an OperationDescription
// does NOT support overloaded methods.
@@ -119,7 +108,7 @@
private String responseWrapperClassName;
// ANNOTATION: @SOAPBinding
- // Note this is the Method-level annotation. See EndpointInterfaceDescription for the Method-level annotation
+ // Note this is the Method-level annotation. See EndpointInterfaceDescription for the Type-level annotation
// Also note this annotation is only allowed on methods if SOAPBinding.Style is DOCUMENT and if the method-level
// annotation is absent, the behavior defined on the Type is used.
// per JSR-181 MR Sec 4.7 "Annotation: javax.jws.soap.SOAPBinding" pg 28
@@ -158,15 +147,16 @@
private String webResultPartName;
// Default value per JSR-181 MR Sec 4.5.1, pg 23
public static final String WebResult_TargetNamespace_DEFAULT = "";
- // ANNOTATION @WebFault
- private WebFault[] webFaultAnnotations;
- private String[] webFaultNames;
- private String[] webExceptionNames; // the fully-qualified names of declared exceptions with WebFault annotations
private String webResultTargetNamespace;
// Default value per JSR-181 MR sec 4.5, pg 24
public static final Boolean WebResult_Header_DEFAULT = new Boolean(false);
private Boolean webResultHeader;
-
+
+ // ANNOTATION @WebFault
+ private WebFault[] webFaultAnnotations;
+ private String[] webFaultNames;
+ private String[] webExceptionNames; // the fully-qualified names of declared exceptions with WebFault annotations
+
OperationDescription(Method method, EndpointInterfaceDescription parent) {
// TODO: Look for WebMethod anno; get name and action off of it
parentEndpointInterfaceDescription = parent;
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ParameterDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ParameterDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ParameterDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ParameterDescription.java Wed Oct 18 10:53:08 2006
@@ -30,26 +30,33 @@
import org.apache.axis2.jaxws.description.builder.WebParamAnnot;
/**
+ * A ParameterDescripton corresponds to parameter to a method on an SEI. That
+ * SEI could be explicit (i.e. WebService.endpointInterface=sei.class) or
+ * implicit (i.e. public methods on the service implementation are the contract
+ * and thus the implicit SEI).
+ *
+ * ParameterDescriptons contain information that is only relevent for and
+ * SEI-based service, i.e. one that is invoked via specific methods. This class
+ * does not exist for Provider-based services (i.e. those that specify
+ * WebServiceProvider)
+ *
+ * <pre>
+ * <b>ParameternDescription details</b>
+ *
+ * CORRESPONDS TO: A parameter to a method on an SEI (on both Client and Server)
+ *
+ * AXIS2 DELEGATE: None
+ *
+ * CHILDREN: None
+ *
+ * ANNOTATIONS:
+ * WebParam [181]
+ *
+ * WSDL ELEMENTS:
+ * message parts
+ *
+ * </pre>
*
- */
-/*
-Java Name: Parameter Name
-
-Java Signature Parameter Type: Could be a holder class
-Java Signature ParameterHeldType if the Signature Parameter Type is a holder class, then this is the held type
-
-Axis2 Delegate: TBD
-
-JSR-181 Annotations:
-@WebParam(name, targetNamespace, mode, header, partName) [Input, Output]
-TBD
-
-WSDL Elements: TBD
-
-JAX-WS Annotations: TBD
-
-Properties available to JAXWS runtime: TBD
-
*/
public class ParameterDescription {
private OperationDescription parentOperationDescription;
Modified: webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ServiceDescription.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ServiceDescription.java?view=diff&rev=465316&r1=465315&r2=465316
==============================================================================
--- webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ServiceDescription.java (original)
+++ webservices/axis2/trunk/java/modules/jaxws/src/org/apache/axis2/jaxws/description/ServiceDescription.java Wed Oct 18 10:53:08 2006
@@ -22,30 +22,16 @@
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
-import java.util.Map;
-import java.util.List;
import javax.xml.namespace.QName;
-import javax.xml.ws.WebServiceException;
-import javax.jws.WebService;
import javax.wsdl.Definition;
import javax.wsdl.Port;
import javax.wsdl.Service;
import javax.wsdl.WSDLException;
-import javax.xml.namespace.QName;
-import org.apache.axis2.AxisFault;
import org.apache.axis2.client.ServiceClient;
import org.apache.axis2.context.ConfigurationContext;
-import org.apache.axis2.deployment.DeploymentException;
import org.apache.axis2.description.AxisService;
-import org.apache.axis2.description.OutInAxisOperation;
-import org.apache.axis2.description.OutOnlyAxisOperation;
-import org.apache.axis2.description.Parameter;
-import org.apache.axis2.description.RobustOutOnlyAxisOperation;
-import org.apache.axis2.description.WSDL11ToAllAxisServicesBuilder;
-import org.apache.axis2.description.WSDL11ToAxisServiceBuilder;
-import org.apache.axis2.engine.AbstractDispatcher;
import org.apache.axis2.jaxws.ClientConfigurationFactory;
import org.apache.axis2.jaxws.ExceptionFactory;
import org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite;
@@ -58,50 +44,41 @@
import org.apache.commons.logging.LogFactory;
/**
- * The JAX-WS Service metadata and root of the JAX-WS Descritpion hierachy.
- */
-
-/*
-Working-design information.
-
-Description hierachy
- ServiceDescription
- EndpointDescription[]
- EndpointInterfaceDescription
- OperationDescription[]
- ParameterDescription Input[]
- ParameterDescription Output[]
- FaultDescription
-
-ServiceDescription:
-Corresponds to the generated Service class [client]; TBD [server]
-
-Java Name: Generated service class or null if dynamically configured service [client]; null [server]
-
-Axis2 Delegate: None (AxisService corresponds to a port which corresponds to the EndpointDescription)
-
-JSR-181 Annotations:
-@HandlerChain(file, name) [per JAXWS p. 105] Affects all proxies and dispatches created using any port on this service
-TBD
-
-WSDL Elements:
-<service
-
-JAX-WS Annotations:
-@WebServiceClient(name, targetNamespace, wsdlLocation)
-@WebEndpoint(name) This is specified on the getPortName() methods on the service
-TBD
-
-Properties available to JAXWS runtime:
-getEndpointDescription(QName port) Needed by HandlerResolver
-TBD
-
- */
-
-/**
- * ServiceDescription contains the metadata (e.g. WSDL, annotations) relating to a Service on both the
- * service-requester (aka client) and service-provider (aka server) sides.
+ * A ServiceDescription corresponds to a Service under which there can be a
+ * collection of enpdoints. In WSDL 1.1 terms, then, a ServiceDescription
+ * corresponds to a wsdl:Service under which there are one or more wsdl:Port
+ * entries. The ServiceDescription is the root of the metdata abstraction
+ * Description hierachy.
+ *
+ * The Description hierachy is:
+ * <pre>
+ * ServiceDescription
+ * EndpointDescription[]
+ * EndpointInterfaceDescription
+ * OperationDescription[]
+ * ParameterDescription[]
+ * FaultDescription[] (Note: Not implemented yet)
+ *
+ * <b>ServiceDescription details</b>
*
+ * CORRESPONDS TO:
+ * On the Client: The JAX-WS Service class or generated subclass.
+ *
+ * On the Server: The Service implementation. Note that there is a 1..1
+ * correspondence between a ServiceDescription and EndpointDescription
+ * on the server side.
+ *
+ * AXIS2 DELEGATE: None
+ *
+ * CHILDREN: 1..n EndpointDescription
+ *
+ * ANNOTATIONS:
+ * None
+ *
+ * WSDL ELEMENTS:
+ * service
+ *
+ * </pre>
*/
public class ServiceDescription {
private ClientConfigurationFactory clientConfigFactory;
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org