From 27d388563cdc48a1fc19ca5ca99a0482e6834db5 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Wed, 10 Jul 2019 16:39:28 -0400 Subject: Fix checkstyle issues in policy-core Also deleted the checkstyle suppression file. Change-Id: I93e9f9154b614b56f7826ec978e1a99bd9369348 Issue-ID: POLICY-1907 Signed-off-by: Jim Hahn --- policy-core/checkstyle-suppressions.xml | 30 ------ policy-core/pom.xml | 1 - .../onap/policy/drools/core/PolicyContainer.java | 16 ++-- .../org/onap/policy/drools/core/PolicySession.java | 6 +- .../drools/core/PolicySessionFeatureAPI.java | 102 --------------------- .../drools/core/PolicySessionFeatureApi.java | 102 +++++++++++++++++++++ .../drools/core/PolicySessionFeatureApiMock.java | 4 +- .../drools/core/PolicySessionFeatureApiTest.java | 4 +- ...onap.policy.drools.core.PolicySessionFeatureAPI | 1 - ...onap.policy.drools.core.PolicySessionFeatureApi | 1 + 10 files changed, 118 insertions(+), 149 deletions(-) delete mode 100644 policy-core/checkstyle-suppressions.xml delete mode 100644 policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureAPI.java create mode 100644 policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureApi.java delete mode 100644 policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureAPI create mode 100644 policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureApi (limited to 'policy-core') diff --git a/policy-core/checkstyle-suppressions.xml b/policy-core/checkstyle-suppressions.xml deleted file mode 100644 index d771a027..00000000 --- a/policy-core/checkstyle-suppressions.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - diff --git a/policy-core/pom.xml b/policy-core/pom.xml index 1a0626c9..c6866174 100644 --- a/policy-core/pom.xml +++ b/policy-core/pom.xml @@ -149,7 +149,6 @@ true - ${project.baseUri}checkstyle-suppressions.xml true true warning diff --git a/policy-core/src/main/java/org/onap/policy/drools/core/PolicyContainer.java b/policy-core/src/main/java/org/onap/policy/drools/core/PolicyContainer.java index 2c5d87f8..3b5c360f 100644 --- a/policy-core/src/main/java/org/onap/policy/drools/core/PolicyContainer.java +++ b/policy-core/src/main/java/org/onap/policy/drools/core/PolicyContainer.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * policy-core * ================================================================================ - * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved. * Modifications Copyright (C) 2018 Samsung Electronics Co., Ltd. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); @@ -258,7 +258,7 @@ public class PolicyContainer implements Startable { // loop through all of the features, and give each one // a chance to create the 'KieSession' - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { if ((kieSession = feature.activatePolicySession(this, name, kieBaseName)) != null) { break; @@ -280,7 +280,7 @@ public class PolicyContainer implements Startable { sessions.put(name, session); // notify features - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { feature.newPolicySession(session); } catch (Exception e) { @@ -350,7 +350,7 @@ public class PolicyContainer implements Startable { sessions.put(name, policySession); // notify features - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { feature.newPolicySession(policySession); } catch (Exception e) { @@ -430,7 +430,7 @@ public class PolicyContainer implements Startable { // KLUDGE WARNING: this is a temporary workaround -- if there are // no features, we don't have persistence, and 'activate' is never // called. In this case, make sure the container is started. - if (PolicySessionFeatureAPI.impl.getList().isEmpty()) { + if (PolicySessionFeatureApi.impl.getList().isEmpty()) { start(); } @@ -562,7 +562,7 @@ public class PolicyContainer implements Startable { session.getKieSession().dispose(); // notify features - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { feature.disposeKieSession(session); } catch (Exception e) { @@ -625,7 +625,7 @@ public class PolicyContainer implements Startable { session.getKieSession().destroy(); // notify features - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { feature.destroyKieSession(session); } catch (Exception e) { @@ -685,7 +685,7 @@ public class PolicyContainer implements Startable { logger.info("PolicyContainer.main: configDir={}", configDir); // invoke 'globalInit' on all of the features - for (PolicySessionFeatureAPI feature : PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : PolicySessionFeatureApi.impl.getList()) { try { feature.globalInit(args, configDir); } catch (Exception e) { diff --git a/policy-core/src/main/java/org/onap/policy/drools/core/PolicySession.java b/policy-core/src/main/java/org/onap/policy/drools/core/PolicySession.java index 95da2865..f27bb4ab 100644 --- a/policy-core/src/main/java/org/onap/policy/drools/core/PolicySession.java +++ b/policy-core/src/main/java/org/onap/policy/drools/core/PolicySession.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * policy-core * ================================================================================ - * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved. * Modifications Copyright (C) 2018 Samsung Electronics Co., Ltd. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); @@ -142,8 +142,8 @@ public class PolicySession // loop through all of the features, and give each one // a chance to create the 'ThreadModel' - for (PolicySessionFeatureAPI feature : - PolicySessionFeatureAPI.impl.getList()) { + for (PolicySessionFeatureApi feature : + PolicySessionFeatureApi.impl.getList()) { try { if ((threadModel = feature.selectThreadModel(this)) != null) { break; diff --git a/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureAPI.java b/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureAPI.java deleted file mode 100644 index 56595901..00000000 --- a/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureAPI.java +++ /dev/null @@ -1,102 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * policy-core - * ================================================================================ - * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * 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. - * ============LICENSE_END========================================================= - */ - -package org.onap.policy.drools.core; - -import org.kie.api.runtime.KieSession; -import org.onap.policy.common.utils.services.OrderedService; -import org.onap.policy.common.utils.services.OrderedServiceImpl; - -/** - * This interface provides a way to invoke optional features at various - * points in the code. At appropriate points in the - * application, the code iterates through this list, invoking these optional - * methods. Most of the methods here are notification only -- these tend to - * return a 'void' value. In other cases, such as 'activatePolicySession', - * may - */ -public interface PolicySessionFeatureAPI extends OrderedService { - /** - * 'FeatureAPI.impl.getList()' returns an ordered list of objects - * implementing the 'FeatureAPI' interface. - */ - public static OrderedServiceImpl impl = - new OrderedServiceImpl<>(PolicySessionFeatureAPI.class); - - /** - * This method is called during initialization at a point right after - * 'PolicyContainer' initialization has completed. - * - * @param args standard 'main' arguments, which are currently ignored - * @param configDir the relative directory containing configuration files - */ - public default void globalInit(String[] args, String configDir) {} - - /** - * This method is used to create a 'KieSession' as part of a - * 'PolicyContainer'. The caller of this method will iterate over the - * implementers of this interface until one returns a non-null value. - * - * @param policyContainer the 'PolicyContainer' instance containing this - * session - * @param name the name of the KieSession (which is also the name of - * the associated PolicySession) - * @param kieBaseName the name of the 'KieBase' instance containing - * this session - * @return a new KieSession, if one was created, or 'null' if not - * (this depends on the capabilities and state of the object implementing - * this interface) - */ - public default KieSession activatePolicySession(PolicyContainer policyContainer, String name, String kieBaseName) { - return null; - } - - /** - * This method is called after a new 'PolicySession' has been initialized, - * and linked to the 'PolicyContainer'. - * - * @param policySession the new 'PolicySession' instance - */ - public default void newPolicySession(PolicySession policySession) {} - - /** - * This method is called to select the 'ThreadModel' instance associated - * with a 'PolicySession' instance. - */ - public default PolicySession.ThreadModel selectThreadModel(PolicySession session) { - return null; - } - - /** - * This method is called after 'KieSession.dispose()' is called. - * - * @param policySession the 'PolicySession' object that wrapped the - * 'KieSession' - */ - public default void disposeKieSession(PolicySession policySession) {} - - /** - * This method is called after 'KieSession.destroy()' is called. - * - * @param policySession the 'PolicySession' object that wrapped the - * 'KieSession' - */ - public default void destroyKieSession(PolicySession policySession) {} -} diff --git a/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureApi.java b/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureApi.java new file mode 100644 index 00000000..3d259954 --- /dev/null +++ b/policy-core/src/main/java/org/onap/policy/drools/core/PolicySessionFeatureApi.java @@ -0,0 +1,102 @@ +/*- + * ============LICENSE_START======================================================= + * policy-core + * ================================================================================ + * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.core; + +import org.kie.api.runtime.KieSession; +import org.onap.policy.common.utils.services.OrderedService; +import org.onap.policy.common.utils.services.OrderedServiceImpl; + +/** + * This interface provides a way to invoke optional features at various + * points in the code. At appropriate points in the + * application, the code iterates through this list, invoking these optional + * methods. Most of the methods here are notification only -- these tend to + * return a 'void' value. In other cases, such as 'activatePolicySession', + * may + */ +public interface PolicySessionFeatureApi extends OrderedService { + /** + * 'FeatureAPI.impl.getList()' returns an ordered list of objects + * implementing the 'FeatureAPI' interface. + */ + public static OrderedServiceImpl impl = + new OrderedServiceImpl<>(PolicySessionFeatureApi.class); + + /** + * This method is called during initialization at a point right after + * 'PolicyContainer' initialization has completed. + * + * @param args standard 'main' arguments, which are currently ignored + * @param configDir the relative directory containing configuration files + */ + public default void globalInit(String[] args, String configDir) {} + + /** + * This method is used to create a 'KieSession' as part of a + * 'PolicyContainer'. The caller of this method will iterate over the + * implementers of this interface until one returns a non-null value. + * + * @param policyContainer the 'PolicyContainer' instance containing this + * session + * @param name the name of the KieSession (which is also the name of + * the associated PolicySession) + * @param kieBaseName the name of the 'KieBase' instance containing + * this session + * @return a new KieSession, if one was created, or 'null' if not + * (this depends on the capabilities and state of the object implementing + * this interface) + */ + public default KieSession activatePolicySession(PolicyContainer policyContainer, String name, String kieBaseName) { + return null; + } + + /** + * This method is called after a new 'PolicySession' has been initialized, + * and linked to the 'PolicyContainer'. + * + * @param policySession the new 'PolicySession' instance + */ + public default void newPolicySession(PolicySession policySession) {} + + /** + * This method is called to select the 'ThreadModel' instance associated + * with a 'PolicySession' instance. + */ + public default PolicySession.ThreadModel selectThreadModel(PolicySession session) { + return null; + } + + /** + * This method is called after 'KieSession.dispose()' is called. + * + * @param policySession the 'PolicySession' object that wrapped the + * 'KieSession' + */ + public default void disposeKieSession(PolicySession policySession) {} + + /** + * This method is called after 'KieSession.destroy()' is called. + * + * @param policySession the 'PolicySession' object that wrapped the + * 'KieSession' + */ + public default void destroyKieSession(PolicySession policySession) {} +} diff --git a/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiMock.java b/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiMock.java index d838f6bd..fbd81391 100644 --- a/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiMock.java +++ b/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiMock.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * policy-core * ================================================================================ - * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,7 +28,7 @@ import org.kie.api.runtime.KieSession; * 'PolicySessionFeatureAPI', and providing a means to indicate * which hooks have been invoked. */ -public class PolicySessionFeatureApiMock implements PolicySessionFeatureAPI { +public class PolicySessionFeatureApiMock implements PolicySessionFeatureApi { // contains the log entries since the most recent 'getLog()' call private static ArrayList log = new ArrayList<>(); diff --git a/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiTest.java b/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiTest.java index df2c1398..1d1ca0ff 100644 --- a/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiTest.java +++ b/policy-core/src/test/java/org/onap/policy/drools/core/PolicySessionFeatureApiTest.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * ONAP * ================================================================================ - * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2018-2019 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,7 +28,7 @@ public class PolicySessionFeatureApiTest { @Test public void test() { - PolicySessionFeatureAPI api = new PolicySessionFeatureAPI() { + PolicySessionFeatureApi api = new PolicySessionFeatureApi() { @Override public int getSequenceNumber() { return 0; diff --git a/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureAPI b/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureAPI deleted file mode 100644 index 3af9beea..00000000 --- a/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureAPI +++ /dev/null @@ -1 +0,0 @@ -org.onap.policy.drools.core.PolicySessionFeatureApiMock diff --git a/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureApi b/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureApi new file mode 100644 index 00000000..3af9beea --- /dev/null +++ b/policy-core/src/test/resources/META-INF/services/org.onap.policy.drools.core.PolicySessionFeatureApi @@ -0,0 +1 @@ +org.onap.policy.drools.core.PolicySessionFeatureApiMock -- cgit 1.2.3-korg