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 ja...@apache.org on 2005/06/22 08:56:00 UTC
svn commit: r191774 -
/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/
Author: jayachandra
Date: Tue Jun 21 23:55:58 2005
New Revision: 191774
URL: http://svn.apache.org/viewcvs?rev=191774&view=rev
Log:
this completes javadoc addition for all my files
Modified:
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/AsyncHandler.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Binding.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/BindingProvider.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Call.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Dispatch.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCContext.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCException.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/LogicalMessage.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/NamespaceConstants.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ParameterMode.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ProtocolException.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Provider.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Response.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Service.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceException.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceFactory.java
webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Stub.java
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/AsyncHandler.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/AsyncHandler.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/AsyncHandler.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/AsyncHandler.java Tue Jun 21 23:55:58 2005
@@ -7,15 +7,20 @@
package javax.xml.rpc;
/**
+ * Interface AsyncHandler<T>
+ * The javax.xml.rpc.AsyncHandler interface is implemented by clients that wish to receive callback notification of the completion of service endpoint operations invoked asynchronously.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
-public class AsyncHandler {
+public interface AsyncHandler<T> {
+
+ /**
+ * Method handleResponse
+ * Called when the response to an asynchronous operation is available.
+ *
+ * @param res - The response to the operation invocation.
+ */
+ void handleResponse(Response<T> res) ;
- void handleResponse(Response<T> res) {
-
- }
-
}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Binding.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Binding.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Binding.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Binding.java Tue Jun 21 23:55:58 2005
@@ -7,15 +7,39 @@
package javax.xml.rpc;
import java.util.List;
+import javax.xml.rpc.handler.HandlerInfo;
+import javax.xml.rpc.security.SecurityConfiguration;
/**
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface Binding {
+ /**
+ * Method getHandlerChain
+ * Gets the handler chain for protocol binding instance. The returned List is used to configure the handler chain.
+ *
+ * @return java.util.List Handler chain
+ */
List<HandlerInfo> getHandlerChain();
-
+
+ /**
+ * Method setHandlerChain
+ * Sets the handler chain for the protocol binding instance.
+ *
+ * @param chain - A List of handler configuration entries
+ * @throws JAXRPCException - On an error in the configuration of the handler chain
+ java.lang.UnsupportedOperationException - If this operation is not supported. This may be done to avoid any overriding of a pre-configured handler chain.
+ */
+ void setHandlerChain(java.util.List<HandlerInfo> chain) throws JAXRPCException;
+
+ /**
+ * Method getSecurityConfiguration
+ * Gets the SecurityConfiguration for this Binding object.
+ *
+ * @return The SecurityConfiguration for this Binding object.
+ * @throws java.lang.UnsupportedOperationException - if the Binding class does not support the configuration of SecurityConfiguration.
+ */
+ SecurityConfiguration getSecurityConfiguration() throws java.lang.UnsupportedOperationException;
+
}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/BindingProvider.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/BindingProvider.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/BindingProvider.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/BindingProvider.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,11 @@
package javax.xml.rpc;
/**
+ * Interface BindingProvider
+ * The javax.xml.rpc.BindingProvider interface provides access to the protocol binding and associated JAXRPCContext objects for request and response message processing.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface BindingProvider {
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Call.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Call.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Call.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Call.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,12 @@
package javax.xml.rpc;
/**
+ * Interface Call
+ * The javax.xml.rpc.Call interface provides support for the dynamic invocation of a service endpoint. The javax.xml.rpc.Service interface acts as a factory for the creation of Call instances.
+ * Once a Call instance is created, various setter and getter methods may be used to configure this Call instance.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface Call extends BindingProvider{
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Dispatch.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Dispatch.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Dispatch.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Dispatch.java Tue Jun 21 23:55:58 2005
@@ -7,11 +7,54 @@
package javax.xml.rpc;
/**
+ * Interface Dispatch<T>
+ * The javax.xml.rpc.Dispatch interface provides support for the dynamic invocation of a service endpoint operations. The javax.xml.rpc.Service interface acts as a factory for the creation of Dispatch instances.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface Dispatch<T> {
+
+ /**
+ * Method invoke
+ * Invoke a service operation synchronously. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.
+ *
+ * @param msg - An object that will form the message or payload of the message used to invoke the operation.
+ * @return The response message or message payload to the operation invocation.
+ * @throws java.rmi.RemoteException - If a fault occurs during communication with the service
+ * @throws JAXRPCException - If there is any error in the configuration of the Dispatch instance.
+ */
+ T invoke(T msg) throws java.rmi.RemoteException;
+
+ /**
+ * Method invokeAsync
+ * Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are obtained by polling the returned Response. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.
+ *
+ * @param msg - An object that will form the message or payload of the message used to invoke the operation.
+ * @return The response message or message payload to the operation invocation.
+ * @throws JAXRPCException - If there is any error in the configuration of the Dispatch instance.
+ */
+ Response<T> invokeAsync(T msg) throws JAXRPCException
+
+ /**
+ * Method invokeAsync
+ * Invoke a service operation asynchronously. The method returns without waiting for the response to the operation invocation, the results of the operation are communicated to the client via the passed in handler. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.
+ *
+ * @param msg - An object that will form the message or payload of the message used to invoke the operation.
+ * @param handler - The handler object that will receive the response to the operation invocation.
+ * @return A Future object that may be used to check the status of the operation invocation. This object must not be used to try to obtain the results of the operation - the object returned from Future.get() is implementation dependent and any use of it will result in non-portable behaviour.
+ * @throws JAXRPCException - If there is any error in the configuration of the Dispatch instance
+ */
+ java.util.concurrent.Future<?> invokeAsync(T msg,
+ AsyncHandler<T> handler) throws JAXRPCException;
+
+ /**
+ * Method invokeOneWay
+ * Invokes a service operation using the one-way interaction mode. The operation invocation is logically non-blocking, subject to the capabilities of the underlying protocol, no results are returned. When the protocol in use is SOAP/HTTP, this method must block until an HTTP response code has been received or an error occurs. The client is responsible for ensuring that the msg object when marshalled is formed according to the requirements of the protocol binding in use.
+ *
+ * @param msg - An object that will form the message or payload of the message used to invoke the operation.
+ * @throws JAXRPCException - If there is any error in the configuration of the Dispatch instance or if an error occurs during the invocation.
+ */
+ void invokeOneWay(T msg) throws JAXRPCException;
}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCContext.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCContext.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCContext.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCContext.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,11 @@
package javax.xml.rpc;
/**
+ * Interface JAXRPCContext
+ * The JAXRPCContext interface provides an extensible property mechanism that may be used to configure BindingProvider instances and to pass imformation between applications and handlers.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface JAXRPCContext {
/**
@@ -18,67 +19,67 @@
* Type: java.util.Map
*/
static final java.lang.String MESSAGE_ATTACHMENTS = null;
-
+
/**
* Standard property: input source for WSDL document.
* Type: org.xml.sax.InputSource
*/
static final java.lang.String WSDL_DESCRIPTION = null;
-
+
/**
* Standard property: name of WSDL service.
* Type: javax.xml.namespace.QName
*/
static final java.lang.String WSDL_SERVICE = null;
-
+
/**
* Standard property: name of WSDL port.
* Type: javax.xml.namespace.QName
*/
static final java.lang.String WSDL_PORT = null;
-
+
/**
* Standard property: name of wsdl interface (2.0) or port type (1.1).
* Type: javax.xml.namespace.QName
*/
static final java.lang.String WSDL_INTERFACE = null;
-
+
/**
* Standard property: name of WSDL operation.
* Type: javax.xml.namespace.QName
*/
static final java.lang.String WSDL_OPERATION = null;
-
+
/**
* Method setProperty
* Sets the name and value of a property associated with the context. If the context contains a value of the same property, the old value is replaced.
* @param name Name of the property associated with the context
- * @param value Value of the property
+ * @param value Value of the property
* @throws java.lang.IllegalArgumentException If some aspect of the property is prevents it from being stored in the context
*/
void setProperty(java.lang.String name,
java.lang.Object value) throws java.lang.IllegalArgumentException;
-
+
/**
* Method removeProperty
- * Removes a property (name-value pair) from the context
+ * Removes a property (name-value pair) from the context
* @param name Name of the property to be removed
* @throws java.lang.IllegalArgumentException if an illegal property name is specified
*/
void removeProperty(java.lang.String name) throws java.lang.IllegalArgumentException;
-
+
/**
* Method getProperty
* Gets the value of a specific property from the MessageContext
* @param name Name of the property whose value is to be retrieved
- * @return Value of the property
+ * @return Value of the property
* @throws java.lang.IllegalArgumentException if an illegal property name is specified
*/
java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException;
-
+
/**
* Method getPropertyNames
- * Returns an Iterator view of the names of the properties in this context
+ * Returns an Iterator view of the names of the properties in this context
* @return Iterator for the property names
*/
java.util.Iterator getPropertyNames();
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCException.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCException.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCException.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/JAXRPCException.java Tue Jun 21 23:55:58 2005
@@ -24,15 +24,15 @@
/**
* Constructor
* Constructs a new exception with the specified detail message.
- * @param message
+ * @param message - The detail message which is later retrieved using the getMessage method
*/
public JAXRPCException(java.lang.String message) {}
/**
* Constructor
* Constructs a new exception with the specified detail message and cause.
- * @param message
- * @param cause
+ * @param message - The detail message which is later retrieved using the getMessage method
+ * @param cause - The cause which is saved for the later retrieval throw by the getCause method
*/
public JAXRPCException(java.lang.String message,
java.lang.Throwable cause) {}
@@ -42,7 +42,7 @@
* Constructs a new JAXRPCException with the specified cause and a detail
* message of (cause==null ? null : cause.toString()) (which typically
* contains the class and detail message of cause).
- * @param cause
+ * @param cause - The cause which is saved for the later retrieval throw by the getCause method. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public JAXRPCException(java.lang.Throwable cause){}
@@ -51,7 +51,7 @@
* Gets the Linked cause
* @deprecated Retained for backwards compatility, new applications should
* use the standard cause mechanism.
- * @return
+ * @return The cause of this Exception or null if the cause is noexistent or unknown
*/
public java.lang.Throwable getLinkedCause() {
return null;
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/LogicalMessage.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/LogicalMessage.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/LogicalMessage.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/LogicalMessage.java Tue Jun 21 23:55:58 2005
@@ -7,11 +7,12 @@
package javax.xml.rpc;
/**
- * @author sunja07
- *
* Interface LogicalMessage
* The LogicalMessage interface represents a protocol agnostic XML message
* and contains methods that provide access to the payload of the message.
+ *
+ * @version 1.0
+ * @author sunja07
*/
public interface LogicalMessage {
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/NamespaceConstants.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/NamespaceConstants.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/NamespaceConstants.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/NamespaceConstants.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,11 @@
package javax.xml.rpc;
/**
+ * Class NamespaceConstants
+ * Constants used in JAX-RPC for namespace prefixes and URIs
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public class NamespaceConstants {
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ParameterMode.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ParameterMode.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ParameterMode.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ParameterMode.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,12 @@
package javax.xml.rpc;
/**
+ * Class ParameterMode
+ * The javax.xml.rpc.ParameterMode is a type-safe enumeration for parameter mode. This class is used in the CallAPI to specify parameter passing modes.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
+ * @see Call
*/
public class ParameterMode {
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ProtocolException.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ProtocolException.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ProtocolException.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ProtocolException.java Tue Jun 21 23:55:58 2005
@@ -9,16 +9,11 @@
import java.io.Serializable;
/**
+ * Class ProtocolException
+ * The javax.xml.rpc.ProtocolException interface is a marker base class for exceptions related to a specific protocol binding. Subclasses are used to communicate protocol level fault information to clients and may be used on the server to control the protocol specific fault representation.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
- */
-/**
- * @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public class ProtocolException extends RuntimeException implements Serializable {
@@ -31,7 +26,7 @@
/**
* Constructor
* Constructs a new protocol exception with the specified detail message.
- * @param message
+ * @param message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.
*/
public ProtocolException(java.lang.String message) {}
@@ -39,8 +34,8 @@
* Constructor
* Constructs a new runtime exception with the specified detail message and
* cause.
- * @param message
- * @param cause
+ * @param message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
+ * @param cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public ProtocolException(java.lang.String message,
java.lang.Throwable cause) {}
@@ -50,7 +45,7 @@
* Constructs a new runtime exception with the specified cause and a detail
* message of (cause==null ? null : cause.toString()) (which typically
* contains the class and detail message of cause).
- * @param cause
+ * @param cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public ProtocolException(java.lang.Throwable cause) {}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Provider.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Provider.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Provider.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Provider.java Tue Jun 21 23:55:58 2005
@@ -7,11 +7,24 @@
package javax.xml.rpc;
/**
+ * Interface Provider<T>
+ * Service endpoints may implement the Provider interface as a dynamic alternative to an SEI. Implementations are required to support Provider<Source> and Provider<SOAPMessage>. The ServiceMode annotation can be used to control whether the Provider instance will receive entire protocol messages or just message payloads.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public interface Provider<T> {
+
+ /**
+ * Method invoke
+ * Invokes an operation occording to the contents of the request message.
+ *
+ * @param request - The request message or message payload.
+ * @param context - The context of the request message. This provides access to the properties of the underlying handler MessageContext that have a scope of APPLICATION. The content of the context may be modified and will be reused as the context for any response message.
+ * @return The response message or message payload. May be null if there is no response.
+ * @throws java.rmi.RemoteException - if there is an error processing request. The cause of the RemoteException may be set to a subclass of ProtocolException to control the protocol level representation of the exception.
+ */
+ T invoke(T request, JAXRPCContext context)
+ throws java.rmi.RemoteException;
}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Response.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Response.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Response.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Response.java Tue Jun 21 23:55:58 2005
@@ -9,13 +9,18 @@
import java.util.concurrent.Future<T>;
/**
+ * Interface Response<T>
+ *
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
//TODO: Needs a revisit, b'coz generics are involved.
-public interface Response extends java.util.concurrent.Future<T> {
+public interface Response<T> extends java.util.concurrent.Future<T> {
+ /**
+ * Method getContext
+ * Gets the contained response context.
+ *
+ * @return The contained response context. May be null if a response is not yet available.
+ */
JAXRPCContext getContext();
}
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Service.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Service.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Service.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Service.java Tue Jun 21 23:55:58 2005
@@ -11,26 +11,21 @@
import javax.xml.rpc.handler.HandlerRegistry;
/**
- * @author sunja07
- *
* Interface Service
* Service acts as a factory of the following:
* 1. Instance of javax.xml.rpc.Dispatch for dynamic message-oriented invocation of a remote operation.
* 2. Instance of javax.xml.rpc.Call for the dynamic invocation of a remote operation on the target service endpoint.
* 3. Instance of a generated stub class.
* 4. Dynamic proxy for the target service endpoint.
- */
-/**
- * @author sunja07
*
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
+ * @version 2.0
+ * @author sunja07
*/
public interface Service {
/**
* I've tried to create a nested class in here. Absolutely
- * needs a revisit. Don't rely on this as it is now.
+ * needs a revisit. Don't rely on this as it exists now.
*/
public static enum Mode extends java.lang.Enum<Service.Mode> {
@@ -47,7 +42,9 @@
* </code>
* @return
*/
- public static final Mode[] values();
+ public static final Mode[] values() {
+ return null;
+ }
/**
* Method valueOf
@@ -56,7 +53,9 @@
* @return the enum constant with the specified name
* @throws java.lang.IllegalArgumentException if this enum type has no constant with the specified name
*/
- public static Service.Mode valueOf(java.lang.String name) throws java.lang.IllegalArgumentException;
+ public static Service.Mode valueOf(java.lang.String name) throws java.lang.IllegalArgumentException {
+ return null;
+ }
}
@@ -103,20 +102,40 @@
java.lang.String endpointAddress)
throws ServiceException;
- /* This involves generics, needs a revisit
+ // This involves generics, needs a revisit
+ /**
+ * Method createDispatch
+ * Creates a Dispatch instance for use with objects of the users choosing.
+ *
+ * @param - Qualified name for the target service endpoint
+ * @param - The class of object used to messages or message payloads. Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * @param - Controls whether the created dispatch instance is message or payload oriented, i.e. whether the user will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the user will work with SOAP messages or the contents of a SOAP body. Mode must be MESSAGE when type is SOAPMessage.
+ * @return Dispatch instance
+ * @throws ServiceException - If any error in the creation of the Dispatch object
+ * @see javax.xml.transform.Source, javax.xml.soap.SOAPMessage
+ */
<T> Dispatch<T> createDispatch(javax.xml.namespace.QName portName,
java.lang.Class<T> type,
Service.Mode mode)
throws ServiceException;
- */
-
- /* This involves generics, needs a revisit
+
+ // This involves generics, needs a revisit
+ /**
+ * Method createDispatch
+ * Creates a Dispatch instance for use with JAXB generated objects.
+ *
+ * @param portName - Qualified name for the target service endpoint
+ * @param context - The JAXB context used to marshall and unmarshall messages or message payloads.
+ * @param mode - Controls whether the created dispatch instance is message or payload oriented, i.e. whether the user will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the user will work with SOAP messages or the contents of a SOAP body.
+ * @return Dispatch instance
+ * @throws ServiceException - If any error in the creation of the Dispatch object
+ * @see JAXBContext
+ */
Dispatch<java.lang.Object> createDispatch(javax.xml.namespace.QName portName,
javax.xml.bind.JAXBContext context,
Service.Mode mode)
throws ServiceException;
- */
-
+
/**
* Method getCalls
* Gets an array of preconfigured Call objects for invoking operations on the specified port. There is one Call object per operation that can be invoked on the specified port. Each Call object is pre-configured and does not need to be configured using the setter methods on Call interface.
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceException.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceException.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceException.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceException.java Tue Jun 21 23:55:58 2005
@@ -26,15 +26,15 @@
/**
* Constructor
* Constructs a new exception with the specified detail message.
- * @param message
+ * @param message - The detail message which is later retrieved using the getMessage method
*/
public ServiceException(java.lang.String message) {}
/**
* Constructor
* Constructs a new exception with the specified detail message and cause.
- * @param message
- * @param cause
+ * @param message - The detail message which is later retrieved using the getMessage method
+ * @param cause - The cause which is saved for the later retrieval throw by the getCause method
*/
public ServiceException(java.lang.String message,
java.lang.Throwable cause) {}
@@ -44,14 +44,14 @@
* Constructs a new exception with the specified cause and a detail message
* of (cause==null ? null : cause.toString()) (which typically contains
* the class and detail message of cause).
- * @param cause
+ * @param cause - The cause which is saved for the later retrieval throw by the getCause method. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public ServiceException(java.lang.Throwable cause) {}
/**
* Method getLinkedCause
* Gets the Linked cause
- * @return
+ * @return The cause of this Exception or null if the cause is noexistent or unknown
*/
public java.lang.Throwable getLinkedCause() {
return null;
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceFactory.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceFactory.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/ServiceFactory.java Tue Jun 21 23:55:58 2005
@@ -7,10 +7,12 @@
package javax.xml.rpc;
/**
+ * Class ServiceFactory
+ * The javax.xml.rpc.ServiceFactory is an abstract class that provides a factory for the creation of instances of the type javax.xml.rpc.Service. This abstract class follows the abstract static factory design pattern. This enables a J2SE based client to create a Service instance in a portable manner without using the constructor of the Service implementation class.
+ * The ServiceFactory implementation class is set using the system property SERVICEFACTORY_PROPERTY.
+ *
+ * @version 1.1
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
public abstract class ServiceFactory {
Modified: webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Stub.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Stub.java?rev=191774&r1=191773&r2=191774&view=diff
==============================================================================
--- webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Stub.java (original)
+++ webservices/axis/trunk/archive/java/scratch/ashu_jaya_venkat/JAX-WS2/javax/xml/rpc/Stub.java Tue Jun 21 23:55:58 2005
@@ -7,11 +7,45 @@
package javax.xml.rpc;
/**
+ * Interface Stub
+ * The interface javax.xml.rpc.Stub is the common base interface for the stub classes. All generated stub classes are required to implement the javax.xml.rpc.Stub interface. An instance of a stub class represents a client side proxy or stub instance for the target service endpoint.
+ * The javax.xml.rpc.Stub interface provides an extensible property mechanism for the dynamic configuration of a stub instance.
+ *
+ * @version 1.0
* @author sunja07
- *
- * TODO To change the template for this generated type comment go to
- * Window - Preferences - Java - Code Style - Code Templates
*/
-public interface Stub {
+public interface Stub extends BindingProvider{
+
+ /**
+ * Method _setProperty
+ * Sets the name and value of a configuration property for this Stub instance. This method is retained for backwards compatibility, new code should use getRequestContext().setProperty(...) instead. If the Stub instances contains a value of the same property, the old value is replaced.
+ * Note that the _setProperty method may not perform validity check on a configured property value. An example is the standard property for the target service endpoint address that is not checked for validity in the _setProperty method. In this case, stub configuration errors are detected at the remote method invocation.
+ *
+ * @param name - Name of the configuration property
+ * @param value - Value of the property
+ * @throws JAXRPCException -
+ * 1. If an optional standard property name is specified, however this Stub implementation class does not support the configuration of this property.
+ * 2. If an invalid or unsupported property name is specified or if a value of mismatched property type is passed.
+ * 3. If there is any error in the configuration of a valid property.
+ */
+ void _setProperty(java.lang.String name, java.lang.Object value) throws JAXRPCException;
+
+ /**
+ * Method _getProperty
+ * Gets the value of a specific configuration property. This method is retained for backwards compatibility, new code should use getRequestContext().getProperty(...) instead.
+ *
+ * @param name - Name of the property whose value is to be retrieved
+ * @return Value of the configuration property
+ * @throws JAXRPCException - if an invalid or unsupported property name is passed.
+ */
+ java.lang.Object _getProperty(java.lang.String name) throws JAXRPCException;
+
+ /**
+ * Method _getPropertyNames
+ * Returns an Iterator view of the names of the properties that can be configured on this stub instance. This method is retained for backwards compatibility, new code should use getRequestContext().getPropertyNames(...) instead.
+ *
+ * @return Iterator for the property names of the type java.lang.String
+ */
+ java.util.Iterator _getPropertyNames();
}