Revamp Filters, Support for HTTP Filters, AccessLog Filters

core/src/main/java/com/flipkart/gjex/core/Bundle.java

@@ -19,11 +19,11 @@
 import java.util.List;
 import java.util.Map;
 
+import com.flipkart.gjex.core.filter.grpc.GrpcFilter;
 import com.flipkart.gjex.core.job.ScheduledJob;
 import org.glassfish.jersey.server.ResourceConfig;
 
 import io.dropwizard.metrics5.health.HealthCheck;
-import com.flipkart.gjex.core.filter.Filter;
 import com.flipkart.gjex.core.service.Service;
 import com.flipkart.gjex.core.setup.Bootstrap;
 import com.flipkart.gjex.core.setup.Environment;
@@ -59,7 +59,7 @@ public interface Bundle<T extends GJEXConfiguration, U extends Map> {
      * Returns Filter instances loaded by this Bundle
      * @return List containing Filter instances
      */
-	List<Filter> getFilters();
+	List<GrpcFilter> getGrpcFilters();
 
     /**
      * Returns HealthCheck instances loaded by this Bundle

core/src/main/java/com/flipkart/gjex/core/GJEXConfiguration.java

@@ -20,11 +20,13 @@
 import com.flipkart.gjex.core.config.DashboardService;
 import com.flipkart.gjex.core.config.GrpcConfig;
 import com.flipkart.gjex.core.config.Tracing;
+import lombok.Data;
 
 import javax.validation.Valid;
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
 
+@Data
 public class GJEXConfiguration {
 
     @Valid
@@ -51,45 +53,7 @@ public class GJEXConfiguration {
     @JsonProperty("ScheduledJobs.executorThreads")
     private int scheduledJobExecutorThreads;
 
-    public GrpcConfig getGrpc() {
-        return grpc;
-    }
-
-    public void setGrpc(GrpcConfig grpc) {
-        this.grpc = grpc;
-    }
-
-    public ApiService getApiService() {
-        return apiService;
-    }
-
-    public void setApiService(ApiService apiService) {
-        this.apiService = apiService;
-    }
-
-    public DashboardService getDashboardService() {
-        return dashboardService;
-    }
 
-    public void setDashboardService(DashboardService dashboardService) {
-        this.dashboardService = dashboardService;
-    }
-
-    public Tracing getTracing() {
-        return tracing;
-    }
-
-    public void setTracing(Tracing tracing) {
-        this.tracing = tracing;
-    }
-
-    public int getScheduledJobExecutorThreads() {
-        return scheduledJobExecutorThreads;
-    }
-
-    public void setScheduledJobExecutorThreads(int scheduledJobExecutorThreads) {
-        this.scheduledJobExecutorThreads = scheduledJobExecutorThreads;
-    }
 
     @Override
     public String toString() {

core/src/main/java/com/flipkart/gjex/core/config/ApiService.java

@@ -16,9 +16,12 @@
 package com.flipkart.gjex.core.config;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.flipkart.gjex.core.filter.http.HttpFilterConfig;
+import lombok.Data;
 
 import javax.validation.constraints.Min;
 
+@Data
 public class ApiService {
 
     @Min(1)
@@ -38,43 +41,6 @@ public class ApiService {
     @JsonProperty("scheduledexecutor.threadpool.size")
     private int scheduledExecutorThreadPoolSize;
 
-    public int getPort() {
-        return port;
-    }
-
-    public void setPort(int port) {
-        this.port = port;
-    }
-
-    public int getAcceptors() {
-        return acceptors;
-    }
-
-    public void setAcceptors(int acceptors) {
-        this.acceptors = acceptors;
-    }
-
-    public int getSelectors() {
-        return selectors;
-    }
-
-    public void setSelectors(int selectors) {
-        this.selectors = selectors;
-    }
-
-    public int getWorkers() {
-        return workers;
-    }
-
-    public void setWorkers(int workers) {
-        this.workers = workers;
-    }
-
-    public int getScheduledExecutorThreadPoolSize() {
-        return scheduledExecutorThreadPoolSize;
-    }
-
-    public void setScheduledExecutorThreadPoolSize(int scheduledExecutorThreadPoolSize) {
-        this.scheduledExecutorThreadPoolSize = scheduledExecutorThreadPoolSize;
-    }
+    @JsonProperty("filterConfig")
+    private HttpFilterConfig httpFilterConfig;
 }

core/src/main/java/com/flipkart/gjex/core/config/DashboardService.java

@@ -16,7 +16,9 @@
 package com.flipkart.gjex.core.config;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
 
+@Data
 public class DashboardService {
 
     @JsonProperty("service.port")
@@ -30,36 +32,4 @@ public class DashboardService {
 
     @JsonProperty("service.workers")
     private int workers;
-
-    public int getPort() {
-        return port;
-    }
-
-    public void setPort(int port) {
-        this.port = port;
-    }
-
-    public int getAcceptors() {
-        return acceptors;
-    }
-
-    public void setAcceptors(int acceptors) {
-        this.acceptors = acceptors;
-    }
-
-    public int getSelectors() {
-        return selectors;
-    }
-
-    public void setSelectors(int selectors) {
-        this.selectors = selectors;
-    }
-
-    public int getWorkers() {
-        return workers;
-    }
-
-    public void setWorkers(int workers) {
-        this.workers = workers;
-    }
 }

core/src/main/java/com/flipkart/gjex/core/config/GrpcConfig.java

@@ -16,7 +16,10 @@
 package com.flipkart.gjex.core.config;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.flipkart.gjex.core.filter.grpc.GrpcFilterConfig;
+import lombok.Data;
 
+@Data
 public class GrpcConfig {
 
     @JsonProperty("server.port")
@@ -28,27 +31,6 @@ public class GrpcConfig {
     @JsonProperty("server.executorThreads")
     private int executorThreads = 0;
 
-    public int getPort() {
-        return port;
-    }
-
-    public void setPort(int port) {
-        this.port = port;
-    }
-
-    public int getMaxMessageSize() {
-        return maxMessageSize;
-    }
-
-    public void setMaxMessageSize(int maxMessageSize) {
-        this.maxMessageSize = maxMessageSize;
-    }
-
-    public int getExecutorThreads() {
-        return executorThreads;
-    }
-
-    public void setExecutorThreads(int executorThreads) {
-        this.executorThreads = executorThreads;
-    }
+    @JsonProperty("filterConfig")
+    private GrpcFilterConfig grpcFilterConfig;
 }

core/src/main/java/com/flipkart/gjex/core/config/Tracing.java

@@ -2,20 +2,14 @@
 
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
 
 import javax.validation.constraints.NotNull;
 
+@Data
 public class Tracing {
 
     @NotNull
     @JsonProperty("collector.endpoint")
     private String collectorEndpoint;
-
-    public String getCollectorEndpoint() {
-        return collectorEndpoint;
-    }
-
-    public void setCollectorEndpoint(String collectorEndpoint) {
-        this.collectorEndpoint = collectorEndpoint;
-    }
 }

core/src/main/java/com/flipkart/gjex/core/filter/Filter.java

@@ -15,64 +15,37 @@
  */
 package com.flipkart.gjex.core.filter;
 
-import com.google.protobuf.GeneratedMessageV3;
-import io.grpc.Metadata;
-import io.grpc.Status;
-import io.grpc.StatusRuntimeException;
+import com.flipkart.gjex.core.logging.Logging;
 
 /**
- * A Filter interface for processing Request, Request-Headers, Response and Response-Headers around gRPC method invocation
- *  
- * @author regu.b
+ * A Filter interface for processing Request, Request-Headers, Response and Response-Headers 
+ * around gRPC and HTTP method invocation
  *
- * @param <Req> Proto V3 message
- * @param <Res> Proto V3 message
+ * @author regu.b
  */
-public interface Filter<Req extends GeneratedMessageV3, Res extends GeneratedMessageV3> {
+public abstract class Filter<Req, Res, M>  {
+
+  /** Lifecycle methods for cleaning up resources used by this Filter*/
+  public void destroy(){}
 
-	/** Lifecycle methods for initializing and cleaning up resources used by this Filter*/
-	default void init() {}
-	default void destroy() {}
+  /**
+   * Call-back to decorate or inspect the Request body/message. This Filter cannot fail processing of the Request body and hence there is no support for indicating failure.
+   * This method should be viewed almost like a proxy for the Request body.
+   * @param req the Request body/message
+   * @param requestParams prams
+   */
+  public void doProcessRequest(Req req, RequestParams<M> requestParams){}
 
-	/**
-	 * Function for creating an instance of this {@link Filter}
-	 * Use only this function to get the {@link Filter} instance
-	 */
-	Filter<Req, Res> getInstance();
+  /**
+   * Call-back to decorate or inspect the Response headers. Implementations may use this method to set additional headers in the response.
+   * @param responseHeaders the Response Headers
+   */
+  public void doProcessResponseHeaders(M responseHeaders) {}
 
-	/**
-	 * Call-back to process Request headers and Filter out processing of the next incoming Request Proto V3 body/message. 
-	 * @param requestHeaders Request Headers
-	 * @throws StatusRuntimeException thrown with suitable {@link Status} to indicate reason for failing the request
-	 */
-	default void doFilterRequest(ServerRequestParams serverRequestParams, Metadata requestHeaders) throws StatusRuntimeException{}
-
-	/**
-	 * Call-back to decorate or inspect the Reauest Proto V3 body/message. This Filter cannot fail processing of the Request body and hence there is no support for indicating failure.
-	 * This method should be viewed almost like a proxy for the Request body.
-	 * @param request the Request Proto V3 body/message
-	 */
-	default void doProcessRequest(Req request) {}
-
-	/**
-	 * Call-back to decorate or inspect the Response headers. Implementations may use this method to set additional headers in the response.
-	 * @param responseHeaders the Response Headers
-	 */
-	default void doProcessResponseHeaders(Metadata responseHeaders) {}
-
-	/**
-	 * Call-back to decorate or inspect the Response Proto V3 body/message. This Filter cannot fail processing of the Response body and hence there is no support for indicating failure.
-	 * This method should be viewed almost like a proxy for the Response body.
-	 * @param response the Response Proto V3 body/message
-	 */
-	default void doProcessResponse(Res response) {}
-
-	/**
-	 * Returns array of {@link Key} identifiers for headers to be forwarded
-	 * @return array of {@link Key}
-	 */
-	@SuppressWarnings("rawtypes")
-	default Metadata.Key[] getForwardHeaderKeys(){
-		return new Metadata.Key[] {};
-	}
+  /**
+   * Call-back to decorate or inspect the Response body/message. This Filter cannot fail processing of the Response body and hence there is no support for indicating failure.
+   * This method should be viewed almost like a proxy for the Response body.
+   * @param response the Response body/message
+   */
+  public void doProcessResponse(Res response) {}
 }

core/src/main/java/com/flipkart/gjex/core/filter/RequestParams.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) The original author or authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.flipkart.gjex.core.filter;
+
+import lombok.Builder;
+import lombok.Getter;
+
+/**
+ * Represents the parameters of a request within the GJEX framework.
+ * This class encapsulates common request parameters such as client IP, resource path,
+ * and any additional metadata associated with the request.
+ *
+ * @param <M> The type of the metadata associated with the request. This allows for flexibility
+ *            in the type of metadata that can be attached to a request, making the class
+ *            adaptable to various needs.
+ *
+ * @author ajay.jalgaonkar
+ */
+@Getter
+@Builder
+public class RequestParams<M> {
+  // IP address of the client making the request.
+  String clientIp;
+
+  // Path of the resource being requested.
+  String resourcePath;
+
+  // Metadata associated with the request, of generic type M.
+  M metadata;
+}