RANGER-5017: updated sources to address 'may produce NullPointerExcep…

…tion' warning, and use <> operator while instantiating generic types (#515)
apache · Jan 22, 2025 · 8f9bedf · 8f9bedf
1 parent 0a09509
commit 8f9bedf
Show file tree

Hide file tree

Showing 35 changed files with 136 additions and 99 deletions.
diff --git a/agents-audit/src/main/java/org/apache/ranger/audit/queue/AuditFileQueueSpool.java b/agents-audit/src/main/java/org/apache/ranger/audit/queue/AuditFileQueueSpool.java
@@ -692,6 +692,10 @@ void appendToDoneFile(AuditIndexRecord indexRecord) throws IOException {
                             try {
                                 AuditIndexRecord record = MiscUtil.fromJson(line, AuditIndexRecord.class);
 
+                                if (record == null) {
+                                    continue;
+                                }
+
                                 logFile     = new File(record.getFilePath());
                                 archiveFile = new File(archiveFolder, logFile.getName());
 

diff --git a/agents-audit/src/main/java/org/apache/ranger/audit/queue/AuditFileSpool.java b/agents-audit/src/main/java/org/apache/ranger/audit/queue/AuditFileSpool.java
@@ -678,6 +678,10 @@ void appendToDoneFile(AuditIndexRecord indexRecord) throws IOException {
                             try {
                                 AuditIndexRecord record = MiscUtil.fromJson(line, AuditIndexRecord.class);
 
+                                if (record == null) {
+                                    continue;
+                                }
+
                                 logFile     = new File(record.getFilePath());
                                 archiveFile = new File(archiveFolder, logFile.getName());
 

diff --git a/agents-common/src/main/java/org/apache/ranger/plugin/geo/BinarySearchTree.java b/agents-common/src/main/java/org/apache/ranger/plugin/geo/BinarySearchTree.java
@@ -28,7 +28,7 @@ public BinarySearchTree() {
     }
 
     public void insert(final T value) {
-        Node<T> node = new Node<T>(value);
+        Node<T> node = new Node<>(value);
 
         if (root == null) {
             root = node;
@@ -104,7 +104,7 @@ void setRoot(final Node<T> newRoot) {
     }
 
     void rebalance() {
-        Node<T> dummy = new Node<T>(null);
+        Node<T> dummy = new Node<>(null);
 
         dummy.setRight(root);
 

diff --git a/agents-common/src/main/java/org/apache/ranger/plugin/geo/RangerGeolocationDatabase.java b/agents-common/src/main/java/org/apache/ranger/plugin/geo/RangerGeolocationDatabase.java
@@ -82,7 +82,7 @@ public BinarySearchTree<RangerGeolocationData, Long> getData() {
     }
 
     public void setData(final BinarySearchTree<RangerGeolocationData, Long> dataArg) {
-        data = dataArg != null ? dataArg : new BinarySearchTree<RangerGeolocationData, Long>();
+        data = dataArg != null ? dataArg : new BinarySearchTree<>();
     }
 
     public void dump(ValuePrinter<RangerGeolocationData> processor) {

diff --git a/agents-common/src/main/java/org/apache/ranger/plugin/model/RangerServiceDef.java b/agents-common/src/main/java/org/apache/ranger/plugin/model/RangerServiceDef.java
@@ -2543,22 +2543,20 @@ public int hashCode() {
         public boolean equals(Object obj) {
             if (this == obj) {
                 return true;
-            }
-            if (obj == null) {
+            } else if (obj == null) {
                 return false;
-            }
-            if (getClass() != obj.getClass()) {
+            } else if (getClass() != obj.getClass()) {
                 return false;
             }
+
             RangerPolicyConditionDef other = (RangerPolicyConditionDef) obj;
             if (itemId == null) {
                 if (other.itemId != null) {
                     return false;
                 }
-            } else if (other.itemId != null || !itemId.equals(other.itemId)) {
+            } else if (!itemId.equals(other.itemId)) {
                 return false;
             }
-
             if (description == null) {
                 if (other.description != null) {
                     return false;

diff --git a/...s-common/src/main/java/org/apache/ranger/plugin/policyengine/gds/GdsProjectEvaluator.java b/...s-common/src/main/java/org/apache/ranger/plugin/policyengine/gds/GdsProjectEvaluator.java
@@ -44,7 +44,7 @@
 import java.util.Set;
 
 public class GdsProjectEvaluator {
-    private static final Logger LOG = LoggerFactory.getLogger(GdsDatasetEvaluator.class);
+    private static final Logger LOG = LoggerFactory.getLogger(GdsProjectEvaluator.class);
 
     public static final GdsProjectEvalOrderComparator EVAL_ORDER_COMPARATOR = new GdsProjectEvalOrderComparator();
 

diff --git a/hive-agent/src/main/java/org/apache/ranger/services/hive/RangerServiceHive.java b/hive-agent/src/main/java/org/apache/ranger/services/hive/RangerServiceHive.java
@@ -210,7 +210,7 @@ private Map<String, RangerPolicyResource> createDefaultDBPolicyResource() {
     }
 
     private List<RangerPolicyItem> createDefaultDBPolicyItem() {
-        List<RangerPolicyItemAccess> accesses = new ArrayList<RangerPolicyItemAccess>();
+        List<RangerPolicyItemAccess> accesses = new ArrayList<>();
 
         accesses.add(new RangerPolicyItemAccess(ACCESS_TYPE_CREATE));
 
@@ -241,7 +241,7 @@ private Map<String, RangerPolicyResource> createInformationSchemaPolicyResource(
     }
 
     private List<RangerPolicyItem> createInformationSchemaPolicyItem() {
-        List<RangerPolicyItemAccess> accesses = new ArrayList<RangerPolicyItemAccess>();
+        List<RangerPolicyItemAccess> accesses = new ArrayList<>();
 
         accesses.add(new RangerPolicyItemAccess(ACCESS_TYPE_SELECT));
         RangerPolicyItem item = new RangerPolicyItem(accesses, null, Collections.singletonList(RangerPolicyEngine.GROUP_PUBLIC), null, null, false);

diff --git a/intg/src/main/java/org/apache/ranger/RangerClient.java b/intg/src/main/java/org/apache/ranger/RangerClient.java
@@ -483,7 +483,7 @@ private void authInit(String authType, String username, String password) {
             isSecureMode = true;
             MiscUtil.loginWithKeyTab(password, username, null);
             UserGroupInformation ugi = MiscUtil.getUGILoginUser();
-            LOG.info("RangerClient.authInit() UGI user: " + ugi.getUserName() + " principal: " + username);
+            LOG.info("RangerClient.authInit() UGI user: {} principal: {}", ugi.getUserName(), username);
         } else {
             restClient.setBasicAuthInfo(username, password);
         }
@@ -510,7 +510,7 @@ private ClientResponse invokeREST(API api, Map<String, String> params, Object re
                     break;
 
                 default:
-                    LOG.error(api.getMethod() + ": unsupported HTTP method");
+                    LOG.error("{}: unsupported HTTP method", api.getMethod());
 
                     clientResponse = null;
             }

diff --git a/kms/src/main/java/org/apache/hadoop/crypto/key/RangerKMSDB.java b/kms/src/main/java/org/apache/hadoop/crypto/key/RangerKMSDB.java
@@ -205,7 +205,7 @@ private void updateDBSSLURL() {
 
                 jpaProperties.put(JPA_DB_URL, conf.get(PROPERTY_PREFIX + DB_URL));
 
-                logger.info(PROPERTY_PREFIX + DB_URL + "=" + conf.get(PROPERTY_PREFIX + DB_URL));
+                logger.info("{}{}={}", PROPERTY_PREFIX, DB_URL, conf.get(PROPERTY_PREFIX + DB_URL));
 
                 if ("true".equalsIgnoreCase(dbSslVerifyServerCertificate) || "true".equalsIgnoreCase(dbSslRequired)) {
                     if (!"1-way".equalsIgnoreCase((dbSslAuthType))) {

diff --git a/kms/src/main/java/org/apache/hadoop/crypto/key/RangerKeyStore.java b/kms/src/main/java/org/apache/hadoop/crypto/key/RangerKeyStore.java
@@ -346,7 +346,7 @@ public void engineLoad(InputStream stream, char[] password) throws IOException,
                     int counter = 0;
 
                     for (int i = computed.length - 1; i >= 0; i--) {
-                        if (computed[i] != data[data.length - (1 + counter)]) {
+                        if (data == null || computed[i] != data[data.length - (1 + counter)]) {
                             Throwable t = new UnrecoverableKeyException("Password verification failed");
 
                             logger.error("Keystore was tampered with, or password was incorrect.", t);

diff --git a/kms/src/main/java/org/apache/hadoop/crypto/key/kms/server/KMSMetricUtil.java b/kms/src/main/java/org/apache/hadoop/crypto/key/kms/server/KMSMetricUtil.java
@@ -142,7 +142,7 @@ private void getKMSMetricCalculation(String caseValue) {
                             String                     jsonEncKeyByAlgo                = null;
 
                             if (keyProvider != null && keyProvider.getKeys() != null && keyProvider.getKeys().size() > 0) {
-                                List<String> keyList = new ArrayList<String>();
+                                List<String> keyList = new ArrayList<>();
 
                                 keyList.addAll(keyProvider.getKeys());
 

diff --git a/ranger-metrics/src/main/java/org/apache/ranger/metrics/RangerMetricsSystemWrapper.java b/ranger-metrics/src/main/java/org/apache/ranger/metrics/RangerMetricsSystemWrapper.java
@@ -55,12 +55,12 @@ public class RangerMetricsSystemWrapper {
     public void init(String serviceName, List<RangerMetricsSourceWrapper> sourceWrappers, List<RangerMetricsSinkWrapper> sinkWrappers) {
         // Initialize metrics system
         MetricsSystem metricsSystem  = DefaultMetricsSystem.initialize(serviceName);
-        Set<String>   sourceContexts = new HashSet<String>();
+        Set<String>   sourceContexts = new HashSet<>();
         sourceContexts.add(serviceName);
 
         // Ranger Source
         if (Objects.isNull(sourceWrappers) || sourceWrappers.isEmpty()) {
-            sourceWrappers = new ArrayList<RangerMetricsSourceWrapper>();
+            sourceWrappers = new ArrayList<>();
         }
         sourceWrappers.add(new RangerMetricsSourceWrapper("RangerJVM", "Ranger common metric source (RangerMetricsJvmSource)", serviceName, new RangerMetricsJvmSource(serviceName)));
         sourceWrappers.add(new RangerMetricsSourceWrapper("RangerContainer", "Ranger web container metric source (RangerMetricsContainerSource)", serviceName, new RangerMetricsContainerSource(serviceName)));
@@ -72,7 +72,7 @@ public void init(String serviceName, List<RangerMetricsSourceWrapper> sourceWrap
 
         // Ranger Sink
         if (Objects.isNull(sinkWrappers) || sinkWrappers.isEmpty()) {
-            sinkWrappers = new ArrayList<RangerMetricsSinkWrapper>();
+            sinkWrappers = new ArrayList<>();
         }
 
         // Prometheus

diff --git a/security-admin/src/main/java/org/apache/ranger/amazon/cloudwatch/CloudWatchUtil.java b/security-admin/src/main/java/org/apache/ranger/amazon/cloudwatch/CloudWatchUtil.java
@@ -218,10 +218,16 @@ public FilterLogEventsRequest getFilterLogEventsRequest(AWSLogs client, SearchCr
         // Add FilterPattern which will only fetch logs required
         FilterLogEventsRequest filterLogEventsRequest = new FilterLogEventsRequest()
                 .withLogGroupName(logGroupName)
-                .withStartTime(fromDate.getTime())
-                .withEndTime(toDate.getTime())
                 .withFilterPattern(filterPattern.toString());
 
+        if (fromDate != null) {
+            filterLogEventsRequest.withStartTime(fromDate.getTime());
+        }
+
+        if (toDate != null) {
+            filterLogEventsRequest.withEndTime(toDate.getTime());
+        }
+
         if (StringUtils.isNotBlank(logStreamPrefix)) {
             filterLogEventsRequest.setLogStreamNamePrefix(logStreamPrefix);
         }

diff --git a/...in/src/main/java/org/apache/ranger/authentication/unix/jaas/RoleUserAuthorityGranter.java b/...in/src/main/java/org/apache/ranger/authentication/unix/jaas/RoleUserAuthorityGranter.java
@@ -29,10 +29,9 @@ public class RoleUserAuthorityGranter implements AuthorityGranter {
     @Override
     public Set<String> grant(Principal principal) {
         if (principal instanceof UnixGroupPrincipal) {
-            Collections.singleton(principal.getName());
+            return Collections.singleton(principal.getName());
         } else {
-            Collections.singleton("ROLE_USER");
+            return Collections.singleton("ROLE_USER");
         }
-        return null;
     }
 }
diff --git a/security-admin/src/main/java/org/apache/ranger/biz/ServiceMgr.java b/security-admin/src/main/java/org/apache/ranger/biz/ServiceMgr.java
@@ -134,11 +134,15 @@ public List<String> lookupResource(String serviceName, ResourceLookupContext con
             }
         }
 
-        Map<String, String> newConfigs = rangerSvcService.getConfigsWithDecryptedPassword(service);
+        RangerBaseService svc = null;
 
-        service.setConfigs(newConfigs);
+        if (service != null) {
+            Map<String, String> newConfigs = rangerSvcService.getConfigsWithDecryptedPassword(service);
 
-        RangerBaseService svc = getRangerServiceByService(service, svcStore);
+            service.setConfigs(newConfigs);
+
+            svc = getRangerServiceByService(service, svcStore);
+        }
 
         LOG.debug("==> ServiceMgr.lookupResource for Service: ({}Context: {})", svc, context);
 
@@ -663,7 +667,7 @@ public T call() throws Exception {
             } finally {
                 Thread.currentThread().setContextClassLoader(clsLoader);
 
-                if (LOG.isDebugEnabled()) {
+                if (start != null) {
                     Date finish        = new Date();
                     long waitTime      = start.getTime() - creation.getTime();
                     long executionTime = finish.getTime() - start.getTime();

diff --git a/security-admin/src/main/java/org/apache/ranger/common/RESTErrorUtil.java b/security-admin/src/main/java/org/apache/ranger/common/RESTErrorUtil.java
@@ -379,7 +379,7 @@ public Boolean parseBoolean(String value, String errorMessage, MessageEnums mess
     }
 
     public WebApplicationException createRESTException(String errorMessage, MessageEnums messageEnum, Long objectId, String fieldName, String logMessage, int statusCode) {
-        List<VXMessage> messageList = new ArrayList<VXMessage>();
+        List<VXMessage> messageList = new ArrayList<>();
 
         messageList.add(messageEnum.getMessage(objectId, fieldName));
 
@@ -407,7 +407,7 @@ public WebApplicationException createRESTException(String errorMessage, MessageE
     }
 
     public WebApplicationException create404RESTException(String errorMessage, MessageEnums messageEnum, Long objectId, String fieldName, String logMessage) {
-        List<VXMessage> messageList = new ArrayList<VXMessage>();
+        List<VXMessage> messageList = new ArrayList<>();
 
         messageList.add(messageEnum.getMessage(objectId, fieldName));
 

diff --git a/security-admin/src/main/java/org/apache/ranger/common/RangerProperties.java b/security-admin/src/main/java/org/apache/ranger/common/RangerProperties.java
@@ -28,7 +28,7 @@ public class RangerProperties extends HashMap<Object, Object> {
 
     private static final String XMLCONFIG_FILENAME_DELIMITOR = ",";
 
-    private String xmlConfigFileNames;
+    private final String xmlConfigFileNames;
 
     public RangerProperties(String xmlConfigFileNames) {
         this.xmlConfigFileNames = xmlConfigFileNames;

diff --git a/security-admin/src/main/java/org/apache/ranger/common/RangerSearchUtil.java b/security-admin/src/main/java/org/apache/ranger/common/RangerSearchUtil.java
@@ -468,8 +468,10 @@ protected void resolveQueryParams(Query query, SearchFilter searchCriteria, List
             } else if (searchField.getDataType() == SearchField.DATA_TYPE.STR_LIST || (isMultiValue && searchField.getDataType() == SearchField.DATA_TYPE.STRING)) {
                 List<String> strValueList = new ArrayList<>();
 
-                for (Object value : multiValue) {
-                    strValueList.add(String.valueOf(value));
+                if (multiValue != null) {
+                    for (Object value : multiValue) {
+                        strValueList.add(String.valueOf(value));
+                    }
                 }
 
                 if (!strValueList.isEmpty()) {
@@ -593,8 +595,10 @@ private StringBuilder buildWhereClause(SearchFilter searchCriteria, List<SearchF
             } else if (searchField.getDataType() == SearchField.DATA_TYPE.STR_LIST || (isMultiValue && searchField.getDataType() == SearchField.DATA_TYPE.STRING)) {
                 List<String> strValueList = new ArrayList<>();
 
-                for (Object value : multiValue) {
-                    strValueList.add(String.valueOf(value));
+                if (multiValue != null) {
+                    for (Object value : multiValue) {
+                        strValueList.add(String.valueOf(value));
+                    }
                 }
 
                 if (!strValueList.isEmpty()) {

diff --git a/security-admin/src/main/java/org/apache/ranger/common/RangerServicePoliciesCache.java b/security-admin/src/main/java/org/apache/ranger/common/RangerServicePoliciesCache.java
@@ -281,7 +281,7 @@ public void saveToCache(ServicePolicies policies) {
             LOG.error("ServicePolicies is null object!!");
         }
 
-        LOG.debug("<== RangerServicePoliciesCache(serviceName={}).saveToCache()", policies.getServiceName());
+        LOG.debug("<== RangerServicePoliciesCache(serviceName={}).saveToCache()", policies != null ? policies.getServiceName() : "<null>");
     }
 
     private class ServicePoliciesWrapper {

diff --git a/security-admin/src/main/java/org/apache/ranger/common/SearchUtil.java b/security-admin/src/main/java/org/apache/ranger/common/SearchUtil.java
@@ -33,6 +33,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
@@ -464,9 +465,11 @@ protected StringBuilder buildWhereClause(SearchCriteria searchCriteria, List<Sea
             } else if (searchCriteria.getNotNullParamList().contains(searchField.getClientFieldName())) {
                 whereClause.append(" and ").append(searchField.getFieldName()).append(" is not null");
             } else if (searchField.getDataType() == SearchField.DATA_TYPE.INT_LIST || isListValue && searchField.getDataType() == SearchField.DATA_TYPE.INTEGER) {
-                Collection<Number> intValueList;
+                final Collection<Number> intValueList;
 
-                if ((paramValue instanceof Integer || paramValue instanceof Long)) {
+                if (paramValue == null) {
+                    intValueList = Collections.emptyList();
+                } else if (paramValue instanceof Integer || paramValue instanceof Long) {
                     intValueList = new ArrayList<>();
 
                     intValueList.add((Number) paramValue);
@@ -613,9 +616,11 @@ protected void resolveQueryParams(Query query, SearchCriteria searchCriteria, Li
             if (searchCriteria.getNullParamList().contains(searchField.getClientFieldName()) || searchCriteria.getNotNullParamList().contains(searchField.getClientFieldName())) { //NOPMD
                 // Already addressed while building where clause
             } else if (searchField.getDataType() == SearchField.DATA_TYPE.INT_LIST || isListValue && searchField.getDataType() == SearchField.DATA_TYPE.INTEGER) {
-                Collection<Number> intValueList;
+                final Collection<Number> intValueList;
 
-                if ((paramValue instanceof Integer || paramValue instanceof Long)) {
+                if (paramValue == null) {
+                    intValueList = Collections.emptyList();
+                } else if (paramValue instanceof Integer || paramValue instanceof Long) {
                     intValueList = new ArrayList<>();
 
                     intValueList.add((Number) paramValue);

diff --git a/security-admin/src/main/java/org/apache/ranger/common/db/BaseDao.java b/security-admin/src/main/java/org/apache/ranger/common/db/BaseDao.java
@@ -388,6 +388,6 @@ private void init(EntityManager em) {
             BATCH_DELETE_BATCH_SIZE = DEFAULT_BATCH_DELETE_BATCH_SIZE;
         }
 
-        logger.info(PROP_BATCH_DELETE_BATCH_SIZE + "=" + BATCH_DELETE_BATCH_SIZE);
+        logger.info("{}={}", PROP_BATCH_DELETE_BATCH_SIZE, BATCH_DELETE_BATCH_SIZE);
     }
 }
diff --git a/security-admin/src/main/java/org/apache/ranger/db/XXAuthSessionDao.java b/security-admin/src/main/java/org/apache/ranger/db/XXAuthSessionDao.java
@@ -69,7 +69,8 @@ public List<XXAuthSession> getAuthSessionByUserId(Long userId) {
     }
 
     public long getRecentAuthFailureCountByLoginId(String loginId, int timeRangezSecond) {
-        Date authWindowStartTime = new Date(DateUtil.getUTCDate().getTime() - timeRangezSecond * 1000L);
+        Date utcDate             = DateUtil.getUTCDate();
+        Date authWindowStartTime = new Date((utcDate != null ? utcDate.getTime() : System.currentTimeMillis()) - timeRangezSecond * 1000L);
 
         return getEntityManager()
                 .createNamedQuery("XXAuthSession.getRecentAuthFailureCountByLoginId", Long.class)

diff --git a/...admin/src/main/java/org/apache/ranger/elasticsearch/ElasticSearchAccessAuditsService.java b/...admin/src/main/java/org/apache/ranger/elasticsearch/ElasticSearchAccessAuditsService.java
@@ -125,7 +125,11 @@ public VXAccessAuditList searchXAccessAudits(SearchCriteria searchCriteria) {
 
         returnList.setPageSize(searchCriteria.getMaxRows());
         returnList.setResultSize(response.getHits().getHits().length);
-        returnList.setTotalCount(response.getHits().getTotalHits().value);
+
+        if (response.getHits().getTotalHits() != null) {
+            returnList.setTotalCount(response.getHits().getTotalHits().value);
+        }
+
         returnList.setStartIndex(searchCriteria.getStartIndex());
         returnList.setVXAccessAudits(xAccessAuditList);