sync: cherry-pick changes from feature/3.0.x

Author: loong10k

src/main/java/com/smartbear/soapui/template/SoapuiProperties.java

@@ -18,6 +18,15 @@
 import com.smartbear.soapui.template.property.EnvironmentProperty;
 import com.smartbear.soapui.template.setting.SoapuiSettings;
 
+/**
+ * Provides SoapuiProperties functionality for SOAP UI template processing.
+ * <p>This component encapsulates reusable behavior used when constructing,
+ * configuring, or interpreting SOAP UI requests and responses.</p>
+ *
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see SoapuiProperties
+ */
 public class SoapuiProperties {
 
 	public final static String DEFAULT_SETTINGS_FILE = "soapui-settings.xml";
@@ -46,58 +55,128 @@ public class SoapuiProperties {
 	private EnvironmentProperty env = new EnvironmentProperty();
 
 
+	/**
+	 * Returns whether requests should be automatically created.
+	 *
+	 * @return {@code true} if requests should be created, {@code false} otherwise
+	 */
 	public boolean isCreateRequests() {
 		return createRequests;
 	}
 
+	/**
+	 * Sets whether requests should be automatically created.
+	 *
+	 * @param createRequests {@code true} to enable automatic request creation
+	 */
 	public void setCreateRequests(boolean createRequests) {
 		this.createRequests = createRequests;
 	}
 
+	/**
+	 * Returns the project timeout in milliseconds.
+	 *
+	 * @return the timeout value in milliseconds
+	 */
 	public long getTimeout() {
 		return timeout;
 	}
 
+	/**
+	 * Sets the project timeout in milliseconds.
+	 *
+	 * @param timeout the timeout value in milliseconds
+	 */
 	public void setTimeout(long timeout) {
 		this.timeout = timeout;
 	}
 
+	/**
+	 * Returns the maximum cache size for WSDL interfaces.
+	 *
+	 * @return the maximum number of entries in the cache
+	 */
 	public long getMaximumCacheSize() {
 		return maximumCacheSize;
 	}
 
+	/**
+	 * Sets the maximum cache size for WSDL interfaces.
+	 *
+	 * @param maximumCacheSize the maximum number of entries in the cache
+	 */
 	public void setMaximumCacheSize(long maximumCacheSize) {
 		this.maximumCacheSize = maximumCacheSize;
 	}
 
+	/**
+	 * Returns the cache duration in minutes.
+	 *
+	 * @return the cache duration in minutes
+	 */
 	public long getCacheDuration() {
 		return cacheDuration;
 	}
 
+	/**
+	 * Sets the cache duration in minutes.
+	 *
+	 * @param cacheDuration the cache duration in minutes
+	 */
 	public void setCacheDuration(long cacheDuration) {
 		this.cacheDuration = cacheDuration;
 	}
 
+	/**
+	 * Returns the environment property configuration.
+	 *
+	 * @return the {@link EnvironmentProperty} instance
+	 */
 	public EnvironmentProperty getEnv() {
 		return env;
 	}
 
+	/**
+	 * Sets the environment property configuration.
+	 *
+	 * @param env the {@link EnvironmentProperty} instance
+	 */
 	public void setEnv(EnvironmentProperty env) {
 		this.env = env;
 	}
-	
+
+	/**
+	 * Returns the path to the SoapUI settings file.
+	 *
+	 * @return the settings file path
+	 */
 	public String getSettingsFile() {
 		return settingsFile;
 	}
 
+	/**
+	 * Sets the path to the SoapUI settings file.
+	 *
+	 * @param settingsFile the settings file path
+	 */
 	public void setSettingsFile(String settingsFile) {
 		this.settingsFile = settingsFile;
 	}
 
+	/**
+	 * Returns the SoapUI settings configuration.
+	 *
+	 * @return the {@link SoapuiSettings} instance
+	 */
 	public SoapuiSettings getSettings() {
 		return settings;
 	}
 
+	/**
+	 * Sets the SoapUI settings configuration.
+	 *
+	 * @param settings the {@link SoapuiSettings} instance
+	 */
 	public void setSettings(SoapuiSettings settings) {
 		this.settings = settings;
 	}

src/main/java/com/smartbear/soapui/template/SoapuiResponse.java

@@ -19,13 +19,30 @@
 import com.eviware.soapui.model.iface.Response;
 import com.eviware.soapui.model.iface.Submit.Status;
 
+/**
+ * Encapsulates the result of a SOAP UI request submission, holding the original
+ * request, the response content, the submission status, and any error that occurred.
+ *
+ * @param <T> the type of the HTTP request, must extend {@link AbstractHttpRequestInterface}
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see AbstractHttpRequestInterface
+ */
 public class SoapuiResponse<T extends AbstractHttpRequestInterface<?>> {
 
 	private final T request;
 	private final Status status;
 	private final Exception error;
 	private final Response response;
 
+	/**
+	 * Constructs a new SoapuiResponse with the given request, response, status, and error.
+	 *
+	 * @param request  the original SOAP UI request
+	 * @param response the response received from the service
+	 * @param status   the submission status
+	 * @param error    the exception thrown during submission, or {@code null} if successful
+	 */
 	public SoapuiResponse(T request, Response response, Status status, Exception error) {
 		super();
 		this.request = request;
@@ -34,18 +51,38 @@ public SoapuiResponse(T request, Response response, Status status, Exception err
 		this.error = error;
 	}
 
+	/**
+	 * Returns the original request that was submitted.
+	 *
+	 * @return the request object
+	 */
 	public T getRequest() {
 		return request;
 	}
 
+	/**
+	 * Returns the submission status.
+	 *
+	 * @return the {@link Status} of the submission
+	 */
 	public Status getStatus() {
 		return status;
 	}
 
+	/**
+	 * Returns the exception that occurred during submission, if any.
+	 *
+	 * @return the exception, or {@code null} if no error occurred
+	 */
 	public Exception getError() {
 		return error;
 	}
 
+	/**
+	 * Returns the response received from the SOAP service.
+	 *
+	 * @return the {@link Response} object
+	 */
 	public Response getResponse() {
 		return response;
 	}

src/main/java/com/smartbear/soapui/template/SoapuiWsdlRequestTemplate.java

@@ -33,6 +33,15 @@
  * 
  * @author [@Loong Wan](https://github.com/loong10k)
  */
+/**
+ * Provides SoapuiWsdlRequestTemplate functionality for SOAP UI template processing.
+ * <p>This component encapsulates reusable behavior used when constructing,
+ * configuring, or interpreting SOAP UI requests and responses.</p>
+ *
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see SoapuiWsdlRequestTemplate
+ */
 public class SoapuiWsdlRequestTemplate {
 
 	private SoapuiWsdlTemplate wsdlTemplate;

src/main/java/com/smartbear/soapui/template/SoapuiWsdlTemplate.java

@@ -41,6 +41,15 @@
  * https://www.soapui.org/developers-corner/integrating-with-soapui.html
  * @author [@Loong Wan](https://github.com/loong10k)
  */
+/**
+ * Provides SoapuiWsdlTemplate functionality for SOAP UI template processing.
+ * <p>This component encapsulates reusable behavior used when constructing,
+ * configuring, or interpreting SOAP UI requests and responses.</p>
+ *
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see SoapuiWsdlTemplate
+ */
 public class SoapuiWsdlTemplate {
 
 	private WsdlProject project;

src/main/java/com/smartbear/soapui/template/handler/AbstractResponseHandler.java

@@ -3,31 +3,66 @@
 import org.apache.http.client.ResponseHandler;
 import org.apache.http.client.protocol.HttpClientContext;
 
+/**
+ * Abstract base class for HTTP response handlers that provides common context
+ * and charset configuration.
+ *
+ * @param <T> the type of the response object produced by this handler
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see ResponseHandler
+ */
 public abstract class AbstractResponseHandler<T> implements ResponseHandler<T> {
 
 	protected HttpClientContext context;
 	protected String charsetStr;
 
+	/**
+	 * Constructs a new AbstractResponseHandler with the given context and charset.
+	 *
+	 * @param context the HTTP client context
+	 * @param charset the character set name used for response decoding
+	 */
 	public AbstractResponseHandler(HttpClientContext context, String charset) {
 		this.context = context;
 		this.charsetStr = charset;
 	}
 
+	/**
+	 * Returns the HTTP client context.
+	 *
+	 * @return the {@link HttpClientContext}
+	 */
 	public HttpClientContext getContext() {
 
 		return context;
 	}
 
+	/**
+	 * Sets the HTTP client context.
+	 *
+	 * @param context the {@link HttpClientContext} to use
+	 */
 	public void setContext(HttpClientContext context) {
 
 		this.context = context;
 	}
 
+	/**
+	 * Returns the charset used for response decoding.
+	 *
+	 * @return the charset name
+	 */
 	public String getCharset() {
 
 		return charsetStr;
 	}
 
+	/**
+	 * Sets the charset used for response decoding.
+	 *
+	 * @param charset the charset name
+	 */
 	public void setCharset(String charset) {
 
 		this.charsetStr = charset;

src/main/java/com/smartbear/soapui/template/handler/SoapRequestHandler.java

@@ -23,6 +23,15 @@
  * TODO
  * @author [@Loong Wan](https://github.com/loong10k)
  */
+/**
+ * Provides SoapRequestHandler functionality for SOAP UI template processing.
+ * <p>This component encapsulates reusable behavior used when constructing,
+ * configuring, or interpreting SOAP UI requests and responses.</p>
+ *
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see SoapRequestHandler
+ */
 public interface SoapRequestHandler<T> {
 
 	String handleRequest(WsdlOperation operationInst, WsdlRequest request,T params) throws SoapUIException;

src/main/java/com/smartbear/soapui/template/handler/SoapResponseHandler.java

@@ -5,18 +5,21 @@
 import com.eviware.soapui.support.SoapUIException;
 
 /**
- * Handler that encapsulates the process of generating a response object
- * from a {@link Response}.
+ * Strategy interface for processing SOAP UI responses into application-specific types.
+ *
+ * @param <T> the type of the result produced by this handler
+ * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see Response
  */
 public interface SoapResponseHandler<T> {
 
     /**
-     * Processes an {@link Response} and returns some value
-     * corresponding to that response.
-     *
-     * @param response The response to process
-     * @return A value determined by the response
+     * Processes a {@link Response} and returns a value corresponding to that response.
      *
+     * @param response the response to process
+     * @param version  the SOAP version used in the response
+     * @return a value determined by the response
      * @throws SoapUIException in case of a problem or the connection was aborted
      */
     T handleResponse(Response response, SoapVersion version) throws SoapUIException;

src/main/java/com/smartbear/soapui/template/handler/def/SoapPlaintextResponseHandler.java

@@ -1,21 +1,29 @@
- package com.smartbear.soapui.template.handler.def;
+package com.smartbear.soapui.template.handler.def;
 
 import com.eviware.soapui.impl.wsdl.support.soap.SoapVersion;
 import com.eviware.soapui.model.iface.Response;
 import com.eviware.soapui.support.SoapUIException;
 import com.smartbear.soapui.template.handler.SoapResponseHandler;
 
 /**
- * 请求响应处理：返回String对象
+ * Response handler that extracts the SOAP response content as a plain text string.
+ *
  * @author [@Loong Wan](https://github.com/loong10k)
+ * @since 3.0.0
+ * @see SoapResponseHandler
  */
 public class SoapPlaintextResponseHandler implements SoapResponseHandler<String> {
- 
-	@Override	
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @return the response content as a plain text string
+	 */
+	@Override
 	public String handleResponse(Response response, SoapVersion version) throws SoapUIException {
 		return response.getContentAsString();
 	}
-	
+
 }