summaryrefslogtreecommitdiffstats
path: root/policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java
diff options
context:
space:
mode:
Diffstat (limited to 'policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java')
-rw-r--r--policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java416
1 files changed, 226 insertions, 190 deletions
diff --git a/policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java b/policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java
index 94d1b15e..286948ed 100644
--- a/policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java
+++ b/policy-management/src/main/java/org/onap/policy/drools/features/PolicyControllerFeatureAPI.java
@@ -28,194 +28,230 @@ import org.onap.policy.drools.utils.OrderedService;
import org.onap.policy.drools.utils.OrderedServiceImpl;
public interface PolicyControllerFeatureAPI extends OrderedService {
-
- /**
- * Feature providers implementing this interface
- */
- public static final OrderedServiceImpl<PolicyControllerFeatureAPI> providers =
- new OrderedServiceImpl<PolicyControllerFeatureAPI>(PolicyControllerFeatureAPI.class);
-
- /**
- * called before creating a controller with name 'name' and
- * properties 'properties'
- *
- * @param name name of the the controller
- * @param properties configuration properties
- *
- * @return a policy controller. A take over of the creation operation
- * is performed by returning a non-null policy controller.
- * 'null' indicates that no take over has taken place, and processing should
- * continue to the next feature provider.
- */
- public default PolicyController beforeCreate(String name, Properties properties) {return null;}
-
- /**
- * called after creating a controller with name 'name'
- *
- * @param controller controller
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterCreate(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is started.
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean beforeStart(PolicyController controller) {return false;}
-
- /**
- * intercept after the Policy Controller is started.
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterStart(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is stopped.
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise..
- */
- public default boolean beforeStop(PolicyController controller) {return false;}
-
- /**
- * intercept after the Policy Controller is stopped
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.d.
- */
- public default boolean afterStop(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is locked
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean beforeLock(PolicyController controller) {return false;}
-
- /**
- * intercept after the Policy Controller is locked
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise..
- */
- public default boolean afterLock(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is locked
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean beforeUnlock(PolicyController controller) {return false;}
-
- /**
- * intercept after the Policy Controller is locked
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterUnlock(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is shut down
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise..
- */
- public default boolean beforeShutdown(PolicyController controller) {return false;}
-
- /**
- * called after the Policy Controller is shut down
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterShutdown(PolicyController controller) {return false;}
-
- /**
- * intercept before the Policy Controller is halted
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise..
- */
- public default boolean beforeHalt(PolicyController controller) {return false;}
-
- /**
- * called after the Policy Controller is halted
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterHalt(PolicyController controller) {return false;}
-
-
- /**
- * intercept before the Policy Controller is offered an event
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean beforeOffer(PolicyController controller,
- CommInfrastructure protocol,
- String topic,
- String event) {return false;}
-
- /**
- * called after the Policy Controller processes an event offer
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterOffer(PolicyController controller,
- CommInfrastructure protocol,
- String topic,
- String event,
- boolean success) {return false;}
-
- /**
- * intercept before the Policy Controller delivers (posts) an event
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean beforeDeliver(PolicyController controller,
- CommInfrastructure protocol,
- String topic,
- Object event) {return false;}
-
- /**
- * called after the Policy Controller delivers (posts) an event
- *
- * @return true if this feature intercepts and takes ownership
- * of the operation preventing the invocation of
- * lower priority features. False, otherwise.
- */
- public default boolean afterDeliver(PolicyController controller,
- CommInfrastructure protocol,
- String topic,
- Object event,
- boolean success) {return false;}
+
+ /**
+ * Feature providers implementing this interface.
+ */
+ public static final OrderedServiceImpl<PolicyControllerFeatureAPI> providers =
+ new OrderedServiceImpl<>(PolicyControllerFeatureAPI.class);
+
+ /**
+ * called before creating a controller with name 'name' and
+ * properties 'properties'.
+ *
+ * @param name name of the the controller
+ * @param properties configuration properties
+ *
+ * @return a policy controller. A take over of the creation operation
+ * is performed by returning a non-null policy controller.
+ * 'null' indicates that no take over has taken place, and processing should
+ * continue to the next feature provider.
+ */
+ public default PolicyController beforeCreate(String name, Properties properties) {
+ return null;
+ }
+
+ /**
+ * called after creating a controller with name 'name'.
+ *
+ * @param controller controller
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterCreate(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is started.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean beforeStart(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept after the Policy Controller is started.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterStart(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is stopped.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise..
+ */
+ public default boolean beforeStop(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept after the Policy Controller is stopped.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.d.
+ */
+ public default boolean afterStop(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is locked.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean beforeLock(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept after the Policy Controller is locked.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise..
+ */
+ public default boolean afterLock(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is locked.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean beforeUnlock(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept after the Policy Controller is locked.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterUnlock(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is shut down.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise..
+ */
+ public default boolean beforeShutdown(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * called after the Policy Controller is shut down.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterShutdown(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller is halted.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise..
+ */
+ public default boolean beforeHalt(PolicyController controller) {
+ return false;
+ }
+
+ /**
+ * called after the Policy Controller is halted.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterHalt(PolicyController controller) {
+ return false;
+ }
+
+
+ /**
+ * intercept before the Policy Controller is offered an event.
+ *
+ * @return true if this feature intercepts and takes ownership.
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean beforeOffer(PolicyController controller,
+ CommInfrastructure protocol,
+ String topic,
+ String event) {
+ return false;
+ }
+
+ /**
+ * called after the Policy Controller processes an event offer.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterOffer(PolicyController controller,
+ CommInfrastructure protocol,
+ String topic,
+ String event,
+ boolean success) {
+ return false;
+ }
+
+ /**
+ * intercept before the Policy Controller delivers (posts) an event.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean beforeDeliver(PolicyController controller,
+ CommInfrastructure protocol,
+ String topic,
+ Object event) {
+ return false;
+ }
+
+ /**
+ * called after the Policy Controller delivers (posts) an event.
+ *
+ * @return true if this feature intercepts and takes ownership
+ * of the operation preventing the invocation of
+ * lower priority features. False, otherwise.
+ */
+ public default boolean afterDeliver(PolicyController controller,
+ CommInfrastructure protocol,
+ String topic,
+ Object event,
+ boolean success) {
+ return false;
+ }
}