Changeset 6076 for SRUClient

Timestamp:

03/05/15 09:43:40 (9 years ago)

Author:

Oliver Schonefeld

Message:

• make available URI and version that were used for performing the request

Location:

SRUClient/trunk/src/main/java/eu/clarin/sru/client

Files:

• SRUAbstractRequest.java (modified) (5 diffs)
• SRUSimpleClient.java (modified) (3 diffs)

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUAbstractRequest.java

@@ -120 +120 @@
     /** A map of extra request data parameters. */
     protected Map<String, String> extraRequestData;
-    private SRUVersion versionPerformed;
+    /*
+     * The version that was used to perform the request.
+     * It is set as a side-effect of makeURI().
+     */
+    private SRUVersion versionRequested;
+    /*
+     * The URI that was used to perform the request.
+     * It is set a a side-effect of makeURI().
+     */
+    private URI uriRequested;
 
 
@@ -289 +298 @@
 
 
-    final SRUVersion getVersionPerformed() {
-        return versionPerformed;
-    }
-
-
-    final URI makeURI(SRUVersion defaultVersion)
+    /**
+     * Get the URI that was used to perform the request. This method may only be
+     * called <em>after</em> the request was carried out, otherwise it will
+     * throw an {@link IllegalStateException}.
+     *
+     * @return the URI that was used to carry out this request
+     * @throws IllegalStateException
+     *             if the request was not yet carried out
+     */
+    public final URI getRequestedURI() {
+        if (uriRequested == null) {
+            throw new IllegalStateException(
+                    "The request was not yet carried out");
+        }
+        return uriRequested;
+    }
+
+
+    /**
+     * Get the version that was used to carry out this request. This method may
+     * only be called <em>after</em> the request was carried out, otherwise it
+     * will throw an {@link IllegalStateException}.
+     *
+     * @return the version that was used to carry out this request
+     * @throws IllegalStateException
+     *             if the request was not yet carried out
+     */
+    public final SRUVersion getRequestedVersion() {
+        if (versionRequested == null) {
+            throw new IllegalStateException(
+                    "The request was not yet carried out");
+        }
+        return versionRequested;
+    }
+
+
+    /*
+     * This is not public API.
+     */
+    protected final URI makeURI(SRUVersion defaultVersion)
             throws SRUClientException {
         if (defaultVersion == null) {
@@ -346 +389 @@
                     getExtraRequestData(X_MALFORMED_VERSION);
             if (malformedVersion == null) {
-                versionPerformed = (version != null) ? version : defaultVersion;
-                switch (versionPerformed) {
+                versionRequested = (version != null) ? version : defaultVersion;
+                switch (versionRequested) {
                 case VERSION_1_1:
                     uriBuilder.append(PARAM_VERSION, VERSION_1_1);
@@ -356 +399 @@
                 default:
                     throw new SRUClientException("unsupported version: " +
-                            versionPerformed);
+                            versionRequested);
                 } // switch
             } else {
@@ -383 +426 @@
             }
 
-            return uriBuilder.makeURI();
+            final URI uri = uriBuilder.makeURI();
+            uriRequested = uri;
+            return uri;
         } catch (URISyntaxException e) {
             throw new SRUClientException("error while building request URI", e);

SRUClient/trunk/src/main/java/eu/clarin/sru/client/SRUSimpleClient.java

@@ -477 +477 @@
             // explainResponse/version
             SRUVersion version = parseVersion(reader);
-            logger.debug("version = {}, requested = {}",
-                    version, request.getVersionPerformed());
+            logger.debug("version = {}, requested = {}", version,
+                    request.getRequestedVersion());
 
             // explainResponse/record
@@ -699 +699 @@
                 SRUVersion version = parseVersion(reader);
                 logger.debug("version = {}, requested = {}", version,
-                        request.getVersionPerformed());
+                        request.getRequestedVersion());
 
                 // scanResponse/terms
@@ -879 +879 @@
                 SRUVersion version = parseVersion(reader);
                 logger.debug("version = {}, requested = {}", version,
-                        request.getVersionPerformed());
+                        request.getRequestedVersion());
 
                 // searchRetrieveResponse/numberOfRecords