Changeset 7266

Timestamp:

01/05/22 22:26:59 (2 years ago)

Author:

Oliver Schonefeld

Message:

• re-factor to make SRUOperation available
• add experimental support for processing authenticated requests

Location:

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

Files:

• SRUAbstractRequest.java (modified) (2 diffs)
• SRUClientConfig.java (modified) (5 diffs)
• SRUExplainRequest.java (modified) (1 diff)
• SRUOperation.java (added)
• SRURequestAuthenticator.java (added)
• SRUScanRequest.java (modified) (1 diff)
• SRUSearchRetrieveRequest.java (modified) (1 diff)
• SRUSimpleClient.java (modified) (9 diffs)

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

@@ -81 +81 @@
 
 
-    enum SRUOperation {
-        EXPLAIN, SCAN, SEARCH_RETRIEVE
-    } // enum SRUOperation
-
-
     protected static class URIHelper {
         private final URIBuilder uriBuilder;
@@ -477 +472 @@
      * @return a operation constant for this request
      */
-    abstract SRUOperation getOperation();
+    public abstract SRUOperation getOperation();
 
 

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

@@ -39 +39 @@
     private final CloseableHttpClient httpClient;
     private final HttpClientContext httpContext;
+    private final SRURequestAuthenticator requestAuthenticator;
     private final int threadCount;
     private final List<SRURecordDataParser> recordParsers;
@@ -83 +84 @@
     public CloseableHttpClient getCustomizedHttpClient() {
         return httpClient;
+    }
+
+
+    /**
+     * Get the request authenticator
+     * 
+     * @return the configured request authenticator or <code>null</code>
+     */
+    public SRURequestAuthenticator getRequestAuthenticator() {
+        return requestAuthenticator;
     }
 
@@ -142 +153 @@
             this.httpContext = null;
         }
+        this.requestAuthenticator = builder.requestAuthenticator;
         this.threadCount      = builder.threadCount;
         if (builder.recordParsers != null) {
@@ -170 +182 @@
         private CloseableHttpClient httpClient = null;
         private HttpClientContext httpContext = null;
+        private SRURequestAuthenticator requestAuthenticator;
         private int threadCount =
                 Runtime.getRuntime().availableProcessors() * 2;
@@ -271 +284 @@
 
 
+        public Builder setRequestAuthenticator(
+                SRURequestAuthenticator requestAuthenticator) {
+            this.requestAuthenticator = requestAuthenticator;
+            return this;
+        }
+
+
         /**
          * Set the number of worker threads. This value is only relevant for the

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

@@ -105 +105 @@
 
     @Override
-    SRUOperation getOperation() {
+    public SRUOperation getOperation() {
         return SRUOperation.EXPLAIN;
     }

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

@@ -152 +152 @@
 
     @Override
-    SRUOperation getOperation() {
+    public SRUOperation getOperation() {
         return SRUOperation.SCAN;
     }

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

@@ -313 +313 @@
 
     @Override
-    SRUOperation getOperation() {
+    public SRUOperation getOperation() {
         return SRUOperation.SEARCH_RETRIEVE;
     }

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

@@ -85 +85 @@
     private final CloseableHttpClient httpClient;
     private final HttpContext httpContext;
+    private final SRURequestAuthenticator requestAuthenticator;
     private final XmlStreamReaderProxy proxy = new XmlStreamReaderProxy();
     private final SRUExplainRecordDataParser explainRecordParser =
@@ -124 +125 @@
             }
         }
-
         final CloseableHttpClient client = config.getCustomizedHttpClient();
         if (client != null) {
@@ -136 +136 @@
             httpContext = null;
         }
+        this.requestAuthenticator = config.getRequestAuthenticator();
     }
 
@@ -168 +169 @@
         // create URI and perform request
         final URI uri = request.makeURI(defaultVersion);
-        CloseableHttpResponse response = executeRequest(uri);
+        CloseableHttpResponse response = executeRequest(uri, request);
         InputStream stream             = null;
         SRUXMLStreamReader reader      = null;
@@ -258 +259 @@
         // create URI and perform request
         final URI uri = request.makeURI(defaultVersion);
-        CloseableHttpResponse response = executeRequest(uri);
+        CloseableHttpResponse response = executeRequest(uri, request);
         InputStream stream             = null;
         SRUXMLStreamReader reader      = null;
@@ -347 +348 @@
         // create URI and perform request
         final URI uri = request.makeURI(defaultVersion);
-        CloseableHttpResponse response = executeRequest(uri);
+        CloseableHttpResponse response = executeRequest(uri, request);
         InputStream stream             = null;
         SRUXMLStreamReader reader      = null;
@@ -407 +408 @@
 
 
-    private CloseableHttpResponse executeRequest(URI uri)
-            throws SRUClientException {
+    private CloseableHttpResponse executeRequest(URI requestUri,
+            SRUAbstractRequest sruRequest) throws SRUClientException {
         CloseableHttpResponse response = null;
         boolean forceClose             = true;
         try {
-            logger.debug("submitting HTTP request: {}", uri.toString());
             try {
-                HttpGet request = new HttpGet(uri);
+                HttpGet request = new HttpGet(requestUri);
+                if (requestAuthenticator != null) {
+                    String value = requestAuthenticator.createAuthenticationHeaderValue(
+                            sruRequest.getOperation(),
+                            sruRequest.getBaseURI().toString());
+                    if (value != null) {
+                        value = value.trim();
+                        if (!value.isEmpty()) {
+                            logger.debug("adding HTTP authentication header with value: {}", value);
+                            request.addHeader("Authentication", value);
+                        } else {
+                            logger.error("request authenticator returned an empty header value!");
+                        }
+                    }
+                }
+                logger.debug("submitting HTTP request: {}", requestUri.toString());
                 response = httpClient.execute(request, httpContext);
                 StatusLine status = response.getStatusLine();
                 if (status.getStatusCode() != HttpStatus.SC_OK) {
                     if (status.getStatusCode() == HttpStatus.SC_NOT_FOUND) {
-                        throw new SRUClientException("not found: " + uri);
+                        throw new SRUClientException("not found: " + requestUri);
                     } else {
                         throw new SRUClientException("unexpected status: " +
@@ -431 +446 @@
             } catch (UnknownHostException e) {
                 throw new SRUClientException(
-                        "unknown host: " + uri.getHost(), e);
+                        "unknown host: " + requestUri.getHost(), e);
             } catch (IOException e) {
                 String msg = null;
@@ -1279 +1294 @@
                     (diagnostics == null), strictMode)) != null) {
                 if (diagnostics == null) {
-                    diagnostics = new ArrayList<SRUDiagnostic>();
+                    diagnostics = new ArrayList<>();
                 }
                 diagnostics.add(diagnostic);