aboutsummaryrefslogtreecommitdiffstats
path: root/policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java
diff options
context:
space:
mode:
Diffstat (limited to 'policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java')
-rw-r--r--policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java153
1 files changed, 153 insertions, 0 deletions
diff --git a/policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java b/policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java
new file mode 100644
index 00000000..a14c6547
--- /dev/null
+++ b/policy-core/src/main/java/org/openecomp/policy/drools/core/FeatureAPI.java
@@ -0,0 +1,153 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * policy-core
+ * ================================================================================
+ * Copyright (C) 2017 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.openecomp.policy.drools.core;
+
+import java.util.Properties;
+
+import org.kie.api.runtime.KieSession;
+
+import org.openecomp.policy.drools.utils.OrderedService;
+import org.openecomp.policy.drools.utils.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 FeatureAPI extends OrderedService
+{
+ /**
+ * 'FeatureAPI.impl.getList()' returns an ordered list of objects
+ * implementing the 'FeatureAPI' interface.
+ */
+ static public OrderedServiceImpl<FeatureAPI> impl =
+ new OrderedServiceImpl<FeatureAPI>(FeatureAPI.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 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 KieSession activatePolicySession
+ (PolicyContainer policyContainer, String name, String kieBaseName);
+
+ /**
+ * This method is called after 'KieSession.dispose()' is called
+ *
+ * @param policySession the 'PolicySession' object that wrapped the
+ * 'KieSession'
+ */
+ public void disposeKieSession(PolicySession policySession);
+
+ /**
+ * This method is called after 'KieSession.destroy()' is called
+ *
+ * @param policySession the 'PolicySession' object that wrapped the
+ * 'KieSession'
+ */
+ public void destroyKieSession(PolicySession policySession);
+
+ /**
+ * called before the Policy Engine is started
+ */
+ public void beforeStartEngine() throws IllegalStateException;
+
+ /**
+ * called immediately after the Policy Engine is started
+ */
+ public void afterStartEngine();
+
+ /**
+ * called before the Policy Engine is shut down
+ */
+ public void beforeShutdownEngine();
+
+ /**
+ * called after the Policy Engine is shut down
+ */
+ public void afterShutdownEngine();
+
+ /**
+ * called before creating a controller with name 'name'
+ *
+ * @param name name of the the controller
+ * @param properties configuration properties
+ */
+ public void beforeCreateController(String name, Properties properties);
+
+ /**
+ * NOTE: temporary, should pass the Policy Controller already created
+ *
+ * called after creating a controller with name 'name'
+ *
+ * @param name name of the the controller
+ * @param properties configuration properties
+ */
+ public void afterCreateController(String name);
+
+ /**
+ * NOTE: temporary, should pass the Policy Controller
+ *
+ * called before starting a controller with name 'name'
+ *
+ * @param name name of the the controller
+ */
+ public void beforeStartController(String name);
+
+ /**
+ * NOTE: temporary, should pass the Policy Controller
+ *
+ * called after starting a controller with name 'name'
+ *
+ * @param name name of the the controller
+ */
+ public void afterStartController(String name);
+
+ /**
+ * NOTE: this method is probably temporary
+ *
+ * @return 'true' if persistence is enabled, and 'false' if not, or if
+ * this feature is not related to persistence.
+ */
+ public boolean isPersistenceEnabled();
+}