dims 2002/06/14 08:37:45
Modified: java/src/javax/xml/rpc/handler GenericHandler.java
Handler.java HandlerChain.java HandlerInfo.java
HandlerRegistry.java MessageContext.java
java/src/javax/xml/rpc/handler/soap SOAPMessageContext.java
java/src/javax/xml/rpc/holders BigDecimalHolder.java
BigIntegerHolder.java BooleanHolder.java
BooleanWrapperHolder.java ByteArrayHolder.java
ByteHolder.java ByteWrapperHolder.java
CalendarHolder.java DoubleHolder.java
DoubleWrapperHolder.java FloatHolder.java
FloatWrapperHolder.java Holder.java IntHolder.java
IntegerWrapperHolder.java LongHolder.java
LongWrapperHolder.java ObjectHolder.java
QNameHolder.java ShortHolder.java
ShortWrapperHolder.java StringHolder.java
java/src/javax/xml/rpc/server ServiceLifecycle.java
ServletEndpointContext.java
java/src/javax/xml/rpc/soap SOAPFaultException.java
Log:
Updating javadocs for the following packages: (Cut-n-Paste from 1.0 JAXRPC javadoc)
javax.xml.rpc.handler
javax.xml.rpc.handler.soap
javax.xml.rpc.holders
javax.xml.rpc.server
javax.xml.rpc.soap
Revision Changes Path
1.5 +44 -26 xml-axis/java/src/javax/xml/rpc/handler/GenericHandler.java
Index: GenericHandler.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/GenericHandler.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- GenericHandler.java 11 Jun 2002 14:53:50 -0000 1.4
+++ GenericHandler.java 14 Jun 2002 15:37:44 -0000 1.5
@@ -56,15 +56,23 @@
import javax.xml.namespace.QName;
-// Referenced classes of package javax.xml.rpc.handler:
-// Handler, MessageContext, HandlerInfo
-
/**
- * The javax.xml.rpc.handler.GenericHandler class implements the Handler interface.
SOAP Message Handler developers
- * should typically subclass GenericHandler class unless the Handler class needs
another class as a superclass.
+ * The <code>javax.xml.rpc.handler.GenericHandler</code> class
+ * implements the <code>Handler</code> interface. SOAP Message
+ * Handler developers should typically subclass
+ * <code>GenericHandler</code> class unless the Handler class
+ * needs another class as a superclass.
+ *
* <p>
- * The GenericHandler class is a convenience abstract class that makes writing
Handlers easy. This class provides
- * default implementations of the lifecycle methods init and destroy and also
different handle methods. A Handler developer should only override methods that it
needs to specialize as part of the derived Handler implementation class.
+ * The <code>GenericHandler</code> class is a convenience abstract
+ * class that makes writing Handlers easy. This class provides
+ * default implementations of the lifecycle methods <code>init</code>
+ * and <code>destroy</code> and also different handle methods.
+ * A Handler developer should only override methods that it needs
+ * to specialize as part of the derived <code>Handler</code>
+ * implementation class.
+ *
+ * @version 1.0
*/
public abstract class GenericHandler implements Handler {
@@ -74,12 +82,14 @@
protected GenericHandler() {}
/**
- * The handleRequest method processes the request SOAP message. The default
implementation of this method returns
- * true. This indicates that the handler chain should continue processing of
the request SOAP message. This method
- * should be overridden if the derived Handler class needs to specialize
implementation of this method.
+ * The <code>handleRequest</code> method processes the request
+ * SOAP message. The default implementation of this method returns
+ * <code>true</code>. This indicates that the handler chain
+ * should continue processing of the request SOAP message.
+ * This method should be overridden if the derived Handler class
+ * needs to specialize implementation of this method.
*
* @param context the message context
- *
* @return true/false
*/
public boolean handleRequest(MessageContext context) {
@@ -87,12 +97,14 @@
}
/**
- * The handleResponse method processes the response message. The default
implementation of this method returns
- * true. This indicates that the handler chain should continue processing of
the response SOAP message. This
- * method should be overridden if the derived Handler class needs to specialize
implementation of this method.
+ * The <code>handleResponse</code> method processes the response
+ * message. The default implementation of this method returns
+ * <code>true</code>. This indicates that the handler chain
+ * should continue processing of the response SOAP message.
+ * This method should be overridden if the derived Handler class
+ * needs to specialize implementation of this method.
*
* @param context the message context
- *
* @return true/false
*/
public boolean handleResponse(MessageContext context) {
@@ -100,13 +112,15 @@
}
/**
- * The handleFault method processes the SOAP faults based on the SOAP message
processing model. The default
- * implementation of this method returns true. This indicates that the handler
chain should continue processing
- * of the SOAP fault. This method should be overridden if the derived Handler
class needs to specialize
- * implementation of this method.
+ * The <code>handleFault</code> method processes the SOAP faults
+ * based on the SOAP message processing model. The default
+ * implementation of this method returns <code>true</code>. This
+ * indicates that the handler chain should continue processing
+ * of the SOAP fault. This method should be overridden if
+ * the derived Handler class needs to specialize implementation
+ * of this method.
*
* @param context the message context
- *
* @return true/false
*/
public boolean handleFault(MessageContext context) {
@@ -114,24 +128,28 @@
}
/**
- * The init method to enable the Handler instance to initialize itself. This
method should be overridden if the
- * derived Handler class needs to specialize implementation of this method
+ * The <code>init</code> method to enable the Handler instance to
+ * initialize itself. This method should be overridden if
+ * the derived Handler class needs to specialize implementation
+ * of this method.
*
* @param config handler configuration
*/
public void init(HandlerInfo config) {}
/**
- * The destroy method indicates the end of lifecycle for a Handler instance.
This method should be overridden
- * if the derived Handler class needs to specialize implementation of this
method.
+ * The <code>destroy</code> method indicates the end of lifecycle
+ * for a Handler instance. This method should be overridden if
+ * the derived Handler class needs to specialize implementation
+ * of this method.
*/
public void destroy() {}
/**
* Gets the header blocks processed by this Handler instance.
*
- * @return Array of QNames of header blocks processed by this handler instance.
QName is the qualified name of
- * the outermost element of the Header block.
+ * @return Array of QNames of header blocks processed by this handler instance.
+ * <code>QName</code> is the qualified name of the outermost element of the
Header block.
*/
public abstract QName[] getHeaders();
}
1.5 +141 -47 xml-axis/java/src/javax/xml/rpc/handler/Handler.java
Index: Handler.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/Handler.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Handler.java 11 Jun 2002 14:53:50 -0000 1.4
+++ Handler.java 14 Jun 2002 15:37:44 -0000 1.5
@@ -58,78 +58,170 @@
import javax.xml.namespace.QName;
/**
- * A handler provides a mechanism for processing of service
- * context, plugging in additional RPC processing behavior and
- * enhancing functionality of a JAX-RPC runtime system.
- * <p>A JAX-RPC handler is required to implement the
- * <code>javax.xml.rpc.handler.Handler</code> interface.
+ * The <code>javax.xml.rpc.handler.Handler</code> interface is
+ * required to be implemented by a SOAP message handler. The
+ * <code>handleRequest</code>, <code>handleResponse</code>
+ * and <code>handleFault</code> methods for a SOAP message
+ * handler get access to the <code>SOAPMessage</code> from the
+ * <code>SOAPMessageContext</code>. The implementation of these
+ * methods can modify the <code>SOAPMessage</code> including the
+ * headers and body elements.
+ *
+ * @version 1.0
*/
public interface Handler {
/**
- * The handleRequest method processes the request message.
+ * The <code>handleRequest</code> method processes the request message.
*
- * @param context - MessageContext parameter provides access to the request
+ * @param context MessageContext parameter provides access to the request
* message.
- *
- * @throws JAXRPCException - if any handler specific runtime error happens.
- * The HandlerChain terminates the further processing of this
- * handler chain.
- * SOAPFaultException - if SOAP fault is generated by this handler.
- * The HandlerChain catches this exception, terminates the further
- * processing of the request handlers in this handler chain and
- * invokes the handleFault method on this handler
+ * @return boolean boolean Indicates the processing mode
+ * <ul>
+ * <li>Return <code>true</code> to indicate continued
+ * processing of the request handler chain. The
+ * <code>HandlerChain</code>
+ * takes the responsibility of invoking the next
+ * entity. The next entity may be the next handler
+ * in the <code>HandlerChain</code> or if this
+ * handler is the last handler in the chain, the
+ * next entity is the service endpoint object.
+ * <li>Return <code>false</code> to indicate blocking
+ * of the request handler chain. In this case,
+ * further processing of the request handler chain
+ * is blocked and the target service endpoint is
+ * not dispatched. The JAX-RPC runtime system takes
+ * the responsibility of invoking the response
+ * handler chain next with the SOAPMessageContext.
+ * The Handler implementation class has the the
+ * responsibility of setting the appropriate response
+ * SOAP message in either handleRequest and/or
+ * handleResponse method. In the default processing
+ * model, the response handler chain starts processing
+ * from the same Handler instance (that returned false)
+ * and goes backward in the execution sequence.
+ * </ul>
+ *
+ * @throws JAXRPCException This exception indicates handler
+ * specific runtime error. If JAXRPCException is thrown
+ * by a handleRequest method, the HandlerChain
+ * terminates the further processing of this handler
+ * chain. On the server side, the HandlerChain
+ * generates a SOAP fault that indicates that the
+ * message could not be processed for reasons not
+ * directly attributable to the contents of the
+ * message itself but rather to a runtime error
+ * during the processing of the message. On the
+ * client side, the exception is propagated to
+ * the client code
+ * @throws SOAPFaultException This indicates a SOAP fault. The Handler
+ * implementation class has the the responsibility
+ * of setting the SOAP fault in the SOAP message in
+ * either handleRequest and/or handleFault method.
+ * If SOAPFaultException is thrown by a server-side
+ * request handler's handleRequest method, the
+ * HandlerChain terminates the further processing
+ * of the request handlers in this handler chain
+ * and invokes the handleFault method on the
+ * HandlerChain with the SOAP message context. Next,
+ * the HandlerChain invokes the handleFault method
+ * on handlers registered in the handler chain,
+ * beginning with the Handler instance that threw
+ * the exception and going backward in execution. The
+ * client-side request handler's handleRequest method
+ * should not throw the SOAPFaultException.
*/
public boolean handleRequest(MessageContext context);
/**
- * The handleResponse method processes the response message.
+ * The <code>handleResponse</code> method processes the response SOAP message.
*
- * @param context - MessageContext parameter provides access to the response
- * message
+ * @param context - MessageContext parameter provides access to
+ * the response SOAP message
*
- * @return Processing mode. Return true to indicate continued processing of
- * the response handler chain. The HandlerChain invokes the
- * handleRespons method on the next Handler in the handler chain.
- * Return false to indicate blocking of the response handler chain.
- * In this case, no other response handlers in the handler chain
- * are invoked.
- *
- * @throws JAXRPCException - if any handler specific runtime error happens.
- * The HandlerChain terminates the further processing of this handler
- * chain.
+ * @return boolean Indicates the processing mode
+ * <ul>
+ * <li>Return <code>true</code> to indicate continued
+ * processing ofthe response handler chain. The
+ * HandlerChain invokes the <code>handleResponse</code>
+ * method on the next <code>Handler</code> in
+ * the handler chain.
+ * <li>Return <code>false</code> to indicate blocking
+ * of the response handler chain. In this case, no
+ * other response handlers in the handler chain
+ * are invoked.
+ * </ul>
+ *
+ * @throws JAXRPCException Indicates handler specific runtime error.
+ * If JAXRPCException is thrown by a handleResponse
+ * method, the HandlerChain terminates the further
+ * processing of this handler chain. On the server side,
+ * the HandlerChain generates a SOAP fault that
+ * indicates that the message could not be processed
+ * for reasons not directly attributable to the contents
+ * of the message itself but rather to a runtime error
+ * during the processing of the message. On the client
+ * side, the runtime exception is propagated to the
+ * client code.
*/
public boolean handleResponse(MessageContext context);
/**
- * The handleFault method processes the SOAP faults based on the SOAP
- * message processing model.
+ * The <code>handleFault</code> method processes the SOAP faults
+ * based on the SOAP message processing model.
*
- * @param context - MessageContext parameter provides access to the SOAP
- * message.
- * @throws JAXRPCException - if any handler specific runtime error
+ * @param context MessageContext parameter provides access to
+ * the SOAP message
+ * @return boolean Indicates the processing mode
+ * <ul>
+ * <li>Return <code>true</code> to indicate continued
+ * processing of SOAP Fault. The HandlerChain invokes
+ * the <code>handleFault</code> method on the
+ * next <code>Handler</code> in the handler chain.
+ * <li>Return <code>false</code> to indicate end
+ * of the SOAP fault processing. In this case, no
+ * other handlers in the handler chain
+ * are invoked.
+ * </ul>
+ * @throws JAXRPCException Indicates handler specific runtime error.
+ * If JAXRPCException is thrown by a handleFault
+ * method, the HandlerChain terminates the further
+ * processing of this handler chain. On the server side,
+ * the HandlerChain generates a SOAP fault that
+ * indicates that the message could not be processed
+ * for reasons not directly attributable to the contents
+ * of the message itself but rather to a runtime error
+ * during the processing of the message. On the client
+ * side, the JAXRPCException is propagated to the
+ * client code.
*/
public boolean handleFault(MessageContext context);
/**
- * The init method to enable the Handler instance to initialize itself. The
- * init method passes the handler configuration properties as a Map
- * instance. These configuration properties are used to configure the
- * Handler (for example: setup access to an external resource or service)
- * during initialization.
- *
- * @param HandlerInfo - Configuration for the initialization of this handler
+ * The <code>init</code> method enables the Handler instance to
+ * initialize itself. The <code>init</code> method passes the
+ * handler configuration as a <code>HandlerInfo</code> instance.
+ * The HandlerInfo is used to configure the Handler (for example:
+ * setup access to an external resource or service) during the
+ * initialization.
+ * <p>
+ * In the init method, the Handler class may get access to
+ * any resources (for example; access to a logging service or
+ * database) and maintain these as part of its instance variables.
+ * Note that these instance variables must not have any state
+ * specific to the SOAP message processing performed in the
+ * various handle method.
*
- * @throws JAXRPCException - If initialization of the handler fails
+ * @param HandlerInfo Configuration for the initialization of this handler
+ * @throws JAXRPCException If initialization of the handler fails
*/
public abstract void init(HandlerInfo config);
/**
- * The destroy method indicates the end of lifecycle for a Handler
- * instance. An Handler implementation class should release any
- * resources that it had acquired over its lifecycle. The JAX-RPC
- * runtime system invokes the destroy method, when the Handler
- * instance is no longer needed.
+ * The <code>destroy</code> method indicates the end of lifecycle
+ * for a Handler instance. The Handler implementation class should
+ * release its resources and perform cleanup in the implementation
+ * of the <code>destroy</code> method.
* @throws JAXRPCException If any error during destroy
*/
public abstract void destroy();
@@ -137,7 +229,9 @@
/**
* Gets the header blocks processed by this Handler instance.
*
- * @return The header blocks.
+ * @return Array of QNames of header blocks processed by this
+ * handler instance. <code>QName</code> is the qualified
+ * name of the outermost element of the Header block.
*/
public QName[] getHeaders();
}
1.4 +44 -30 xml-axis/java/src/javax/xml/rpc/handler/HandlerChain.java
Index: HandlerChain.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/HandlerChain.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HandlerChain.java 13 May 2002 13:11:33 -0000 1.3
+++ HandlerChain.java 14 Jun 2002 15:37:44 -0000 1.4
@@ -59,47 +59,57 @@
import java.util.Map;
/**
- * The <code>javax.xml.rpc.handler.HandlerChain</code> represents an
- * ordered list of handlers. All elements in the HandlerChain are of
- * the type javax.xml.rpc.handler.HandlerInfo.
- * <p>An implementation class for the HandlerChain interface abstracts
- * the policy and mechanism for the invocation of the registered
- * handlers.
+ * The <code>javax.xml.rpc.handler.HandlerChain</code> represents
+ * a list of handlers. All elements in the HandlerChain are of
+ * the type <code>javax.xml.rpc.handler.Handler</code>.
+ * <p>
+ * An implementation class for the <code>HandlerChain</code>
+ * interface abstracts the policy and mechanism for the invocation
+ * of the registered handlers.
+ *
+ * @version 1.0
*/
public interface HandlerChain extends List {
/**
- * The handleRequest method initiates the request processing for this
- * handler chain.
- * @param context - MessageContext parameter provides access to the request
- * SOAP message.
- *
+ * The <code>handleRequest</code> method initiates the request
+ * processing for this handler chain.
+ * @param context - MessageContext parameter provides access to
+ * the request SOAP message.
+ * @return boolean Returns <code>true</code> if all handlers in
+ * chain have been processed. Returns <code>false</code>
+ *
+ * if a handler in the chain returned
+ * <code>false</code> from its handleRequest
+ * method.
* @throws JAXRPCException - if any processing error happens
*/
public boolean handleRequest(MessageContext context);
/**
- * The handleResponse method initiates the response processing for this
- * handler chain.
+ * The <code>handleResponse</code> method initiates the response
+ * processing for this handler chain.
*
* @param context - MessageContext parameter provides access to the response
* SOAP message.
- *
+ * @return boolean Returns <code>true</code> if all handlers in
+ * chain have been processed. Returns <code>false</code>
+ * if a handler in the chain returned
+ * <code>false</code> from its handleResponse method.
* @throws JAXRPCException - if any processing error happens
*/
public boolean handleResponse(MessageContext context);
/**
- * The handleFault method initiates the SOAP fault processing
- * for this handler chain.
+ * The <code>handleFault</code> method initiates the SOAP
+ * fault processing for this handler chain.
*
* @param context - MessageContext parameter provides access to the SOAP
* message.
- *
- * @returns Returns true if all handlers in chain have been processed.
- * Returns false if a handler in the chain returned
- * false from its handleFault method.
- *
+ * @return Returns boolean Returns <code>true</code> if all handlers in
+ * chain have been processed. Returns <code>false</code>
+ * if a handler in the chain returned
+ * <code>false</code> from its handleFault method.
* @throws JAXRPCException - if any processing error happens
*/
public boolean handleFault(MessageContext context);
@@ -122,22 +132,26 @@
public void destroy();
/**
- * Sets SOAP Actor roles for this HandlerChain. This specifies the set of
- * roles in which this HandlerChain is to act for the SOAP message
- * processing at this SOAP node. These roles assumed by a HandlerChain must
- * be invariant during the processing of an individual SOAP message.
+ * Sets SOAP Actor roles for this <code>HandlerChain</code>. This
+ * specifies the set of roles in which this HandlerChain is to act
+ * for the SOAP message processing at this SOAP node. These roles
+ * assumed by a HandlerChain must be invariant during the
+ * processing of an individual SOAP message through the HandlerChain.
* <p>
- * A HandlerChain always acts in the role of the special SOAP actor next.
- * Refer to the SOAP specification for the URI name for this special SOAP
- * actor. There is no need to set this special role using this method.
+ * A <code>HandlerChain</code> always acts in the role of the
+ * special SOAP actor <code>next</code>. Refer to the SOAP
+ * specification for the URI name for this special SOAP actor.
+ * There is no need to set this special role using this method.
*
* @param soapActorNames - URIs for SOAP actor name
*/
public void setRoles(String[] soapActorNames);
/**
- * Gets SOAP actor roles registered for this HandlerChain at this SOAP node.
- * The returned array includes the special SOAP actor next.
+ * Gets SOAP actor roles registered for this HandlerChain at
+ * this SOAP node. The returned array includes the special
+ * SOAP actor <code>next</code>.
+ * @return String[] SOAP Actor roles as URIs
*/
public java.lang.String[] getRoles();
}
1.4 +16 -7 xml-axis/java/src/javax/xml/rpc/handler/HandlerInfo.java
Index: HandlerInfo.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/HandlerInfo.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- HandlerInfo.java 11 Jun 2002 14:53:50 -0000 1.3
+++ HandlerInfo.java 14 Jun 2002 15:37:44 -0000 1.4
@@ -64,8 +64,11 @@
/**
* The <code>javax.xml.rpc.handler.HandlerInfo</code> represents
- * information about a handler in the HandlerChain. All elements
- * in the HandlerChain are of the type HandlerInfo.
+ * information about a handler in the HandlerChain. A HandlerInfo
+ * instance is passed in the <code>Handler.init</code> method to
+ * initialize a <code>Handler</code> instance.
+ *
+ * @version 1.0
* @see HandlerChain
*/
public class HandlerInfo implements Serializable {
@@ -79,7 +82,7 @@
/**
* Constructor for HandlerInfo
* <p>
- * @param handlerClass Class for the Handler
+ * @param handlerClass Java Class for the Handler
* @param config Handler Configuration as a java.util.Map
* @param headers QNames for the header blocks processed
* by this Handler. QName is the qualified name
@@ -109,7 +112,7 @@
}
/**
- * Sets the Handler configuration map
+ * Sets the Handler configuration as <code>java.util.Map</code>
* @param config Configuration map
*/
public void setHandlerConfig(Map config) {
@@ -117,7 +120,7 @@
}
/**
- * Gets the Handler configuration map
+ * Gets the Handler configuration
* @return Returns empty Map if no configuration map
* has been set; otherwise returns the set configuration map
*/
@@ -126,14 +129,20 @@
}
/**
- * Set the header blocks.
+ * Sets the header blocks processed by this Handler.
+ * @param headers QNames of the header blocks. QName
+ * is the qualified name of the outermost
+ * element of the SOAP header block
*/
public void setHeaders(QName[] headers) {
this.headers = headers;
}
/**
- * Get the header blocks.
+ * Gets the header blocks processed by this Handler.
+ * @return Array of QNames for the header blocks. Returns
+ * <code>null</code> if no header blocks have been
+ * set using the <code>setHeaders</code> method.
*/
public QName[] getHeaders() {
return headers;
1.6 +32 -14 xml-axis/java/src/javax/xml/rpc/handler/HandlerRegistry.java
Index: HandlerRegistry.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/HandlerRegistry.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HandlerRegistry.java 11 Jun 2002 14:53:50 -0000 1.5
+++ HandlerRegistry.java 14 Jun 2002 15:37:44 -0000 1.6
@@ -60,34 +60,52 @@
import javax.xml.namespace.QName;
/**
- * The <code>javax.xml.rpc.handler.HandlerRegistry</code> provides
- * support for programmatic configuration of handlers in a
- * HandlerRegistry.
+ * The <code>javax.xml.rpc.handler.HandlerRegistry</code>
+ * provides support for the programmatic configuration of
+ * handlers in a <code>HandlerRegistry</code>.
+ * <p>
+ * A handler chain is registered per service endpoint, as
+ * indicated by the qualified name of a port. The getHandlerChain
+ * returns the handler chain (as a java.util.List) for the
+ * specified service endpoint. The returned handler chain is
+ * configured using the java.util.List interface. Each element
+ * in this list is required to be of the Java type
+ * <code>javax.xml.rpc.handler.HandlerInfo
+ *
+ * @version 1.0
*/
public interface HandlerRegistry extends Serializable {
/**
- * Gets the handler chain for the specified service endpoint. The returned
- * List is used to configure this specific handler chain in this
- * HandlerRegistry.
- * @param portName Qualified name of the target service
- * @return HandlerChain Returns the registered HandlerChain;
- * @throws java.lang.IllegalArgumentException If an invalid portName is
specified
+ * Gets the handler chain for the specified service endpoint.
+ * The returned <code>List</code> is used to configure this
+ * specific handler chain in this <code>HandlerRegistry</code>.
+ * Each element in this list is required to be of the Java type
+ * <code>javax.xml.rpc.handler.HandlerInfo</code>.
+ *
+ * @param portName Qualified name of the target service
+ * @return HandlerChain java.util.List Handler chain
+ * @throws java.lang.IllegalArgumentException If an invalid
<code>portName</code> is specified
*/
public java.util.List getHandlerChain(QName portName);
/**
- * Sets the handler chain for the specified service endpoint.
+ * Sets the handler chain for the specified service endpoint
+ * as a <code>java.util.List</code>. Each element in this list
+ * is required to be of the Java type
+ * <code>javax.xml.rpc.handler.HandlerInfo</code>.
+ *
* @param portName Qualified name of the target service endpoint
- * @param chain Request HandlerChain instance
- * @throws JAXRPCException If any error in the setting of
- * the HandlerChain
+ * @param chain A List representing configuration for the
+ * handler chain
+ * @throws JAXRPCException If any error in the configuration of
+ * the handler chain
* @throws java.lang.UnsupportedOperationException If this
* set operation is not supported. This is done to
* avoid any overriding of a pre-configured handler
* chain.
* @throws java.lang.IllegalArgumentException If an invalid
- * portName is specified
+ * <code>portName</code> is specified
*/
public abstract void setHandlerChain(
QName portName, java.util.List chain);
1.2 +30 -22 xml-axis/java/src/javax/xml/rpc/handler/MessageContext.java
Index: MessageContext.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/handler/MessageContext.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MessageContext.java 29 Jan 2002 01:52:45 -0000 1.1
+++ MessageContext.java 14 Jun 2002 15:37:44 -0000 1.2
@@ -58,20 +58,26 @@
import java.util.Iterator;
/**
- * The interface MessageContext abstracts the message context that
- * is processed by a handler in the <code>handle</code> method.
+ * The interface <code>MessageContext</code> abstracts the message
+ * context that is processed by a handler in the <code>handle</code>
+ * method.
*
- * <p>The MessageContext interface provides methods to manage a
- * property set. MessageContext properties enable handlers in an
- * handler chain to share processing related state.
+ * <p>The <code>MessageContext</code> interface provides methods to
+ * manage a property set. <code>MessageContext</code> properties
+ * enable handlers in a handler chain to share processing related
+ * state.
+ *
+ * @version 1.0
*/
public interface MessageContext {
/**
* Sets the name and value of a property associated with the
- * MessageContext. If the MessageContext contains a value of
- * the same property, the old value is replaced.
- * @param name Name of the property associated with the MessageContext
+ * <code>MessageContext</code>. If the <code>MessageContext</code>
+ * contains a value of the same property, the old value is replaced.
+ *
+ * @param name ame of the property associated with the
+ * <code>MessageContext</code>
* @param value Value of the property
* @throws java.lang.IllegalArgumentException If some aspect
* the property is prevents it from being stored
@@ -82,34 +88,36 @@
public abstract void setProperty(String name, Object value);
/**
- * 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
- * @throws java.lang.IllegalArgumentException if an illegal
+ * Gets the value of a specific property from the <code>MessageContext</code>
+ * @param name Name of the property whose value is to be
+ * retrieved
+ * @return Value of the property
+ * @throws java.lang.IllegalArgumentException if an illegal
* property name is specified
*/
public abstract Object getProperty(String name);
/**
- * Removes a property (name-value pair) from the message context
- * @param name Name of the property to be removed
- * @throws java.lang.IllegalArgumentException if an illegal
+ * Removes a property (name-value pair) from the <code>MessageContext</code>
+ * @param name Name of the property to be removed
+ * @throws java.lang.IllegalArgumentException if an illegal
* property name is specified
*/
public abstract void removeProperty(String nae);
/**
- * Returns true if the MessageContext contains a property with the specified
name.
- * @param name Name of the property whose presense is to be tested
- * @return Returns true if the MessageContext contains the
- property; otherwise false
+ * Returns true if the <code>MessageContext</code> contains a property
+ * with the specified name.
+ * @param name Name of the property whose presense is to be tested
+ * @return Returns true if the MessageContext contains the
+ * property; otherwise false
*/
public abstract boolean containsProperty(String name);
/**
- * Returns an Iterator view of the names of the properties in this
MessageContext
- * @return Iterator for the property names
+ * Returns an Iterator view of the names of the properties
+ * in this <code>MessageContext</code>
+ * @return Iterator for the property names
*/
public abstract Iterator getPropertyNames();
}
1.5 +12 -7
xml-axis/java/src/javax/xml/rpc/handler/soap/SOAPMessageContext.java
Index: SOAPMessageContext.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/javax/xml/rpc/handler/soap/SOAPMessageContext.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SOAPMessageContext.java 11 Jun 2002 15:21:01 -0000 1.4
+++ SOAPMessageContext.java 14 Jun 2002 15:37:45 -0000 1.5
@@ -64,6 +64,8 @@
* response. The <code>javax.xml.soap.SOAPMessage</code> specifies
* the standard Java API for the representation of a SOAP 1.1 message
* with attachments.
+ *
+ * @version 1.0
* @see javax.xml.soap.SOAPMessage
*/
public interface SOAPMessageContext extends MessageContext {
@@ -77,20 +79,23 @@
/**
* Sets the SOAPMessage for this message context
- * @param message Request SOAP message
+ * @param message SOAP message
* @throws JAXRPCException If any error during the setting
- * of the request message or if invalid SOAPMessage
- * is set
+ * of the SOAPMessage in this message context
* @throws java.lang.UnsupportedOperationException If this
* operation is not supported
*/
public abstract void setMessage(SOAPMessage message);
/**
- * Gets the SOAP actor roles associated with an execution of the HandlerChain
and its contained Handler instances.
- * Note that SOAP actor roles apply to the SOAP node and are managed using
HandlerChain.setRoles and
- * HandlerChain.getRoles. Handler instances in the HandlerChain use this
information about the SOAP actor roles
- * to process the SOAP header blocks. Note that the SOAP actor roles are
invariant during the processing of
+ * Gets the SOAP actor roles associated with an execution
+ * of the HandlerChain and its contained Handler instances.
+ * Note that SOAP actor roles apply to the SOAP node and
+ * are managed using <code>HandlerChain.setRoles</code> and
+ * <code>HandlerChain.getRoles</code>. Handler instances in
+ * the HandlerChain use this information about the SOAP actor
+ * roles to process the SOAP header blocks. Note that the
+ * SOAP actor roles are invariant during the processing of
* SOAP message through the HandlerChain.
*
* @return Array of URIs for SOAP actor roles
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/BigDecimalHolder.java
Index: BigDecimalHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/BigDecimalHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- BigDecimalHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ BigDecimalHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -59,7 +59,7 @@
/**
* Class BigDecimalHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class BigDecimalHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/BigIntegerHolder.java
Index: BigIntegerHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/BigIntegerHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- BigIntegerHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ BigIntegerHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -59,7 +59,7 @@
/**
* Class BigIntegerHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class BigIntegerHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/BooleanHolder.java
Index: BooleanHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/BooleanHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- BooleanHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ BooleanHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class BooleanHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class BooleanHolder implements Holder {
1.2 +1 -1
xml-axis/java/src/javax/xml/rpc/holders/BooleanWrapperHolder.java
Index: BooleanWrapperHolder.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/javax/xml/rpc/holders/BooleanWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BooleanWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ BooleanWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class BooleanWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class BooleanWrapperHolder implements Holder {
1.4 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ByteArrayHolder.java
Index: ByteArrayHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ByteArrayHolder.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ByteArrayHolder.java 1 Feb 2002 04:38:17 -0000 1.3
+++ ByteArrayHolder.java 14 Jun 2002 15:37:45 -0000 1.4
@@ -57,7 +57,7 @@
/**
* Class ByteArrayHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ByteArrayHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ByteHolder.java
Index: ByteHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ByteHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ByteHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ ByteHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class ByteHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ByteHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ByteWrapperHolder.java
Index: ByteWrapperHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ByteWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ByteWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ ByteWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class ByteClassHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ByteWrapperHolder implements Holder {
1.3 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/CalendarHolder.java
Index: CalendarHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/CalendarHolder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CalendarHolder.java 1 Feb 2002 04:38:17 -0000 1.2
+++ CalendarHolder.java 14 Jun 2002 15:37:45 -0000 1.3
@@ -59,7 +59,7 @@
/**
* Class CalendarHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class CalendarHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/DoubleHolder.java
Index: DoubleHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/DoubleHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- DoubleHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ DoubleHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class DoubleHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class DoubleHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/DoubleWrapperHolder.java
Index: DoubleWrapperHolder.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/javax/xml/rpc/holders/DoubleWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DoubleWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ DoubleWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class DoubleWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class DoubleWrapperHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/FloatHolder.java
Index: FloatHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/FloatHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- FloatHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ FloatHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class FloatHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class FloatHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/FloatWrapperHolder.java
Index: FloatWrapperHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/FloatWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FloatWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ FloatWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class FloatWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class FloatWrapperHolder implements Holder {
1.3 +3 -2 xml-axis/java/src/javax/xml/rpc/holders/Holder.java
Index: Holder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/Holder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Holder.java 31 Mar 2002 23:09:33 -0000 1.2
+++ Holder.java 14 Jun 2002 15:37:45 -0000 1.3
@@ -55,9 +55,10 @@
package javax.xml.rpc.holders;
/**
- * Interface Holder
+ * The <code>java.xml.rpc.holders.Holder</code> interface represents the base
interface for both standard and
+ * generated Holder classes. A generated Holder class is required to implement
this Holder interface.
*
- * @version 0.7
+ * @version 1.0
*/
public interface Holder {
}
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/IntHolder.java
Index: IntHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/IntHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- IntHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ IntHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class IntHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class IntHolder implements Holder {
1.2 +1 -1
xml-axis/java/src/javax/xml/rpc/holders/IntegerWrapperHolder.java
Index: IntegerWrapperHolder.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/javax/xml/rpc/holders/IntegerWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- IntegerWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ IntegerWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class IntegerWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class IntegerWrapperHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/LongHolder.java
Index: LongHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/LongHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- LongHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ LongHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class LongHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class LongHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/LongWrapperHolder.java
Index: LongWrapperHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/LongWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LongWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ LongWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class LongWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class LongWrapperHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ObjectHolder.java
Index: ObjectHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ObjectHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObjectHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ ObjectHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class ObjectHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ObjectHolder implements Holder {
1.9 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/QNameHolder.java
Index: QNameHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/QNameHolder.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- QNameHolder.java 11 Jun 2002 14:53:51 -0000 1.8
+++ QNameHolder.java 14 Jun 2002 15:37:45 -0000 1.9
@@ -59,7 +59,7 @@
/**
* Class QNameHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class QNameHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ShortHolder.java
Index: ShortHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ShortHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ShortHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ ShortHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class ShortHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ShortHolder implements Holder {
1.2 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/ShortWrapperHolder.java
Index: ShortWrapperHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/ShortWrapperHolder.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ShortWrapperHolder.java 1 Feb 2002 04:42:26 -0000 1.1
+++ ShortWrapperHolder.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -57,7 +57,7 @@
/**
* Class ShortWrapperHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class ShortWrapperHolder implements Holder {
1.8 +1 -1 xml-axis/java/src/javax/xml/rpc/holders/StringHolder.java
Index: StringHolder.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/holders/StringHolder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- StringHolder.java 1 Feb 2002 04:38:17 -0000 1.7
+++ StringHolder.java 14 Jun 2002 15:37:45 -0000 1.8
@@ -57,7 +57,7 @@
/**
* Class StringHolder
*
- * @version 0.7
+ * @version 1.0
*/
public final class StringHolder implements Holder {
1.3 +31 -20 xml-axis/java/src/javax/xml/rpc/server/ServiceLifecycle.java
Index: ServiceLifecycle.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/server/ServiceLifecycle.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ServiceLifecycle.java 4 Apr 2002 14:35:35 -0000 1.2
+++ ServiceLifecycle.java 14 Jun 2002 15:37:45 -0000 1.3
@@ -57,34 +57,45 @@
import javax.xml.rpc.ServiceException;
/**
- * The <code>javax.xml.rpc.server.ServiceLifecycle</code> defines a
- * lifecycle interface for a JAX-RPC service endpoint. If the service
- * endpoint class implements the <code>ServiceLifeycle</code> interface,
- * the servlet container based JAX-RPC runtime system is required to
- * manage the lifecycle of the corresponding service endpoint objects.
+ * The <code>javax.xml.rpc.server.ServiceLifecycle</code> defines a lifecycle
interface for a
+ * JAX-RPC service endpoint. If the service endpoint class implements the
+ * <code>ServiceLifeycle</code> interface, the servlet container based JAX-RPC
runtime system
+ * is required to manage the lifecycle of the corresponding service endpoint
objects.
+ *
+ * @version 1.0
*/
public interface ServiceLifecycle {
/**
- * After a service endpoint object (an instance of a service
- * endpoint class) is instantiated, the JAX-RPC runtime system
- * invokes the init method.The service endpoint class uses the
- * init method to initialize its configuration and setup access
- * to any external resources.
- * @param context Initialization context for a JAX-RPC service
- endpoint; Carries javax.servlet.ServletContext
- for the servlet based JAX-RPC endpoints
- * @throws ServiceException If any error in initialization of the
- service endpoint; or if any illegal context has
- been provided in the init method
+ * Used for initialization of a service endpoint. After a service
+ * endpoint instance (an instance of a service endpoint class) is
+ * instantiated, the JAX-RPC runtime system invokes the
+ * <code>init</code> method. The service endpoint class uses the
+ * <code>init</code> method to initialize its configuration
+ * and setup access to any external resources. The context parameter
+ * in the <code>init</code> method enables the endpoint instance to
+ * access the endpoint context provided by the underlying JAX-RPC
+ * runtime system.
+ * <p>
+ * The init method implementation should typecast the context
+ * parameter to an appropriate Java type. For service endpoints
+ * deployed on a servlet container based JAX-RPC runtime system,
+ * the <code>context</code> parameter is of the Java type
+ * <code>javax.xml.rpc.server.ServletEndpointContext</code>. The
+ * <code>ServletEndpointContext</code> provides an endpoint context
+ * maintained by the underlying servlet container based JAX-RPC
+ * runtime system
+ * <p>
+ * @param context Endpoint context for a JAX-RPC service endpoint
+ * @throws ServiceException If any error in initialization of the service
endpoint; or if any
+ * illegal context has been provided in the init method
*/
public abstract void init(Object context) throws ServiceException;
/**
- * JAX-RPC runtime system ends the lifecycle of a service endpoint
- * object by invoking the destroy method. The service endpoint
- * releases its resourcesin the implementation of the destroy
- * method.
+ * JAX-RPC runtime system ends the lifecycle of a service endpoint instance by
+ * invoking the destroy method. The service endpoint releases its resources in
+ * the implementation of the destroy method.
*/
public abstract void destroy();
}
1.2 +68 -43
xml-axis/java/src/javax/xml/rpc/server/ServletEndpointContext.java
Index: ServletEndpointContext.java
===================================================================
RCS file:
/home/cvs/xml-axis/java/src/javax/xml/rpc/server/ServletEndpointContext.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ServletEndpointContext.java 4 Apr 2002 14:35:35 -0000 1.1
+++ ServletEndpointContext.java 14 Jun 2002 15:37:45 -0000 1.2
@@ -54,75 +54,100 @@
*/
package javax.xml.rpc.server;
-import java.security.Principal;
-
-import javax.servlet.http.HttpSession;
-
import javax.servlet.ServletContext;
-
+import javax.servlet.http.HttpSession;
import javax.xml.rpc.handler.MessageContext;
+import java.security.Principal;
/**
- * The ServletEndpointContext provides an endpoint context maintained by the
- * underlying servlet container based JAX-RPC runtime system. For service
- * endpoints deployed on a servlet container based JAX-RPC runtime system, the
- * context parameter in the ServiceLifecycle.init method is required to be of
- * the Java type <code>javax.xml.rpc.server.ServletEndpointContext</code>.
+ * The <code>ServletEndpointContext</code> provides an endpoint
+ * context maintained by the underlying servlet container based
+ * JAX-RPC runtime system. For service endpoints deployed on a
+ * servlet container based JAX-RPC runtime system, the context
+ * parameter in the <code>ServiceLifecycle.init</code> method is
+ * required to be of the Java type
+ * <code>javax.xml.rpc.server.ServletEndpointContext</code>.
* <p>
- * A servlet container based JAX-RPC runtime system implements the
- * <code>ServletEndpointContext</code> interface. The JAX-RPC runtime system is
- * required to provide appropriate session, message context, servlet context and
- * user principal information per method invocation on the endpoint class.
+ * A servlet container based JAX-RPC runtime system implements
+ * the <code>ServletEndpointContext</code> interface. The JAX-RPC
+ * runtime system is required to provide appropriate session,
+ * message context, servlet context and user principal information
+ * per method invocation on the endpoint class.
+ *
+ * @version 1.0
*/
public interface ServletEndpointContext {
/**
- * The method getMessageContext returns the MessageContext targeted for this
- * endpoint object. This enables the endpoint object to acccess the
- * MessageContext propagated by request HandlerChain (and its contained
- * Handler instances) to the target endpoint object and to share any SOAP
- * message processing related context. The endpoint object can access and
- * manipulate the MessageContext and share the SOAP message processing
- * related context with the response HandlerChain.
+ * The method <code>getMessageContext</code> returns the
+ * <code>MessageContext</code> targeted for this endpoint instance.
+ * This enables the service endpoint instance to acccess the
+ * <code>MessageContext</code> propagated by request
+ * <code>HandlerChain</code> (and its contained <code>Handler</code>
+ * instances) to the target endpoint instance and to share any
+ * SOAP message processing related context. The endpoint instance
+ * can access and manipulate the <code>MessageContext</code>
+ * and share the SOAP message processing related context with
+ * the response <code>HandlerChain</code>.
*
- * @throws java.lang.IllegalStateException - if this method is invoked
- * outside a remote method implementation by an endpoint object.
+ * @return MessageContext; If there is no associated
+ * <code>MessageContext</code>, this method returns
+ * <code>null</code>.
+ * @throws java.lang.IllegalStateException if this method is invoked outside a
+ * remote method implementation by a service endpoint instance.
*/
public MessageContext getMessageContext();
/**
- * Returns a <code>java.security.Principal</code> instance that contains the
- * name of the authenticated user for the current method invocation on the
- * endpoint object. This method returns null if there is no associated
- * principal yet. The underlying JAX-RPC runtime system takes the
- * responsibility of providing the appropriate authenticated principal for a
- * remote method invocation on the service endpoint object.
+ * Returns a <code>java.security.Principal</code> instance that
+ * contains the name of the authenticated user for the current
+ * method invocation on the endpoint instance. This method returns
+ * <code>null</code> if there is no associated principal yet.
+ * The underlying JAX-RPC runtime system takes the responsibility
+ * of providing the appropriate authenticated principal for a
+ * remote method invocation on the service endpoint instance.
+ *
+ * @return A <code>java.security.Principal</code> for the
+ * authenticated principal associated with the current
+ * invocation on the servlet endpoint instance;
+ * Returns <code>null</code> if there no authenticated
+ * user associated with a method invocation.
*/
public Principal getUserPrincipal();
/**
- * The getHttpSession method returns the current HTTP session (as a
- * javax.servlet.http.HTTPSession). When invoked by the service endpoint
- * within a remote method implementation, the getHttpSession returns the
- * HTTP session associated currently with this method invocation. This
- * method returns null if there is no HTTP session currently active and
- * associated with this service endpoint. An endpoint class should not rely
- * on an active HTTP session being always there; the underlying JAX-RPC
- * runtime system is responsible for managing whether or not there is an
- * active HTTP session.
+ * The <code>getHttpSession</code> method returns the current
+ * HTTP session (as a <code>javax.servlet.http.HTTPSession</code>).
+ * When invoked by the service endpoint within a remote method
+ * implementation, the <code>getHttpSession</code> returns the
+ * HTTP session associated currently with this method invocation.
+ * This method returns <code>null</code> if there is no HTTP
+ * session currently active and associated with this service
+ * endpoint. An endpoint class should not rely on an active
+ * HTTP session being always there; the underlying JAX-RPC
+ * runtime system is responsible for managing whether or not
+ * there is an active HTTP session.
+ * <p>
+ * The getHttpSession method throws <code>JAXRPCException</code>
+ * if invoked by an non HTTP bound endpoint.
*
+ * @return The HTTP session associated with the current
+ * invocation or <code>null</code> if there is no active session.
* @throws JAXRPCException - If this method invoked by a non-HTTP bound
* endpoints.
*/
public HttpSession getHttpSession();
/**
- * The method getServletContext returns the ServletContext associated with
- * the web application that contain this endpoint. According to the Servlet
- * specification. There is one context per web application (installed as a
- * WAR) per JVM . A servlet based service endpoint is deployed as part of a
- * web application.
+ * The method <code>getServletContext</code> returns the
+ * <code>ServletContex</code>t associated with the web
+ * application that contain this endpoint. According to
+ * the Servlet specification, There is one context per web
+ * application (installed as a WAR) per JVM . A servlet
+ * based service endpoint is deployed as part of a web
+ * application.
+ * @return <code>ServletContext</code>
*/
public ServletContext getServletContext();
}
1.3 +35 -18 xml-axis/java/src/javax/xml/rpc/soap/SOAPFaultException.java
Index: SOAPFaultException.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/soap/SOAPFaultException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPFaultException.java 11 Jun 2002 14:53:51 -0000 1.2
+++ SOAPFaultException.java 14 Jun 2002 15:37:45 -0000 1.3
@@ -58,22 +58,34 @@
import javax.xml.soap.Detail;
/**
- * SOAPFaultException exception class is used for the mapping of the
- * SOAP faults. If the use attribute in the soap:fault is
- * literal, the soap:fault maps to the SOAPFaultException exception.
- * This class extends the exception class java.lang.Exception
- * and is declared as a checked exception in the service
- * definition interface.
+ * The <code>SOAPFaultException</code> exception represents a
+ * SOAP fault.
+ * <p>
+ * The message part in the SOAP fault maps to the contents of
+ * <code>faultdetail</code> element accessible through the
+ * <code>getDetail</code> method on the <code>SOAPFaultException</code>.
+ * The method <code>createDetail</code> on the
+ * <code>javax.xml.soap.SOAPFactory</code> creates an instance
+ * of the <code>javax.xml.soap.Detail</code>.
+ * <p>
+ * The <code>faultstring</code> provides a human-readable
+ * description of the SOAP fault. The <code>faultcode</code>
+ * element provides an algorithmic mapping of the SOAP fault.
+ * <p>
+ * Refer to SOAP 1.1 and WSDL 1.1 specifications for more
+ * details of the SOAP faults.
+ *
+ * @version 1.0
*/
public class SOAPFaultException extends RuntimeException {
/**
* Constructor for SOAPFaultException
* <p>
- * @param faultcode Qualified name of the faultcode
- * @param faultstring The faultstring element of the SOAP fault
- * @param faultactor faultactor element of the SOAP fault
- * @param detail detail element of the SOAP fault
+ * @param faultcode <code>QName</code> for the SOAP faultcode
+ * @param faultstring <code>faultstring</code> element of SOAP fault
+ * @param faultactor <code>faultactor</code> element of SOAP fault
+ * @param detail <code>faultdetail</code> element of SOAP fault
*/
public SOAPFaultException(QName faultcode, String faultstring, String
faultactor,
Detail detail) {
@@ -85,32 +97,37 @@
}
/**
- * Gets the faultcode element.
- * @return Qualified name of the faultcode element
+ * Gets the <code>faultcode</code> element. The <code>faultcode</code> element
provides an algorithmic
+ * mechanism for identifying the fault. SOAP defines a small set of SOAP fault
codes covering
+ * basic SOAP faults.
+ * @return QName of the faultcode element
*/
public QName getFaultCode() {
return faultcode;
}
/**
- * Gets the faultstring element.
- * @return faultstring element of the SOAP fault
+ * Gets the <code>faultstring</code> element. The faultstring provides a
human-readable description of
+ * the SOAP fault and is not intended for algorithmic processing.
+ * @return <code>faultstring</code> element of the SOAP fault
*/
public String getFaultString() {
return faultstring;
}
/**
- * Gets the faultactor element.
- * @return faultactor element of the SOAP fault
+ * Gets the <code>faultactor</code> element. The <code>faultactor</code>
element provides information
+ * about which SOAP node on the SOAP message path caused the fault to happen.
It indicates the source of the fault.
+ * @return <code>faultactor</code> element of the SOAP fault
*/
public String getFaultActor() {
return faultactor;
}
/**
- * Gets the detail element.
- * @return detail element of the SOAP fault
+ * Gets the detail element. The detail element is intended for carrying
application specific error
+ * information related to the SOAP Body.
+ * @return <code>detail</code> element of the SOAP fault
*/
public Detail getDetail() {
return detail;
