Renames class, removes obsolete, javadoc

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / ServiceProxyClient.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/ServiceProxyClient.java b/src/main/java/com/indexdata/mkjsf/pazpar2/ServiceProxyClient.java
index 2956afc..ace35b1 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/ServiceProxyClient.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/ServiceProxyClient.java
@@ -41,6 +41,12 @@ import com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand;
 import com.indexdata.mkjsf.pazpar2.data.CommandError;\r
 import com.indexdata.mkjsf.utils.Utils;\r
 \r
+/**\r
+ * Search client handling Service Proxy requests. \r
+ *   \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class ServiceProxyClient implements SearchClient {\r
     \r
   private static final long serialVersionUID = -4031644009579840277L;\r
@@ -165,6 +171,9 @@ public class ServiceProxyClient implements SearchClient {
     return handler.getReasonPhrase();\r
   }\r
 \r
+  /**\r
+   * Does nothing in Service Proxy context\r
+   */\r
   @Override\r
   public void setSearchCommand(Pazpar2Command command) {\r
     // Do nothing, Service Proxy is handling this    \r
@@ -184,11 +193,17 @@ public class ServiceProxyClient implements SearchClient {
     return clone;\r
   }\r
 \r
+  /**\r
+   * Returns default configuration parameters for the client.\r
+   */\r
   @Override\r
   public Map<String, String> getDefaults() {    \r
     return new HashMap<String,String>();\r
   }\r
 \r
+  /**\r
+   * Returns the configuration name of the client\r
+   */\r
   @Override\r
   public String getModuleName() {\r
     return MODULENAME;\r
@@ -251,6 +266,9 @@ public class ServiceProxyClient implements SearchClient {
     return commandResponse;    \r
   }\r
   \r
+  /**\r
+   * Sets the URL of the Service Proxy that should service requests. \r
+   */\r
   public void setServiceUrl (String url) {    \r
     serviceUrl = url;\r
   }\r
@@ -264,6 +282,9 @@ public class ServiceProxyClient implements SearchClient {
     return serviceUrl;\r
   }\r
 \r
+  /**\r
+   * Returns true if a Service Proxy URL was defined yet.\r
+   */\r
   @Override\r
   public boolean hasServiceUrl() {\r
     return serviceUrl != null && serviceUrl.length()>0;\r