cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ericjohn...@apache.org
Subject svn commit: r695619 - in /cxf/trunk/rt/frontend: jaxws/src/main/java/org/apache/cxf/jaxws/ simple/src/main/java/org/apache/cxf/frontend/
Date Mon, 15 Sep 2008 20:54:43 GMT
Author: ericjohnson
Date: Mon Sep 15 13:54:43 2008
New Revision: 695619

URL: http://svn.apache.org/viewvc?rev=695619&view=rev
Log:
added some Javadoc comments

Modified:
    cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/JaxWsProxyFactoryBean.java
    cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/AbstractWSDLBasedEndpointFactory.java
    cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ClientProxyFactoryBean.java
    cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java

Modified: cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/JaxWsProxyFactoryBean.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/JaxWsProxyFactoryBean.java?rev=695619&r1=695618&r2=695619&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/JaxWsProxyFactoryBean.java
(original)
+++ cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/JaxWsProxyFactoryBean.java
Mon Sep 15 13:54:43 2008
@@ -47,6 +47,11 @@
 import org.apache.cxf.service.model.OperationInfo;
 import org.apache.cxf.service.model.ServiceInfo;
 
+/**
+* Factory for creating JAX-WS proxies, This class provides access to the 
+* internal properties used to set-up proxies. Using it provides more control 
+* than the standard JAX-WS APIs.
+*/
 public class JaxWsProxyFactoryBean extends ClientProxyFactoryBean {
     List<Handler> handlers = new ArrayList<Handler>();
     boolean loadHandlers = true;
@@ -58,10 +63,21 @@
         super(fact);
     }
 
+    /**
+          * Specifies a list of JAX-WS Handler implementations that are to be 
+          * used by the proxy.
+          * 
+          * @param h a <code>List</code> of <code>Handler</code>
objects
+          */
     public void setHandlers(List<Handler> h) {
         handlers.clear();
         handlers.addAll(h);
     }
+    /**
+           * Returns the configured list of JAX-WS handlers for the proxy.
+           *
+           * @return a <code>List</code> of <code>Handler</code>
objects
+           */
     public List<Handler> getHandlers() {
         return handlers;
     }
@@ -88,6 +104,11 @@
         return new Class[] {cls, BindingProvider.class};
     }
     
+    /**
+          * Creates a JAX-WS proxy that can be used to make remote invocations.
+          *
+          * @return the proxy. You must cast the returned object to the approriate class
before making remote calls
+          */
     @Override
     public Object create() {
         Object obj = super.create();

Modified: cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/AbstractWSDLBasedEndpointFactory.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/AbstractWSDLBasedEndpointFactory.java?rev=695619&r1=695618&r2=695619&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/AbstractWSDLBasedEndpointFactory.java
(original)
+++ cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/AbstractWSDLBasedEndpointFactory.java
Mon Sep 15 13:54:43 2008
@@ -397,6 +397,11 @@
         return serviceClass;
     }
 
+    /**
+          * Specifies the class implementing the service.
+          *
+          * @param serviceClass the service's implementaiton class
+          */
     public void setServiceClass(Class serviceClass) {
         this.serviceClass = serviceClass;
     }

Modified: cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ClientProxyFactoryBean.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ClientProxyFactoryBean.java?rev=695619&r1=695618&r2=695619&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ClientProxyFactoryBean.java
(original)
+++ cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ClientProxyFactoryBean.java
Mon Sep 15 13:54:43 2008
@@ -71,6 +71,11 @@
         this.getServiceFactory().setFeatures(features);
     }
 
+    /**
+           * Creates a proxy object that can be used to make remote invocations.
+           *
+           * @return the proxy. You must cast the returned object to the appropriate class
before using it.
+           */
     public Object create() {
         if (properties == null) {
             properties = new HashMap<String, Object>();
@@ -146,6 +151,11 @@
         return clientFactoryBean.getServiceClass();
     }
 
+    /**
+           * Specifies the class representing the SEI the proxy implements.
+           *
+           * @param serviceClass the SEI's class
+           */
     public void setServiceClass(Class serviceClass) {
         clientFactoryBean.setServiceClass(serviceClass);
     }
@@ -162,6 +172,12 @@
         return getWsdlURL();
     }
     
+    /**
+          * Specifies the URL where the proxy can find the WSDL defining the 
+          * service the proxy implements.
+          *
+          * @param wsdlURL a string containing the WSDL's URL
+          */
     public void setWsdlLocation(String wsdlURL) {
         setWsdlURL(wsdlURL);
     }
@@ -170,6 +186,12 @@
         return clientFactoryBean.getServiceFactory().getWsdlURL();
     }
 
+    /**
+          * Specifies the URL where the proxy can find the WSDL defining the 
+          * service the proxy implements.
+          *
+          * @param wsdlURL a string containing the WSDL's URL
+          */
     public void setWsdlURL(String wsdlURL) {
         clientFactoryBean.getServiceFactory().setWsdlURL(wsdlURL);
     }
@@ -182,10 +204,21 @@
         clientFactoryBean.setEndpointName(endpointName);
     }
 
+    /**
+           * Returns the QName of the WSDL service the proxy implements
+           * 
+           * @return the WSDL service's QName
+           */
     public QName getServiceName() {
         return getServiceFactory().getServiceQName();
     }
 
+    /**
+           * Specifies the QName of the WSDL service the proxy implements. The 
+           * service must exist or an error will result.
+           *
+           * @param serviceName the QName of the service for the proxy
+           */
     public void setServiceName(QName serviceName) {
         getServiceFactory().setServiceName(serviceName);
     }
@@ -231,10 +264,22 @@
         clientFactoryBean.setBus(bus);
     }
 
+    /**
+          * Returns the property map for the proxy factory.
+          *
+          * @return the property map
+          */
     public Map<String, Object> getProperties() {
         return properties;
     }
 
+    /**
+           * Specifies a set of properties used to configure the proxies 
+           * provided by the factory. These properties include things like 
+           * adding a namespace map to the JAXB databinding.
+           *
+           * @param properties the property map
+           */
     public void setProperties(Map<String, Object> properties) {
         this.properties = properties;
     }

Modified: cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
URL: http://svn.apache.org/viewvc/cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java?rev=695619&r1=695618&r2=695619&view=diff
==============================================================================
--- cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
(original)
+++ cxf/trunk/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
Mon Sep 15 13:54:43 2008
@@ -227,13 +227,22 @@
     }
 
     /**
-     * Whether or not the Server should be started upon creation.
-     * @return
-     */
+           * Whether or not the Server should be started upon creation.
+           *
+          * @return <code>false</code> if the server should not be started upon
creation
+          */
     public boolean isStart() {
         return start;
     }
 
+    /**
+           * Specifies if the Server should be started upon creation. The 
+           * default is for Servers to be started upon creation. Passing 
+           * <code>false</code> tells the factory that the Server will be 
+           * started manually using the start method.
+           *
+           * @param start <code>false</code> specifies that the Server will not
be started upon creation
+           */
     public void setStart(boolean start) {
         this.start = start;
     }
@@ -251,11 +260,11 @@
     }
 
     /**
-     * Set the backing service bean. If this is set a BeanInvoker is created for
-     * the provided bean.
-     *
-     * @return
-     */
+           * Sets the bean implementing the service. If this is set a 
+           * <code>BeanInvoker</code> is created for the provided bean.
+          *
+          * @param serviceBean an instantiated implementaiton object
+          */
     public void setServiceBean(Object serviceBean) {
         this.serviceBean = serviceBean;
     }
@@ -276,6 +285,13 @@
         this.invoker = invoker;
     }
 
+    /**
+          * Specifies the location of the WSDL defining the service interface 
+          * used by the factory to create services. Typically, the WSDL 
+          * location is specified as a URL.
+          * 
+          * @param locaiton the URL of the WSDL defining the service interface
+          */          
     public void setWsdlLocation(String location) {
         setWsdlURL(location);
     }
@@ -284,4 +300,4 @@
         return getWsdlURL();
     }
 
-}
+}
\ No newline at end of file



Mime
View raw message