Implemented changes for shallow behavior in EIB (#495)

* Implemented changes for shallow behavior in EIB

* Updated documentation related to shallow flag

* Set the shallow flag value to true

* Updated application.properties for integration test

* Formatted application.properties files

* Changed the type shallow value

* updated shallowParameter

* Made shallow parameter as optional

Co-authored-by: Rishav Kumar B <rishav.b.kumar@ericsson.com>

Author: iamrishavkumar

src/integrationtests/resources/application.properties

@@ -59,6 +59,7 @@ spring.mail.properties.mail.smtp.auth: false
 spring.mail.properties.mail.smtp.starttls.enable: false
 
 event.repository.url: http://localhost:8084/search/
+event.repository.shallow: true
 
 ldap.enabled: false
 ldap.server.list: [{\

src/main/java/com/ericsson/ei/erqueryservice/ERQueryService.java

@@ -53,6 +53,10 @@ public class ERQueryService {
     @Value("${event.repository.url}")
     private String eventRepositoryUrl;
 
+    @Getter
+    @Value("${event.repository.shallow:true}")
+    private Boolean shallow;
+
     public ERQueryService() {
         this.request = new HttpRequest();
     }
@@ -100,6 +104,13 @@ private ResponseEntity sendRequestToER(String eventId, SearchOption searchOption
 
     private void prepareRequest(String eventId, SearchOption searchOption, int limit,
             int levels, boolean tree) throws IOException, URISyntaxException {
+        Boolean shallowParameter;
+        if (shallow == null ) {
+            shallowParameter = true;
+        }
+        else {
+            shallowParameter = shallow;
+        }
         final SearchParameters searchParameters = getSearchParameters(searchOption);
         request
                .setHttpMethod(HttpMethod.POST)
@@ -108,6 +119,7 @@ private void prepareRequest(String eventId, SearchOption searchOption, int limit
                .addParam("limit", Integer.toString(limit))
                .addParam("levels", Integer.toString(levels))
                .addParam("tree", Boolean.toString(tree))
+               .addParam("shallow", Boolean.toString(shallowParameter))
                .setBody(searchParameters.getAsJsonString(), ContentType.APPLICATION_JSON);
 
         String uri = request.getURI().toString();

src/main/resources/application.properties

@@ -58,6 +58,7 @@ spring.mail.properties.mail.smtp.auth: false
 spring.mail.properties.mail.smtp.starttls.enable: false
 
 event.repository.url:
+event.repository.shallow: true
 
 ldap.enabled: false
 ldap.server.list: [{\

src/test/java/com/ericsson/ei/erqueryservice/test/ERQueryServiceTest.java

@@ -71,6 +71,7 @@ public class ERQueryServiceTest extends Mockito {
     private int limitParam = 85;
     private int levels = 2;
     private boolean isTree = true;
+    private boolean shallow = true;
 
     @Before
     public void setUp() throws Exception {
@@ -101,8 +102,8 @@ private Answer<ResponseEntity> validateRequest(HttpRequestBase httpRequestBase )
     }
 
     public String buildUri() {
-        String uri = String.format("%s%s?limit=%s&tree=%s&levels=%s",
-                erQueryService.getEventRepositoryUrl().trim(), eventId, limitParam, isTree, levels);
+        String uri = String.format("%s%s?limit=%s&tree=%s&shallow=%s&levels=%s",
+                erQueryService.getEventRepositoryUrl().trim(), eventId, limitParam, isTree, shallow, levels) ;
         return uri;
     }
 }

wiki/configuration.md

@@ -159,6 +159,14 @@ used. **event.repository.url** takes a full URL to such a repository.
 
 * event.repository.url
 
+A shallow property has been added , which is set to true. With property **event.repository.shallow** set to true,
+the ER query from Eiffel Intelligence will search the event id only in main ER. It will not look in external ER(s)
+for event ids. If this parameter set to false , search for event id will extended to External ER(s) as well.
+
+The event id is of aggregated object. Using this event id , ER query will retrieve upstream/downstream events.
+
+* event.repository.shallow
+
 ## MongoDB
 
 You can set up connections to a single MongoDB instance or a Replica set of multiple MongoDB instances with or