Minor refactor, ensure some NPE can't happen while handling headers.

thboileau · thboileau · commit 0e0a2a48b83d · 2016-12-10T15:37:10.000+01:00
diff --git a/modules/org.restlet/src/org/restlet/Message.java b/modules/org.restlet/src/org/restlet/Message.java
@@ -24,6 +24,9 @@
 
 package org.restlet;
 
+import static org.restlet.engine.header.HeaderConstants.ATTRIBUTE_HEADERS;
+import static org.restlet.representation.Representation.UNKNOWN_SIZE;
+
 import java.io.IOException;
 import java.util.Date;
 import java.util.List;
@@ -37,7 +40,6 @@
 import org.restlet.data.MediaType;
 import org.restlet.data.RecipientInfo;
 import org.restlet.data.Warning;
-import org.restlet.engine.header.HeaderConstants;
 import org.restlet.representation.Representation;
 import org.restlet.representation.StringRepresentation;
 import org.restlet.resource.ClientResource;
@@ -105,8 +107,7 @@ public Message(Representation entity) {
     // [ifndef gwt] method
     /**
      * If the entity is transient or its size unknown in advance but available,
-     * then the entity is wrapped with a
-     * {@link org.restlet.representation.BufferingRepresentation}.<br>
+     * then the entity is wrapped with a {@link org.restlet.representation.BufferingRepresentation}.<br>
      * <br>
      * Be careful as this method could create potentially very large byte
      * buffers in memory that could impact your application performance.
@@ -117,10 +118,9 @@ public Message(Representation entity) {
      */
     public void bufferEntity() {
         if ((getEntity() != null)
-                && (getEntity().isTransient() || (getEntity().getSize() == Representation.UNKNOWN_SIZE))
+                && (getEntity().isTransient() || getEntity().getSize() == UNKNOWN_SIZE)
                 && getEntity().isAvailable()) {
-            setEntity(new org.restlet.representation.BufferingRepresentation(
-                    getEntity()));
+            setEntity(new org.restlet.representation.BufferingRepresentation(getEntity()));
         }
     }
 
@@ -153,17 +153,15 @@ public void flushBuffers() throws IOException {
      * <tr>
      * <td>org.restlet.http.headers</td>
      * <td>org.restlet.util.Series&lt;org.restlet.engine.header.Header&gt;</td>
-     * <td>Server HTTP connectors must provide all request headers and client
-     * HTTP connectors must provide all response headers, exactly as they were
-     * received. In addition, developers can also use this attribute to specify
-     * <b>non-standard</b> headers that should be added to the request or to the
-     * response.</td>
+     * <td>Server HTTP connectors must provide all request headers and client HTTP connectors must provide all response
+     * headers, exactly as they were received. In addition, developers can also use this attribute to specify
+     * <b>non-standard</b> headers that should be added to the request or to the response.</td>
      * </tr>
      * <tr>
      * <td>org.restlet.https.clientCertificates</td>
      * <td>List<java.security.cert.Certificate></td>
-     * <td>For requests received via a secure connector, indicates the ordered
-     * list of client certificates, if they are available and accessible.</td>
+     * <td>For requests received via a secure connector, indicates the ordered list of client certificates, if they are
+     * available and accessible.</td>
      * </tr>
      * </table>
      * <br>
@@ -242,8 +240,7 @@ public Representation getEntity() {
     public String getEntityAsText() {
         if (this.entityText == null) {
             try {
-                this.entityText = (getEntity() == null) ? null : getEntity()
-                        .getText();
+                this.entityText = (getEntity() == null) ? null : getEntity().getText();
             } catch (java.io.IOException e) {
                 Context.getCurrentLogger().log(java.util.logging.Level.FINE,
                         "Unable to get the entity text.", e);
@@ -263,14 +260,13 @@ public String getEntityAsText() {
      */
     @SuppressWarnings("unchecked")
     public Series<Header> getHeaders() {
-        Series<Header> headers = (Series<Header>) getAttributes().get(
-                HeaderConstants.ATTRIBUTE_HEADERS);
+        Series<Header> headers = (Series<Header>) getAttributes().get(ATTRIBUTE_HEADERS);
         if (headers == null) {
             // [ifndef gwt] instruction
             headers = new Series<Header>(Header.class);
             // [ifdef gwt] instruction uncomment
             // headers = new org.restlet.engine.util.HeaderSeries();
-            getAttributes().put(HeaderConstants.ATTRIBUTE_HEADERS, headers);
+            getAttributes().put(ATTRIBUTE_HEADERS, headers);
         }
         return headers;
     }
diff --git a/modules/org.restlet/src/org/restlet/engine/adapter/ClientAdapter.java b/modules/org.restlet/src/org/restlet/engine/adapter/ClientAdapter.java
@@ -125,8 +125,7 @@ protected void readResponseHeaders(ClientCall httpCall, Response response) {
             Series<Header> responseHeaders = httpCall.getResponseHeaders();
 
             // Put the response headers in the call's attributes map
-            response.getAttributes().put(HeaderConstants.ATTRIBUTE_HEADERS,
-                    responseHeaders);
+            response.getAttributes().put(HeaderConstants.ATTRIBUTE_HEADERS, responseHeaders);
 
             HeaderUtils.copyResponseTransportHeaders(responseHeaders, response);
         } catch (Exception e) {
diff --git a/modules/org.restlet/src/org/restlet/engine/adapter/ClientCall.java b/modules/org.restlet/src/org/restlet/engine/adapter/ClientCall.java
@@ -24,6 +24,13 @@
 
 package org.restlet.engine.adapter;
 
+import static org.restlet.data.Encoding.IDENTITY;
+import static org.restlet.data.Status.CONNECTOR_ERROR_COMMUNICATION;
+import static org.restlet.data.Status.REDIRECTION_NOT_MODIFIED;
+import static org.restlet.data.Status.SUCCESS_NO_CONTENT;
+import static org.restlet.data.Status.SUCCESS_RESET_CONTENT;
+import static org.restlet.representation.Representation.UNKNOWN_SIZE;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -32,7 +39,6 @@
 import org.restlet.Context;
 import org.restlet.Request;
 import org.restlet.Response;
-import org.restlet.data.Encoding;
 import org.restlet.data.Header;
 import org.restlet.data.Method;
 import org.restlet.data.Status;
@@ -87,8 +93,7 @@ public ClientCall(HttpClientHelper helper, String method, String requestUri) {
     }
 
     /**
-     * Returns the content length of the request entity if know,
-     * {@link Representation#UNKNOWN_SIZE} otherwise.
+     * Returns the content length of the request entity if know, {@link Representation#UNKNOWN_SIZE} otherwise.
      * 
      * @return The request content length.
      */
@@ -148,26 +153,24 @@ public HttpClientHelper getHelper() {
     public Representation getResponseEntity(Response response) {
         Representation result = null;
         // boolean available = false;
-        long size = Representation.UNKNOWN_SIZE;
+        long size = UNKNOWN_SIZE;
 
         // Compute the content length
         Series<Header> responseHeaders = getResponseHeaders();
         String transferEncoding = responseHeaders.getFirstValue(
                 HeaderConstants.HEADER_TRANSFER_ENCODING, true);
         if ((transferEncoding != null)
-                && !Encoding.IDENTITY.getName().equalsIgnoreCase(
-                        transferEncoding)) {
-            size = Representation.UNKNOWN_SIZE;
+                && !IDENTITY.getName().equalsIgnoreCase(transferEncoding)) {
+            size = UNKNOWN_SIZE;
         } else {
             size = getContentLength();
         }
 
         if (!getMethod().equals(Method.HEAD.getName())
                 && !response.getStatus().isInformational()
-                && !response.getStatus()
-                        .equals(Status.REDIRECTION_NOT_MODIFIED)
-                && !response.getStatus().equals(Status.SUCCESS_NO_CONTENT)
-                && !response.getStatus().equals(Status.SUCCESS_RESET_CONTENT)) {
+                && !response.getStatus().equals(REDIRECTION_NOT_MODIFIED)
+                && !response.getStatus().equals(SUCCESS_NO_CONTENT)
+                && !response.getStatus().equals(SUCCESS_RESET_CONTENT)) {
             // Make sure that an InputRepresentation will not be instantiated
             // while the stream is closed.
             InputStream stream = getUnClosedResponseEntityStream(getResponseEntityStream(size));
@@ -187,7 +190,7 @@ public Representation getResponseEntity(Response response) {
             result.setSize(size);
 
             // Informs that the size has not been specified in the header.
-            if (size == Representation.UNKNOWN_SIZE) {
+            if (size == UNKNOWN_SIZE) {
                 getLogger()
                         .fine("The length of the message body is unknown. The entity must be handled carefully and consumed entirely in order to surely release the connection.");
             }
@@ -205,8 +208,7 @@ public Representation getResponseEntity(Response response) {
      *            The expected entity size or -1 if unknown.
      * @return The response channel if it exists.
      */
-    public abstract java.nio.channels.ReadableByteChannel getResponseEntityChannel(
-            long size);
+    public abstract java.nio.channels.ReadableByteChannel getResponseEntityChannel(long size);
 
     /**
      * Returns the response entity stream if it exists.
@@ -276,8 +278,7 @@ protected boolean isServerKeepAlive() {
      */
     public Status sendRequest(Request request) {
         Status result = null;
-        Representation entity = request.isEntityAvailable() ? request
-                .getEntity() : null;
+        Representation entity = request.isEntityAvailable() ? request.getEntity() : null;
 
         // Get the connector service to callback
         org.restlet.service.ConnectorService connectorService = ConnectorHelper
@@ -317,7 +318,7 @@ public Status sendRequest(Request request) {
                     .log(Level.FINE,
                             "An error occurred during the communication with the remote HTTP server.",
                             ioe);
-            result = new Status(Status.CONNECTOR_ERROR_COMMUNICATION, ioe);
+            result = new Status(CONNECTOR_ERROR_COMMUNICATION, ioe);
         } finally {
             if (entity != null) {
                 entity.release();
@@ -343,10 +344,8 @@ public Status sendRequest(Request request) {
      * @param callback
      *            The callback invoked upon request completion.
      */
-    public void sendRequest(Request request, Response response,
-            org.restlet.Uniform callback) throws Exception {
-        Context.getCurrentLogger().warning(
-                "Currently callbacks are not available for this connector.");
+    public void sendRequest(Request request, Response response, org.restlet.Uniform callback) throws Exception {
+        Context.getCurrentLogger().warning("Currently callbacks are not available for this connector.");
     }
 
     /**
@@ -355,7 +354,8 @@ public void sendRequest(Request request, Response response,
      * @return True if the request should be chunked
      */
     protected boolean shouldRequestBeChunked(Request request) {
-        return request.isEntityAvailable() && (request.getEntity() != null)
+        return request.isEntityAvailable()
+                && (request.getEntity() != null)
                 && !request.getEntity().hasKnownSize();
     }
 }
diff --git a/modules/org.restlet/src/org/restlet/engine/adapter/ServerAdapter.java b/modules/org.restlet/src/org/restlet/engine/adapter/ServerAdapter.java
@@ -24,6 +24,11 @@
 
 package org.restlet.engine.adapter;
 
+import static org.restlet.engine.header.HeaderConstants.ATTRIBUTE_HEADERS;
+import static org.restlet.engine.header.HeaderConstants.ATTRIBUTE_HTTPS_KEY_SIZE;
+import static org.restlet.engine.header.HeaderConstants.ATTRIBUTE_HTTPS_SSL_SESSION_ID;
+import static org.restlet.engine.header.HeaderConstants.ATTRIBUTE_VERSION;
+
 import java.io.IOException;
 import java.security.cert.Certificate;
 import java.util.List;
@@ -33,7 +38,6 @@
 import org.restlet.data.Header;
 import org.restlet.data.Method;
 import org.restlet.data.Status;
-import org.restlet.engine.header.HeaderConstants;
 import org.restlet.engine.header.HeaderUtils;
 import org.restlet.representation.Representation;
 import org.restlet.util.Series;
@@ -189,7 +193,8 @@ public void commit(HttpResponse response) {
             // [ifndef gae]
             if (response.getHttpCall().isConnectionBroken(t)) {
                 // output a single log line for this common case to avoid filling servers logs
-                getLogger().log(Level.INFO, "The connection was broken. It was probably closed by the client. Reason: " + t.getMessage());
+                getLogger().log(Level.INFO,
+                        "The connection was broken. It was probably closed by the client. Reason: " + t.getMessage());
             } else
             // [enddef]
             {
@@ -226,12 +231,10 @@ public void commit(HttpResponse response) {
      */
     public HttpRequest toRequest(ServerCall httpCall) {
         HttpRequest result = new HttpRequest(getContext(), httpCall);
-        result.getAttributes().put(HeaderConstants.ATTRIBUTE_HEADERS,
-                httpCall.getRequestHeaders());
+        result.getAttributes().put(ATTRIBUTE_HEADERS, httpCall.getRequestHeaders());
 
         if (httpCall.getVersion() != null) {
-            result.getAttributes().put(HeaderConstants.ATTRIBUTE_VERSION,
-                    httpCall.getVersion());
+            result.getAttributes().put(ATTRIBUTE_VERSION, httpCall.getVersion());
         }
 
         if (httpCall.isConfidential()) {
@@ -250,16 +253,13 @@ public HttpRequest toRequest(ServerCall httpCall) {
             Integer keySize = httpCall.getSslKeySize();
 
             if (keySize != null) {
-                result.getAttributes().put(
-                        HeaderConstants.ATTRIBUTE_HTTPS_KEY_SIZE, keySize);
+                result.getAttributes().put(ATTRIBUTE_HTTPS_KEY_SIZE, keySize);
             }
 
             String sslSessionId = httpCall.getSslSessionId();
 
             if (sslSessionId != null) {
-                result.getAttributes().put(
-                        HeaderConstants.ATTRIBUTE_HTTPS_SSL_SESSION_ID,
-                        sslSessionId);
+                result.getAttributes().put(ATTRIBUTE_HTTPS_SSL_SESSION_ID, sslSessionId);
             }
         }
 
diff --git a/modules/org.restlet/src/org/restlet/engine/header/HeaderUtils.java b/modules/org.restlet/src/org/restlet/engine/header/HeaderUtils.java
