Merge pull request #35 from SAP/tenantid

Refactor Http Header Handling

Author: altenhof

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/HttpHeaders.java

@@ -33,10 +33,7 @@ public class LogContext {
         }
     };
 
-    public static final String HTTP_HEADER_CORRELATION_ID = HttpHeaders.CORRELATION_ID;
-    public static final String HTTP_HEADER_TENANT_ID = HttpHeaders.TENANT_ID;
-
-    public static void loadContextFields(boolean override) {
+	public static void loadContextFields(boolean override) {
         /*
          * -- do bootstrap, either enforced or because map is empty
          */

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/LogContext.java

@@ -0,0 +1,16 @@
+package com.sap.hcp.cf.logging.common.request;
+
+import java.util.List;
+
+public interface HttpHeader {
+
+	boolean isPropagated();
+
+	String getName();
+
+	String getField();
+
+	List<HttpHeader> getAliases();
+
+	String getFieldValue();
+}

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/LogContextAdapter.java

@@ -0,0 +1,78 @@
+package com.sap.hcp.cf.logging.common.request;
+
+import static java.util.Arrays.asList;
+import static java.util.Collections.unmodifiableList;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import com.sap.hcp.cf.logging.common.Defaults;
+import com.sap.hcp.cf.logging.common.Fields;
+import com.sap.hcp.cf.logging.common.LogContext;
+
+public enum HttpHeaders implements HttpHeader {
+
+	CONTENT_LENGTH("content-length"), CONTENT_TYPE("content-type"), REFERER("referer"), X_FORWARDED_FOR(
+			"x-forwarded-for"), X_VCAP_REQUEST_ID("x-vcap-request-id"), CORRELATION_ID("X-CorrelationID",
+					Fields.CORRELATION_ID, true, X_VCAP_REQUEST_ID), TENANT_ID("tenantid", Fields.TENANT_ID, true);
+
+	private HttpHeaders(String name) {
+		this(name, null, false);
+	}
+
+	private HttpHeaders(String name, String field, boolean isPropagated, HttpHeaders... aliases) {
+		this.name = name;
+		this.field = field;
+		this.isPropagated = isPropagated;
+		this.aliases = unmodifiableList(asList(aliases));
+	}
+
+	private String name;
+	private String field;
+	private boolean isPropagated;
+	private List<HttpHeader> aliases;
+
+	@Override
+	public boolean isPropagated() {
+		return isPropagated;
+	}
+
+	@Override
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	public String getField() {
+		return field;
+	}
+
+	@Override
+	public String getFieldValue() {
+		return field != null ? LogContext.get(field) : Defaults.UNKNOWN;
+	}
+
+	@Override
+	public List<HttpHeader> getAliases() {
+		return aliases;
+	}
+
+	public static List<HttpHeaders> propagated() {
+		return LazyPropagatedHeaderHolder.PROPAGATED;
+	}
+
+	private static class LazyPropagatedHeaderHolder {
+		public static final List<HttpHeaders> PROPAGATED = createPropagated();
+
+		private static List<HttpHeaders> createPropagated() {
+			List<HttpHeaders> propagated = new ArrayList<>();
+			for (HttpHeaders current : values()) {
+				if (current.isPropagated()) {
+					propagated.add(current);
+				}
+			}
+			return Collections.unmodifiableList(propagated);
+		}
+	}
+}

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/HttpHeader.java

@@ -1,4 +1,4 @@
-package com.sap.hcp.cf.logging.common;
+package com.sap.hcp.cf.logging.common.request;
 
 import java.util.HashMap;
 import java.util.HashSet;
@@ -11,6 +11,14 @@
 import com.fasterxml.jackson.jr.ob.JSON;
 import com.fasterxml.jackson.jr.ob.JSONComposer;
 import com.fasterxml.jackson.jr.ob.comp.ObjectComposer;
+import com.sap.hcp.cf.logging.common.DateTimeValue;
+import com.sap.hcp.cf.logging.common.Defaults;
+import com.sap.hcp.cf.logging.common.DoubleValue;
+import com.sap.hcp.cf.logging.common.Fields;
+import com.sap.hcp.cf.logging.common.LogContext;
+import com.sap.hcp.cf.logging.common.LongValue;
+import com.sap.hcp.cf.logging.common.StringValue;
+import com.sap.hcp.cf.logging.common.Value;
 
 /**
  * A <i>request record</i> keeping track of all fields defined for a request

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/HttpHeaders.java

@@ -1,6 +1,8 @@
-package com.sap.hcp.cf.logging.common;
+package com.sap.hcp.cf.logging.common.request;
 
-import com.sap.hcp.cf.logging.common.RequestRecord.Direction;
+import com.sap.hcp.cf.logging.common.Defaults;
+import com.sap.hcp.cf.logging.common.Value;
+import com.sap.hcp.cf.logging.common.request.RequestRecord.Direction;
 
 public class RequestRecordBuilder {
 

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/RequestRecord.java renamed to cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/RequestRecord.java

@@ -5,7 +5,7 @@
 
 import org.junit.Test;
 
-import com.sap.hcp.cf.logging.common.RequestRecord;
+import com.sap.hcp.cf.logging.common.request.RequestRecord;
 
 public class TestJsonMessageConverter extends AbstractConverterTest {
 

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/RequestRecordBuilder.java renamed to cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/request/RequestRecordBuilder.java

@@ -0,0 +1,69 @@
+package com.sap.hcp.cf.logging.common.request;
+
+import static org.hamcrest.Matchers.containsInAnyOrder;
+import static org.hamcrest.Matchers.empty;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.nullValue;
+import static org.junit.Assert.assertThat;
+
+import org.junit.Test;
+
+import com.sap.hcp.cf.logging.common.Defaults;
+import com.sap.hcp.cf.logging.common.Fields;
+
+public class HttpHeadersTest {
+
+	@Test
+	public void hasCorrectNumberOfTypes() throws Exception {
+		assertThat(HttpHeaders.values().length, is(equalTo(7)));
+	}
+
+	@Test
+	public void hasCorrectNames() throws Exception {
+		assertThat(HttpHeaders.CONTENT_LENGTH.getName(), is("content-length"));
+		assertThat(HttpHeaders.CONTENT_TYPE.getName(), is("content-type"));
+		assertThat(HttpHeaders.CORRELATION_ID.getName(), is("X-CorrelationID"));
+		assertThat(HttpHeaders.REFERER.getName(), is("referer"));
+		assertThat(HttpHeaders.TENANT_ID.getName(), is("tenantid"));
+		assertThat(HttpHeaders.X_FORWARDED_FOR.getName(), is("x-forwarded-for"));
+		assertThat(HttpHeaders.X_VCAP_REQUEST_ID.getName(), is("x-vcap-request-id"));
+	}
+
+	@Test
+	public void hasCorrectFields() throws Exception {
+		assertThat(HttpHeaders.CONTENT_LENGTH.getField(), is(nullValue()));
+		assertThat(HttpHeaders.CONTENT_TYPE.getField(), is(nullValue()));
+		assertThat(HttpHeaders.CORRELATION_ID.getField(), is(Fields.CORRELATION_ID));
+		assertThat(HttpHeaders.REFERER.getField(), is(nullValue()));
+		assertThat(HttpHeaders.TENANT_ID.getField(), is(Fields.TENANT_ID));
+		assertThat(HttpHeaders.X_FORWARDED_FOR.getField(), is(nullValue()));
+		assertThat(HttpHeaders.X_VCAP_REQUEST_ID.getField(), is(nullValue()));
+	}
+
+	@Test
+	public void defaultFieldValueIsUnknownWithoutConfiguredField() throws Exception {
+		assertThat(HttpHeaders.CONTENT_LENGTH.getFieldValue(), is(Defaults.UNKNOWN));
+		assertThat(HttpHeaders.CONTENT_TYPE.getFieldValue(), is(Defaults.UNKNOWN));
+		assertThat(HttpHeaders.REFERER.getFieldValue(), is(Defaults.UNKNOWN));
+		assertThat(HttpHeaders.X_FORWARDED_FOR.getFieldValue(), is(Defaults.UNKNOWN));
+		assertThat(HttpHeaders.X_VCAP_REQUEST_ID.getFieldValue(), is(Defaults.UNKNOWN));
+	}
+
+	@Test
+	public void hasCorrectAliases() throws Exception {
+		assertThat(HttpHeaders.CONTENT_LENGTH.getAliases(), is(empty()));
+		assertThat(HttpHeaders.CONTENT_TYPE.getAliases(), is(empty()));
+		assertThat(HttpHeaders.CORRELATION_ID.getAliases(), containsInAnyOrder(HttpHeaders.X_VCAP_REQUEST_ID));
+		assertThat(HttpHeaders.REFERER.getAliases(), is(empty()));
+		assertThat(HttpHeaders.TENANT_ID.getAliases(), is(empty()));
+		assertThat(HttpHeaders.X_FORWARDED_FOR.getAliases(), is(empty()));
+		assertThat(HttpHeaders.X_VCAP_REQUEST_ID.getAliases(), is(empty()));
+	}
+
+	@Test
+	public void propagatesCorrectHeaders() throws Exception {
+		assertThat(HttpHeaders.propagated(), containsInAnyOrder(HttpHeaders.CORRELATION_ID, HttpHeaders.TENANT_ID));
+	}
+
+}