Changeset 2681

Timestamp:

03/12/13 17:26:42 (11 years ago)

Author:

oschonef

Message:

• automatically apply default upper limit to "maximumTerms"
• add configuration settings for "maximumTerms"

Location:

SRUServer/trunk/src/main/java/eu/clarin/sru/server

Files:

• SRURequestImpl.java (modified) (2 diffs)
• SRUServerConfig.java (modified) (12 diffs)

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRURequestImpl.java

@@ -54 +54 @@
     private static final String PARAM_EXTENSION_PREFIX  = "x-";
     private static final String X_UNLIMITED_RESULTSET   = "x-unlimited-resultset";
+    private static final String X_UNLIMITED_TERMLIST    = "x-unlimited-termlist";
     private static final String X_INDENT_RESPONSE       = "x-indent-response";
     private static final int DEFAULT_START_RECORD       = 1;
@@ -558 +559 @@
     @Override
     public int getMaximumTerms() {
-        return maximumTerms;
+        if (config.allowOverrideMaximumTerms() &&
+                (getExtraRequestData(X_UNLIMITED_TERMLIST) != null)) {
+            return -1;
+        }
+        if (maximumTerms == -1) {
+            return config.getNumberOfTerms();
+        } else {
+            if (maximumTerms > config.getMaximumTerms()) {
+                return config.getMaximumTerms();
+            } else {
+                return maximumTerms;
+            }
+        }
     }
 

SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUServerConfig.java

@@ -127 +127 @@
     /**
      * Parameter constant for configuring the <em>default</em> number of records
-     * the SRU server will provide in the response to a request if the client
-     * does not specify a limit.
+     * the SRU server will provide in the response to a <em>searchRetrieve</em>
+     * request if the client does not provide this value.
      * <p>
      * Valid values: a integer greater than 0 (default value is 100)
@@ -137 +137 @@
     /**
      * Parameter constant for configuring the <em>maximum</em> number of records
-     * the SRU server will support in one request. If a client requests more
-     * records, the number will be limited to this value.
+     * the SRU server will support in the response to a <em>searchRetrieve</em>
+     * request. If a client requests more records, the number will be limited to
+     * this value.
      * <p>
      * Valid values: a integer greater than 0 (default value is 250)
@@ -145 +146 @@
     public static final String SRU_MAXIMUM_RECORDS =
             "eu.clarin.sru.server.maximumRecords";
+    /**
+     * Parameter constant for configuring the <em>default</em> number of terms
+     * the SRU server will provide in the response to a <em>scan</em> request if
+     * the client does not provide this value.
+     * <p>
+     * Valid values: a integer greater than 0 (default value is 250)
+     * </p>
+     */
+    public static final String SRU_NUMBER_OF_TERMS =
+            "eu.clarin.sru.server.numberOfTerms";
+    /**
+     * Parameter constant for configuring the <em>maximum</em> number of terms
+     * the SRU server will support in the response to a <em>scan</em> request.
+     * If a client requests more records, the number will be limited to this
+     * value.
+     * <p>
+     * Valid values: a integer greater than 0 (default value is 500)
+     * </p>
+     */
+    public static final String SRU_MAXIMUM_TERMS =
+            "eu.clarin.sru.server.maximumTerms";
     /**
      * Parameter constant for configuring, if the SRU server will echo the
@@ -177 +199 @@
     /**
      * Parameter constant for configuring, if the SRU server will allow the
+     * client to override the maximum number of terms the server supports.
+     * This parameter is solely intended for debugging and enabling it is
+     * <em>strongly</em> discouraged for production setups.
+     * <p>
+     * Valid values: <code>true</code> or <code>false</code>
+     * </p>
+     */
+    public static final String SRU_ALLOW_OVERRIDE_MAXIMUM_TERMS =
+            "eu.clarin.sru.server.allowOverrideMaximumTerms";
+    /**
+     * Parameter constant for configuring, if the SRU server will allow the
      * client to override the pretty-printing setting of the server. This
      * parameter is solely intended for debugging and enabling it is
@@ -247 +280 @@
             "sru.allowOverrideIndentResponse";
     private static final int DEFAULT_NUMBER_OF_RECORDS = 100;
-    private static final int DEFAULT_MAXIMUM_RECORDS = 250;
+    private static final int DEFAULT_MAXIMUM_RECORDS   = 250;
+    private static final int DEFAULT_NUMBER_OF_TERMS   = 250;
+    private static final int DEFAULT_MAXIMUM_TERMS     = 500;
     private static final String CONFIG_FILE_NAMESPACE_URI =
             "http://www.clarin.eu/sru-server/1.0/";
@@ -583 +618 @@
     private final int numberOfRecords;
     private final int maximumRecords;
+    private final int numberOfTerms;
+    private final int maximumTerms;
     private final boolean echoRequests;
     private final int indentResponse;
     private final boolean allowOverrideMaximumRecords;
+    private final boolean allowOverrideMaximumTerms;
     private final boolean allowOverrideIndentResponse;
     private final String baseUrl;
@@ -595 +633 @@
     private SRUServerConfig(String transport, String host, int port,
             String database, int numberOfRecords, int maximumRecords,
-            boolean echoRequests, int indentResponse,
-            boolean allowOverrideMaximumRecords,
-            boolean allowOverrideIndentResponse,
-            DatabaseInfo databaseinfo, IndexInfo indexInfo,
-            List<SchemaInfo> schemaInfo) {
+            int numberOfTerms, int maximumTerms, boolean echoRequests,
+            int indentResponse, boolean allowOverrideMaximumRecords,
+            boolean allowOverrideMaximumTerms,
+            boolean allowOverrideIndentResponse, DatabaseInfo databaseinfo,
+            IndexInfo indexInfo, List<SchemaInfo> schemaInfo) {
         this.transport                   = transport;
         this.host                        = host;
@@ -606 +644 @@
         this.numberOfRecords             = numberOfRecords;
         this.maximumRecords              = maximumRecords;
+        this.numberOfTerms               = numberOfTerms;
+        this.maximumTerms                = maximumTerms;
         this.echoRequests                = echoRequests;
         this.indentResponse              = indentResponse;
         this.allowOverrideMaximumRecords = allowOverrideMaximumRecords;
+        this.allowOverrideMaximumTerms   = allowOverrideMaximumTerms;
         this.allowOverrideIndentResponse = allowOverrideIndentResponse;
         this.databaseInfo                = databaseinfo;
@@ -679 +720 @@
 
 
+    public int getNumberOfTerms() {
+        return numberOfTerms;
+    }
+
+
+    public int getMaximumTerms() {
+        return maximumTerms;
+    }
+
+
     public int getIndentResponse() {
         return indentResponse;
@@ -686 +737 @@
     public boolean allowOverrideMaximumRecords() {
         return allowOverrideMaximumRecords;
+    }
+
+
+    public boolean allowOverrideMaximumTerms() {
+        return allowOverrideMaximumTerms;
     }
 
@@ -907 +963 @@
                     false, DEFAULT_MAXIMUM_RECORDS, numberOfRecords, -1);
 
+            int numberOfTerms = parseNumber(params, SRU_NUMBER_OF_TERMS,
+                    false, DEFAULT_NUMBER_OF_TERMS, 0, -1);
+
+            int maximumTerms = parseNumber(params, SRU_MAXIMUM_TERMS, false,
+                        DEFAULT_MAXIMUM_TERMS, numberOfTerms, -1);
+
             boolean echoRequests = parseBoolean(params, SRU_ECHO_REQUESTS,
                     false, true);
@@ -916 +978 @@
                     SRU_ALLOW_OVERRIDE_MAXIMUM_RECORDS, false, false);
 
+            boolean allowOverrideMaximumTerms = parseBoolean(params,
+                    SRU_ALLOW_OVERRIDE_MAXIMUM_TERMS, false, false);
+
             boolean allowOverrideIndentResponse = parseBoolean(params,
                     SRU_ALLOW_OVERRIDE_INDENT_RESPONSE, false, false);
 
             return new SRUServerConfig(transport, host, port, database,
-                    numberOfRecords, maximumRecords, echoRequests,
-                    indentResponse, allowOverrideMaximumRecords,
+                    numberOfRecords, maximumRecords, numberOfTerms,
+                    maximumTerms, echoRequests, indentResponse,
+                    allowOverrideMaximumRecords, allowOverrideMaximumTerms,
                     allowOverrideIndentResponse, databaseInfo, indexInfo,
                     schemaInfo);