Merge "J-484: Throw ResponseProcessingException during a processing of the Response on client"

Author: Marek Potociar

core-client/src/main/java/org/glassfish/jersey/client/ClientFilteringStages.java

@@ -45,6 +45,7 @@
 import javax.ws.rs.ProcessingException;
 import javax.ws.rs.client.ClientRequestFilter;
 import javax.ws.rs.client.ClientResponseFilter;
+import javax.ws.rs.client.ResponseProcessingException;
 import javax.ws.rs.core.Response;
 
 import org.glassfish.jersey.internal.inject.Providers;
@@ -139,7 +140,8 @@ public Continuation<ClientResponse> apply(ClientResponse responseContext) {
                     filter.filter(responseContext.getRequestContext(), responseContext);
                 }
             } catch (IOException ex) {
-                throw new ProcessingException(ex);
+                InboundJaxrsResponse response = new InboundJaxrsResponse(responseContext, null);
+                throw new ResponseProcessingException(response, ex);
             }
 
             return Continuation.of(responseContext, getDefaultNext());

core-client/src/main/java/org/glassfish/jersey/client/ClientRuntime.java

@@ -48,6 +48,7 @@
 import java.util.logging.Logger;
 
 import javax.ws.rs.ProcessingException;
+import javax.ws.rs.client.ResponseProcessingException;
 import javax.ws.rs.core.HttpHeaders;
 import javax.ws.rs.core.MultivaluedMap;
 
@@ -257,8 +258,8 @@ public ClientResponse invoke(final ClientRequest request) {
             }
 
             return Stages.process(response, responseProcessingRoot);
-        } catch (final ProcessingException ex) {
-            throw ex;
+        } catch (final ProcessingException pe) {
+            throw pe;
         } catch (final Throwable t) {
             throw new ProcessingException(t.getMessage(), t);
         }

core-client/src/main/java/org/glassfish/jersey/client/JerseyInvocation.java

@@ -65,6 +65,7 @@
 import javax.ws.rs.client.Entity;
 import javax.ws.rs.client.Invocation;
 import javax.ws.rs.client.InvocationCallback;
+import javax.ws.rs.client.ResponseProcessingException;
 import javax.ws.rs.core.CacheControl;
 import javax.ws.rs.core.Cookie;
 import javax.ws.rs.core.GenericType;
@@ -801,11 +802,15 @@ private <T> T translate(final ClientResponse response, final RequestScope scope,
             try {
                 return response.readEntity(responseType);
             } catch (final ProcessingException ex) {
-                throw ex;
+                if (ex.getClass() == ProcessingException.class) {
+                    throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope), ex.getCause());
+                }
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope), ex);
             } catch (final WebApplicationException ex) {
-                throw new ProcessingException(ex);
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope), ex);
             } catch (final Exception ex) {
-                throw new ProcessingException(LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope),
+                        LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
             }
         } else {
             throw convertToException(new InboundJaxrsResponse(response, scope));
@@ -861,11 +866,12 @@ private <T> T translate(final ClientResponse response, final RequestScope scope,
             try {
                 return response.readEntity(responseType);
             } catch (final ProcessingException ex) {
-                throw ex;
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope), ex.getCause());
             } catch (final WebApplicationException ex) {
-                throw new ProcessingException(ex);
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope), ex);
             } catch (final Exception ex) {
-                throw new ProcessingException(LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
+                throw new ResponseProcessingException(new InboundJaxrsResponse(response, scope),
+                        LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
             }
         } else {
             throw convertToException(new InboundJaxrsResponse(response, scope));
@@ -1022,9 +1028,9 @@ private ProcessingException convertToException(final Response response) {
                 }
             }
 
-            return new ProcessingException(webAppException);
+            return new ResponseProcessingException(response, webAppException);
         } catch (final Throwable t) {
-            return new ProcessingException(LocalizationMessages.RESPONSE_TO_EXCEPTION_CONVERSION_FAILED(), t);
+            return new ResponseProcessingException(response, LocalizationMessages.RESPONSE_TO_EXCEPTION_CONVERSION_FAILED(), t);
         }
     }
 

core-client/src/main/java/org/glassfish/jersey/client/authentication/BasicAuthenticator.java

@@ -40,7 +40,6 @@
 
 package org.glassfish.jersey.client.authentication;
 
-import javax.ws.rs.ProcessingException;
 import javax.ws.rs.client.ClientRequestContext;
 import javax.ws.rs.client.ClientResponseContext;
 import javax.ws.rs.core.HttpHeaders;
@@ -56,6 +55,7 @@
  * @author Craig McClanahan
  */
 final class BasicAuthenticator {
+
     private final HttpAuthenticationFilter.Credentials defaultCredentials;
 
     /**
@@ -68,7 +68,6 @@ final class BasicAuthenticator {
         this.defaultCredentials = defaultCredentials;
     }
 
-
     private String calculateAuthentication(HttpAuthenticationFilter.Credentials credentials) {
         String username = credentials.getUsername();
         byte[] password = credentials.getPassword();
@@ -89,28 +88,30 @@ private String calculateAuthentication(HttpAuthenticationFilter.Credentials cred
         return "Basic " + Base64.encodeAsString(usernamePassword);
     }
 
-
     /**
      * Adds authentication information to the request.
      *
      * @param request Request context.
+     * @throws RequestAuthenticationException in case that basic credentials missing or are in invalid format
      */
-    public void filterRequest(ClientRequestContext request) {
+    public void filterRequest(ClientRequestContext request) throws RequestAuthenticationException {
         HttpAuthenticationFilter.Credentials credentials = HttpAuthenticationFilter.getCredentials(request,
                 defaultCredentials, HttpAuthenticationFilter.Type.BASIC);
         if (credentials == null) {
-            throw new ProcessingException(LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_BASIC());
+            throw new RequestAuthenticationException(LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_BASIC());
         }
         request.getHeaders().add(HttpHeaders.AUTHORIZATION, calculateAuthentication(credentials));
     }
 
     /**
      * Checks the response and if basic authentication is required then performs a new request
      * with basic authentication.
-     * @param request Request context.
+     *
+     * @param request  Request context.
      * @param response Response context (will be updated with newest response data if the request was repeated).
      * @return {@code true} if response does not require authentication or if authentication is required,
-     *                  new request was done with digest authentication information and authentication was successful.
+     * new request was done with digest authentication information and authentication was successful.
+     * @throws ResponseAuthenticationException in case that basic credentials missing or are in invalid format
      */
     public boolean filterResponseAndAuthenticate(ClientRequestContext request, ClientResponseContext response) {
         final String authenticate = response.getHeaders().getFirst(HttpHeaders.WWW_AUTHENTICATE);
@@ -119,7 +120,7 @@ public boolean filterResponseAndAuthenticate(ClientRequestContext request, Clien
                     .getCredentials(request, defaultCredentials, HttpAuthenticationFilter.Type.BASIC);
 
             if (credentials == null) {
-                throw new ProcessingException(LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_BASIC());
+                throw new ResponseAuthenticationException(null, LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_BASIC());
             }
 
             return HttpAuthenticationFilter.repeatRequest(request, response, calculateAuthentication(credentials));

core-client/src/main/java/org/glassfish/jersey/client/authentication/DigestAuthenticator.java

@@ -52,7 +52,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import javax.ws.rs.ProcessingException;
 import javax.ws.rs.client.ClientRequestContext;
 import javax.ws.rs.client.ClientResponseContext;
 import javax.ws.rs.core.HttpHeaders;
@@ -84,26 +83,26 @@ final class DigestAuthenticator {
      * Create a new instance initialized from credentials and configuration.
      *
      * @param credentials Credentials. Can be {@code null} if there are no default credentials.
-     * @param limit Maximum number of URIs that should be kept in the cache containing URIs and their
-     * {@link org.glassfish.jersey.client.authentication.DigestAuthenticator.DigestScheme}.
+     * @param limit       Maximum number of URIs that should be kept in the cache containing URIs and their
+     *                    {@link org.glassfish.jersey.client.authentication.DigestAuthenticator.DigestScheme}.
      */
     DigestAuthenticator(final HttpAuthenticationFilter.Credentials credentials, final int limit) {
         this.credentials = credentials;
 
         digestCache = Collections.synchronizedMap(new LinkedHashMap<URI, DigestScheme>(limit) {
-                    // use id as it is an anonymous inner class with changed behaviour
-                    private static final long serialVersionUID = 2546245625L;
+            // use id as it is an anonymous inner class with changed behaviour
+            private static final long serialVersionUID = 2546245625L;
 
-                    @Override
-                    protected boolean removeEldestEntry(final Map.Entry eldest) {
-                        return size() > limit;
-                    }
-                });
+            @Override
+            protected boolean removeEldestEntry(final Map.Entry eldest) {
+                return size() > limit;
+            }
+        });
 
         try {
             randomGenerator = SecureRandom.getInstance("SHA1PRNG");
         } catch (final NoSuchAlgorithmException e) {
-            throw new ProcessingException(LocalizationMessages.ERROR_DIGEST_FILTER_GENERATOR(), e);
+            throw new RequestAuthenticationException(LocalizationMessages.ERROR_DIGEST_FILTER_GENERATOR(), e);
         }
     }
 
@@ -131,7 +130,7 @@ boolean filterRequest(final ClientRequestContext request) throws IOException {
      * Process response and repeat the request if digest authentication is requested. When request is repeated
      * the response will be modified to contain new response information.
      *
-     * @param request Request context.
+     * @param request  Request context.
      * @param response Response context (will be updated with newest response data if the request was repeated).
      * @return {@code true} if response does not require authentication or if authentication is required,
      * new request was done with digest authentication information and authentication was successful.
@@ -150,7 +149,8 @@ public boolean filterResponse(final ClientRequestContext request, final ClientRe
             final HttpAuthenticationFilter.Credentials cred = HttpAuthenticationFilter.getCredentials(request,
                     this.credentials, HttpAuthenticationFilter.Type.DIGEST);
             if (cred == null) {
-                throw new RuntimeException(LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_DIGEST());
+
+                throw new ResponseAuthenticationException(null, LocalizationMessages.AUTHENTICATION_CREDENTIALS_MISSING_DIGEST());
             }
 
             final boolean success = HttpAuthenticationFilter.repeatRequest(request, response, createNextAuthToken(digestScheme,
@@ -231,7 +231,7 @@ private DigestScheme parseAuthHeaders(final List<?> headers) throws IOException
     /**
      * Creates digest string including counter.
      *
-     * @param ds DigestScheme instance
+     * @param ds             DigestScheme instance
      * @param requestContext client request context
      * @return digest authentication token string
      * @throws IOException
@@ -279,9 +279,9 @@ private String createNextAuthToken(final DigestScheme ds, final ClientRequestCon
     /**
      * Append comma separated key=value token
      *
-     * @param sb string builder instance
-     * @param key key string
-     * @param value value string
+     * @param sb       string builder instance
+     * @param key      key string
+     * @param value    value string
      * @param useQuote true if value needs to be enclosed in quotes
      */
     private static void append(final StringBuilder sb, final String key, final String value, final boolean useQuote) {
@@ -309,8 +309,8 @@ private static void append(final StringBuilder sb, final String key, final Strin
      * Append comma separated key=value token. The value gets enclosed in
      * quotes.
      *
-     * @param sb string builder instance
-     * @param key key string
+     * @param sb    string builder instance
+     * @param key   key string
      * @param value value string
      */
     private static void append(final StringBuilder sb, final String key, final String value) {

core-client/src/main/java/org/glassfish/jersey/client/authentication/HttpAuthenticationFilter.java

@@ -50,7 +50,6 @@
 import java.util.Map;
 
 import javax.ws.rs.Priorities;
-import javax.ws.rs.ProcessingException;
 import javax.ws.rs.client.Client;
 import javax.ws.rs.client.ClientBuilder;
 import javax.ws.rs.client.ClientRequestContext;
@@ -120,12 +119,12 @@ static enum Type {
     /**
      * Create a new filter instance.
      *
-     * @param mode Mode.
-     * @param basicCredentials Basic credentials (can be {@code null} if this filter does not work in the
-     *                         basic mode or if no default credentials are defined).
+     * @param mode              Mode.
+     * @param basicCredentials  Basic credentials (can be {@code null} if this filter does not work in the
+     *                          basic mode or if no default credentials are defined).
      * @param digestCredentials Digest credentials (can be {@code null} if this filter does not work in the
-     *                         digest mode or if no default credentials are defined).
-     * @param configuration Configuration (non-{@code null}).
+     *                          digest mode or if no default credentials are defined).
+     * @param configuration     Configuration (non-{@code null}).
      */
     HttpAuthenticationFilter(HttpAuthenticationFeature.Mode mode, Credentials basicCredentials,
                              Credentials digestCredentials, Configuration configuration) {
@@ -288,13 +287,11 @@ private void updateCache(ClientRequestContext request, boolean success, Type ope
      * Repeat the {@code request} with provided {@code newAuthorizationHeader}
      * and update the {@code response} with newest response data.
      *
-     * @param request Request context.
-     * @param response Response context (will be updated with the new response data).
+     * @param request                Request context.
+     * @param response               Response context (will be updated with the new response data).
      * @param newAuthorizationHeader {@code Authorization} header that should be added to the new request.
-     *
      * @return {@code true} is the authentication was successful ({@code true} if 401 response code was not returned;
      * {@code false} otherwise).
-     *
      */
     static boolean repeatRequest(ClientRequestContext request, ClientResponseContext response, String newAuthorizationHeader) {
         Client client = ClientBuilder.newClient(request.getConfiguration());
@@ -350,6 +347,7 @@ static class Credentials {
 
         /**
          * Create a new credentials from username and password as byte array.
+         *
          * @param username Username.
          * @param password Password as byte array.
          */
@@ -360,6 +358,7 @@ static class Credentials {
 
         /**
          * Create a new credentials from username and password as {@link String}.
+         *
          * @param username Username.
          * @param password {@code String} password.
          */
@@ -410,7 +409,8 @@ private static Credentials extractCredentials(ClientRequestContext request, Type
             } else if (password instanceof String) {
                 pwdBytes = ((String) password).getBytes(CHARACTER_SET);
             } else {
-                throw new ProcessingException(LocalizationMessages.AUTHENTICATION_CREDENTIALS_REQUEST_PASSWORD_UNSUPPORTED());
+                throw new RequestAuthenticationException(
+                        LocalizationMessages.AUTHENTICATION_CREDENTIALS_REQUEST_PASSWORD_UNSUPPORTED());
             }
             return new Credentials(userName, pwdBytes);
         }
@@ -420,16 +420,16 @@ private static Credentials extractCredentials(ClientRequestContext request, Type
     /**
      * Get credentials actual for the current request. Priorities in credentials selection are the following:
      * <ol>
-     *     <li>Basic/digest specific credentials defined in the request properties</li>
-     *     <li>Common credentials defined in the request properties</li>
-     *     <li>{@code defaultCredentials}</li>
+     * <li>Basic/digest specific credentials defined in the request properties</li>
+     * <li>Common credentials defined in the request properties</li>
+     * <li>{@code defaultCredentials}</li>
      * </ol>
      *
-     * @param request Request from which credentials should be extracted.
+     * @param request            Request from which credentials should be extracted.
      * @param defaultCredentials Default credentials (can be {@code null}).
-     * @param type Type of requested credentials.
-     *
+     * @param type               Type of requested credentials.
      * @return Credentials or {@code null} if no credentials are found and {@code defaultCredentials} are {@code null}.
+     * @throws RequestAuthenticationException in case the {@code username} or {@code password} is invalid.
      */
     static Credentials getCredentials(ClientRequestContext request, Credentials defaultCredentials, Type type) {
         Credentials commonCredentials = extractCredentials(request, type);