You are viewing a plain text version of this content. The canonical link for it is here.
Posted to muse-commits@ws.apache.org by da...@apache.org on 2006/08/24 00:16:36 UTC

svn commit: r434211 - in /webservices/muse/trunk/modules: muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/ muse-wsx-api/src/org/apache/muse/ws/metadata/ muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/ muse-wsx-impl/src/org/apache/m...

Author: danj
Date: Wed Aug 23 15:16:34 2006
New Revision: 434211

URL: http://svn.apache.org/viewvc?rev=434211&view=rev
Log:
JavaDoc update for WS-MEx and WS-RMD/WS-MEx modules.

Modified:
    webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchange.java
    webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchangeClient.java
    webservices/muse/trunk/modules/muse-wsx-api/src/org/apache/muse/ws/metadata/WsxConstants.java
    webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/GetMetadataRequest.java
    webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/SimpleMetadataExchange.java
    webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/remote/MetadataExchangeClient.java

Modified: webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchange.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchange.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchange.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchange.java Wed Aug 23 15:16:34 2006
@@ -23,6 +23,20 @@
 import org.apache.muse.ws.resource.metadata.MetadataDescriptor;
 import org.apache.muse.ws.resource.metadata.WsrmdConstants;
 
+/**
+ * 
+ * WsrfMetadataExchange is an extension of the default WS-MEx implementation, 
+ * {@linkplain SimpleMetadataExchange SimpleMetadataExchange}, which supports 
+ * the WS0RF WS-ResourceMetadataDescriptor dialect. Calls to getMetadata() 
+ * that use the WS-RMD namespace as the dialect will get the resource's 
+ * metadata descriptor XML in response.
+ *
+ * @author Dan Jemiolo (danj)
+ * 
+ * @see WsrmdConstants#NAMESPACE_URI
+ *
+ */
+
 public class WsrfMetadataExchange extends SimpleMetadataExchange
 {
     public Element[] getMetadata(String dialect)

Modified: webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchangeClient.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchangeClient.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchangeClient.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-rmd/src/org/apache/ws/resource/properties/metadata/ext/WsrfMetadataExchangeClient.java Wed Aug 23 15:16:34 2006
@@ -27,6 +27,18 @@
 import org.apache.muse.ws.resource.metadata.WsrmdConstants;
 import org.apache.muse.ws.resource.metadata.impl.SimpleMetadataDescriptor;
 
+/**
+ * 
+ * WsrfMetadataExchangeClient is an extension of Muse's 
+ * {@linkplain MetadataExchangeClient MetadataExchangeClient} to include 
+ * a convenience method for retrieving the resource's metadata descriptor. 
+ * The getRMD() method calls getMetadata() with the WS-RMD dialect and 
+ * returns the resulting XML as a metadata descriptor object.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
 public class WsrfMetadataExchangeClient extends MetadataExchangeClient
 {
     public WsrfMetadataExchangeClient(EndpointReference destination, EndpointReference source, Environment environment)

Modified: webservices/muse/trunk/modules/muse-wsx-api/src/org/apache/muse/ws/metadata/WsxConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsx-api/src/org/apache/muse/ws/metadata/WsxConstants.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsx-api/src/org/apache/muse/ws/metadata/WsxConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsx-api/src/org/apache/muse/ws/metadata/WsxConstants.java Wed Aug 23 15:16:34 2006
@@ -30,28 +30,28 @@
  */
 
 public class WsxConstants
-{
+{    
     public static final String NAMESPACE_URI = "http://schemas.xmlsoap.org/ws/2004/09/mex";
     
     public static final String PREFIX = "wsx";
     
-    public static final String GET_METADATA_URI = NAMESPACE_URI + "/GetMetadata";
+    public static final String DIALECT = "Dialect";
+    
+    public static final QName DIALECT_QNAME = 
+        new QName(NAMESPACE_URI, "Dialect", PREFIX);
     
     public static final String GET_METADATA_CAPABILITY = NAMESPACE_URI;
     
     public static final QName GET_METADATA_QNAME = 
         new QName(NAMESPACE_URI, "GetMetadata", PREFIX);
     
-    public static final QName DIALECT_QNAME = 
-        new QName(NAMESPACE_URI, "Dialect", PREFIX);
+    public static final String GET_METADATA_URI = NAMESPACE_URI + "/GetMetadata";
     
     public static final QName METADATA_QNAME = 
         new QName(NAMESPACE_URI, "Metadata", PREFIX);
     
     public static final QName SECTION_QNAME = 
         new QName(NAMESPACE_URI, "MetadataSection", PREFIX);
-    
-    public static final String DIALECT = "Dialect";
     
     public static final String WSDL_DIALECT = WsdlUtils.NAMESPACE_URI;
 }

Modified: webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/GetMetadataRequest.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/GetMetadataRequest.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/GetMetadataRequest.java (original)
+++ webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/GetMetadataRequest.java Wed Aug 23 15:16:34 2006
@@ -39,14 +39,14 @@
     //
     private String _dialect = null;
     
-    public GetMetadataRequest(String dialect)
+    public GetMetadataRequest(Element request)
     {
-        _dialect = dialect;
+        _dialect = XmlUtils.getElementText(request, WsxConstants.DIALECT_QNAME);
     }
     
-    public GetMetadataRequest(Element request)
+    public GetMetadataRequest(String dialect)
     {
-        _dialect = XmlUtils.getElementText(request, WsxConstants.DIALECT_QNAME);
+        _dialect = dialect;
     }
     
     public String getDialect()

Modified: webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/SimpleMetadataExchange.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/SimpleMetadataExchange.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/SimpleMetadataExchange.java (original)
+++ webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/impl/SimpleMetadataExchange.java Wed Aug 23 15:16:34 2006
@@ -65,13 +65,6 @@
         return handler;
     }
     
-    public void initialize() 
-        throws SoapFault
-    {
-        super.initialize();
-        setMessageHandler(createGetMetadataHandler());
-    }
-    
     public Element[] getMetadata(String dialect)
     {
         //
@@ -114,5 +107,12 @@
         WsdlUtils.removeSchemaReferences(wsdl);
         
         return wsdl;
+    }
+    
+    public void initialize() 
+        throws SoapFault
+    {
+        super.initialize();
+        setMessageHandler(createGetMetadataHandler());
     }
 }

Modified: webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/remote/MetadataExchangeClient.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/remote/MetadataExchangeClient.java?rev=434211&r1=434210&r2=434211&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/remote/MetadataExchangeClient.java (original)
+++ webservices/muse/trunk/modules/muse-wsx-impl/src/org/apache/muse/ws/metadata/remote/MetadataExchangeClient.java Wed Aug 23 15:16:34 2006
@@ -27,6 +27,16 @@
 import org.apache.muse.ws.metadata.WsxConstants;
 import org.apache.muse.ws.metadata.impl.GetMetadataRequest;
 
+/**
+ * 
+ * MetadataExchangeClient is a client for invoking the web services operations 
+ * in WS-MetadataExchange 09/2004. It also have a convenience method, getWSDL(), 
+ * that allows users to get the WSDL document for a resource without calling 
+ * getMetadata() and parsing the results.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
 
 public class MetadataExchangeClient extends AbstractResourceClient
 {
@@ -75,6 +85,15 @@
         return metadata;
     }
     
+    /**
+     * 
+     * This is a convenience method that calls getMetadata(String) with the 
+     * WSDL dialect.
+     * 
+     * @return The WSDL document for the resource, or null if the dialect 
+     *         is not supported.
+     *
+     */
     public Element getWSDL()
         throws SoapFault
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org