[java-opensaml COMMIT] /trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPCl...

[noreply at shibboleth.net]

Author: putmanb
Date: Fri May  8 17:09:34 2015
New Revision: 4272

URL: http://svn.shibboleth.net/view/java-opensaml?rev=4272&view=rev
Log:
Fix up some Javadocs.

Modified:
    trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java

Modified: trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java?rev=4272&r1=4271&r2=4272&view=diff
==============================================================================
--- trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java	(original)
+++ trunk/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/PipelineFactoryHttpSOAPClient.java	Fri May  8 17:09:34 2015
@@ -96,7 +96,26 @@
         super.doDestroy();
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Resolve and return a new instance of the {@link HttpClientMessagePipeline} to be processed.
+     * 
+     * <p>
+     * Each call to this (factory) method MUST produce a new instance of the pipeline.
+     * </p>
+     * 
+     * <p>
+     * The behavior of this subclass specialization is to use a factory strategy using
+     * a configured instance of {@link HttpClientMessagePipeline}.  See
+     * {@link #resolvePipelineName(InOutOperationContext)} and 
+     * {@link #newPipeline(String)}.
+     * </p>
+     * 
+     * @param operationContext the current operation context
+     * 
+     * @return a new pipeline instance
+     * 
+     * @throws SOAPException if there is an error obtaining a new pipeline instance
+     */
     @Nonnull protected HttpClientMessagePipeline<InboundMessageType, OutboundMessageType> 
             resolvePipeline(InOutOperationContext operationContext) throws SOAPException {
         
@@ -119,7 +138,14 @@
         }
     }
 
-    /** {@inheritDoc} */
+    /** {@inheritDoc}
+     * 
+     * <p>
+     * The behavior of this subclass specialization is to use a factory strategy using
+     * a configured instance of {@link HttpClientMessagePipeline}. 
+     * </p>
+     * 
+     */
     @Nonnull protected HttpClientMessagePipeline<InboundMessageType, OutboundMessageType> newPipeline() 
             throws SOAPException {
         // Note: in a Spring environment, the actual factory impl might be a proxy via ServiceLocatorFactoryBean
@@ -131,6 +157,11 @@
      * 
      * <p>
      * Each call to this (factory) method MUST produce a new instance of the pipeline.
+     * </p>
+     * 
+     * <p>
+     * The behavior of this subclass specialization is to use a factory strategy using
+     * a configured instance of {@link HttpClientMessagePipeline}. 
      * </p>
      * 
      * @param name the name of pipeline to return