Move util classes

imretoth-ess · imretoth-ess · commit 781053f4b2ea · 2025-12-03T15:38:21.000+01:00
- Create package for util classes and move them there
diff --git a/src/main/java/org/phoebus/channelfinder/common/CFResourceDescriptors.java b/src/main/java/org/phoebus/channelfinder/common/CFResourceDescriptors.java
@@ -1,4 +1,4 @@
-package org.phoebus.channelfinder;
+package org.phoebus.channelfinder.common;
 
 public class CFResourceDescriptors {
 
diff --git a/src/main/java/org/phoebus/channelfinder/common/NTXmlUtil.java b/src/main/java/org/phoebus/channelfinder/common/NTXmlUtil.java
@@ -1,4 +1,4 @@
-package org.phoebus.channelfinder.epics;
+package org.phoebus.channelfinder.common;
 
 import static org.phoebus.channelfinder.service.ChannelFinderEpicsService.COLUMN_CHANNEL_NAME;
 import static org.phoebus.channelfinder.service.ChannelFinderEpicsService.COLUMN_OWNER;
diff --git a/src/main/java/org/phoebus/channelfinder/common/TextUtil.java b/src/main/java/org/phoebus/channelfinder/common/TextUtil.java
@@ -1,4 +1,4 @@
-package org.phoebus.channelfinder;
+package org.phoebus.channelfinder.common;
 
 /**
  * Utility class to assist in handling of text.
diff --git a/src/main/java/org/phoebus/channelfinder/configuration/ElasticConfig.java b/src/main/java/org/phoebus/channelfinder/configuration/ElasticConfig.java
@@ -41,7 +41,7 @@
 import org.apache.http.message.BasicHeader;
 import org.elasticsearch.client.RestClient;
 import org.elasticsearch.client.RestClientBuilder;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.entity.Property;
 import org.phoebus.channelfinder.entity.Tag;
 import org.springframework.beans.factory.annotation.Value;
diff --git a/src/main/java/org/phoebus/channelfinder/respository/ChannelRepository.java b/src/main/java/org/phoebus/channelfinder/respository/ChannelRepository.java
@@ -49,8 +49,8 @@
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 import javax.annotation.PreDestroy;
-import org.phoebus.channelfinder.CFResourceDescriptors;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.CFResourceDescriptors;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.configuration.ElasticConfig;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Property;
diff --git a/src/main/java/org/phoebus/channelfinder/respository/PropertyRepository.java b/src/main/java/org/phoebus/channelfinder/respository/PropertyRepository.java
@@ -31,7 +31,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.StreamSupport;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.configuration.ElasticConfig;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Property;
diff --git a/src/main/java/org/phoebus/channelfinder/respository/TagRepository.java b/src/main/java/org/phoebus/channelfinder/respository/TagRepository.java
@@ -32,7 +32,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.StreamSupport;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.configuration.ElasticConfig;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Tag;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelManager.java b/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelManager.java
@@ -1,7 +1,7 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.CHANNEL_RESOURCE_URI;
-import static org.phoebus.channelfinder.CFResourceDescriptors.SEARCH_PARAM_DESCRIPTION;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.CHANNEL_RESOURCE_URI;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.SEARCH_PARAM_DESCRIPTION;
 
 import com.google.common.collect.FluentIterable;
 import com.google.common.collect.Lists;
@@ -21,7 +21,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 import javax.servlet.ServletContext;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Property;
 import org.phoebus.channelfinder.entity.SearchResult;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelProcessorManager.java b/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelProcessorManager.java
@@ -1,7 +1,7 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.CHANNEL_PROCESSOR_RESOURCE_URI;
-import static org.phoebus.channelfinder.CFResourceDescriptors.SEARCH_PARAM_DESCRIPTION;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.CHANNEL_PROCESSOR_RESOURCE_URI;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.SEARCH_PARAM_DESCRIPTION;
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelScroll.java b/src/main/java/org/phoebus/channelfinder/rest/controller/ChannelScroll.java
@@ -1,6 +1,6 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.SCROLL_RESOURCE_URI;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.SCROLL_RESOURCE_URI;
 
 import co.elastic.clients.elasticsearch.ElasticsearchClient;
 import co.elastic.clients.elasticsearch._types.FieldSort;
@@ -24,8 +24,8 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
-import org.phoebus.channelfinder.CFResourceDescriptors;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.CFResourceDescriptors;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.configuration.ElasticConfig;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Scroll;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/InfoManager.java b/src/main/java/org/phoebus/channelfinder/rest/controller/InfoManager.java
@@ -1,6 +1,6 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.CF_SERVICE_INFO;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.CF_SERVICE_INFO;
 
 import co.elastic.clients.elasticsearch.ElasticsearchClient;
 import co.elastic.clients.elasticsearch._types.ElasticsearchVersionInfo;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/PropertyManager.java b/src/main/java/org/phoebus/channelfinder/rest/controller/PropertyManager.java
@@ -1,6 +1,6 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.PROPERTY_RESOURCE_URI;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.PROPERTY_RESOURCE_URI;
 
 import com.google.common.collect.Lists;
 import io.swagger.v3.oas.annotations.Operation;
@@ -19,7 +19,7 @@
 import java.util.Optional;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Property;
 import org.phoebus.channelfinder.respository.ChannelRepository;
diff --git a/src/main/java/org/phoebus/channelfinder/rest/controller/TagManager.java b/src/main/java/org/phoebus/channelfinder/rest/controller/TagManager.java
@@ -1,6 +1,6 @@
 package org.phoebus.channelfinder.rest.controller;
 
-import static org.phoebus.channelfinder.CFResourceDescriptors.TAG_RESOURCE_URI;
+import static org.phoebus.channelfinder.common.CFResourceDescriptors.TAG_RESOURCE_URI;
 
 import com.google.common.collect.Lists;
 import io.swagger.v3.oas.annotations.Operation;
@@ -20,7 +20,7 @@
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
-import org.phoebus.channelfinder.TextUtil;
+import org.phoebus.channelfinder.common.TextUtil;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.entity.Tag;
 import org.phoebus.channelfinder.respository.ChannelRepository;
diff --git a/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderChannelsIT.java b/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderChannelsIT.java
@@ -26,6 +26,7 @@
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
+import org.phoebus.channelfinder.common.CFResourceDescriptors;
 import org.phoebus.channelfinder.docker.ITUtil.AuthorizationChoice;
 import org.phoebus.channelfinder.entity.Channel;
 import org.phoebus.channelfinder.rest.controller.ChannelManager;
@@ -35,7 +36,7 @@
 
 /**
  * Integration tests for ChannelFinder and Elasticsearch with focus on usage of {@link
- * org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}.
+ * CFResourceDescriptors#CHANNEL_RESOURCE_URI}.
  *
  * @author Lars Johansson
  * @see ChannelManager
@@ -162,7 +163,7 @@ void channelfinderUp() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannelRetrieveCheck() {
     // what
@@ -173,7 +174,7 @@ void handleChannelRetrieveCheck() {
     ITUtilChannels.assertRetrieveChannel("/c11", HttpURLConnection.HTTP_NOT_FOUND);
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#TAG_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#TAG_RESOURCE_URI}. */
   @Test
   void handleChannelDeleteCheck() {
     // what
@@ -197,7 +198,7 @@ void handleChannelDeleteCheck() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannelCreateUpdateCheckJson() {
     // what
@@ -293,7 +294,7 @@ void handleChannelCreateUpdateCheckJson() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannelCreateUpdateCheck() {
     // what
@@ -376,7 +377,7 @@ void handleChannelCreateUpdateCheck() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannel() {
     // what
@@ -409,7 +410,7 @@ void handleChannel() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannel2() {
     // what
@@ -446,7 +447,7 @@ void handleChannel2() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannel3RenameOwner() {
     // what
@@ -477,7 +478,7 @@ void handleChannel3RenameOwner() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannel4ReplaceNonExisting() {
     // what
@@ -504,7 +505,7 @@ void handleChannel4ReplaceNonExisting() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannelsCreateUpdateCheck() {
     // what
@@ -625,7 +626,7 @@ void handleChannelsCreateUpdateCheck() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannels() {
     // what
@@ -694,7 +695,7 @@ void handleChannels() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannels2ReplaceNonExisting() {
     // what
@@ -763,7 +764,7 @@ void handleChannels2ReplaceNonExisting() {
     }
   }
 
-  /** Test {@link org.phoebus.channelfinder.CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
+  /** Test {@link CFResourceDescriptors#CHANNEL_RESOURCE_URI}. */
   @Test
   void handleChannels3QueryByPattern() {
     // what
diff --git a/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderPropertiesIT.java b/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderPropertiesIT.java
diff --git a/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderScrollIT.java b/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderScrollIT.java
diff --git a/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderTagsIT.java b/src/test/java/org/phoebus/channelfinder/docker/ChannelFinderTagsIT.java
diff --git a/src/test/java/org/phoebus/channelfinder/epics/EpicsRPCRequestIT.java b/src/test/java/org/phoebus/channelfinder/epics/EpicsRPCRequestIT.java
diff --git a/src/test/java/org/phoebus/channelfinder/processors/ChannelProcessorManagerIT.java b/src/test/java/org/phoebus/channelfinder/processors/ChannelProcessorManagerIT.java
diff --git a/src/test/resources/INTEGRATIONTEST_DOCKER_TUTORIAL.md b/src/test/resources/INTEGRATIONTEST_DOCKER_TUTORIAL.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.phoebus.channelfinder;`
	`1`	`+package org.phoebus.channelfinder.common;`
`2`	`2`
`3`	`3`	`public class CFResourceDescriptors {`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.phoebus.channelfinder.epics;`
	`1`	`+package org.phoebus.channelfinder.common;`
`2`	`2`
`3`	`3`	`import static org.phoebus.channelfinder.service.ChannelFinderEpicsService.COLUMN_CHANNEL_NAME;`
`4`	`4`	`import static org.phoebus.channelfinder.service.ChannelFinderEpicsService.COLUMN_OWNER;`