gerrit.onap Code Review - policy/drools-applications.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * policy-yaml
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.policy.builder;
  22
  23 import java.util.Map;
  24
  25 import org.onap.policy.aai.Pnf;
  26 import org.onap.policy.controlloop.policy.ControlLoop;
  27 import org.onap.policy.controlloop.policy.OperationsAccumulateParams;
  28 import org.onap.policy.controlloop.policy.Policy;
  29 import org.onap.policy.controlloop.policy.PolicyParam;
  30 import org.onap.policy.controlloop.policy.PolicyResult;
  31 import org.onap.policy.controlloop.policy.Target;
  32 import org.onap.policy.controlloop.policy.builder.impl.ControlLoopPolicyBuilderImpl;
  33 import org.onap.policy.sdc.Resource;
  34 import org.onap.policy.sdc.Service;
  35
  36 public interface ControlLoopPolicyBuilder {
  37
  38     /**
  39      * Adds one or more services to the ControlLoop.
  40      *
  41      * @param services service to add
  42      * @return builder object
  43      * @throws BuilderException builder exception
  44      */
  45     public ControlLoopPolicyBuilder addService(Service... services) throws BuilderException;
  46
  47     /**
  48      * Remove service.
  49      *
  50      * @param services to remove
  51      * @return builder object
  52      * @throws BuilderException builder exception
  53      */
  54     public ControlLoopPolicyBuilder removeService(Service... services) throws BuilderException;
  55
  56     /**
  57      * Remove all the services.
  58      *
  59      * @return builder object
  60      * @throws BuilderException builder exception
  61      */
  62     public ControlLoopPolicyBuilder removeAllServices() throws BuilderException;
  63
  64     /**
  65      * Adds one or more resources to the ControlLoop.
  66      *
  67      * @return builder object
  68      * @throws BuilderException builder exception
  69      */
  70     public ControlLoopPolicyBuilder addResource(Resource... resources) throws BuilderException;
  71
  72     /**
  73      * Remove the resources.
  74      *
  75      * @param resources resources to be removed
  76      * @return object
  77      * @throws BuilderException builder exception
  78      */
  79     public ControlLoopPolicyBuilder removeResource(Resource... resources) throws BuilderException;
  80
  81     /**
  82      * Remove all resources.
  83      *
  84      * @return object
  85      * @throws BuilderException builder exception
  86      */
  87     public ControlLoopPolicyBuilder removeAllResources() throws BuilderException;
  88
  89     /**
  90      * Set the PNF.
  91      *
  92      * @param pnf input pnf
  93      * @return builder object
  94      * @throws BuilderException builder exception
  95      */
  96     public ControlLoopPolicyBuilder setPNF(Pnf pnf) throws BuilderException;
  97
  98     /**
  99      * Remove PNF.
 100      *
 101      * @return the object
 102      * @throws BuilderException builder exception
 103      */
 104     public ControlLoopPolicyBuilder removePNF() throws BuilderException;
 105
 106     /**
 107      * Set the abatement.
 108      *
 109      * @param abatement whether abatement is possible
 110      * @return object
 111      * @throws BuilderException builder exception
 112      */
 113     public ControlLoopPolicyBuilder setAbatement(Boolean abatement) throws BuilderException;
 114
 115
 116     /**
 117      * Sets the overall timeout value for the Control Loop. If any operational policies have retries
 118      * and timeouts, then this overall timeout value should exceed all those values.
 119      *
 120      * @param timeout timeout value
 121      * @return control loop policy builder
 122      * @throws BuilderException builder exception
 123      */
 124     public ControlLoopPolicyBuilder setTimeout(Integer timeout) throws BuilderException;
 125
 126     /**
 127      * Scans the operational policies and calculate an minimum overall timeout for the Control Loop.
 128      *
 129      *
 130      * @return Integer
 131      */
 132     public Integer calculateTimeout();
 133
 134     /**
 135      * Sets the initial trigger policy when a DCAE Closed Loop Event arrives in the ONAP Policy
 136      * Platform.
 137      *
 138      *
 139      * @param policy Policy parameters object
 140      * @return Policy object
 141      * @throws BuilderException builder exception
 142      */
 143     public Policy setTriggerPolicy(PolicyParam policy) throws BuilderException;
 144
 145     /**
 146      * Changes the trigger policy to point to another existing Policy.
 147      *
 148      * @param id the id
 149      * @return ControlLoop object
 150      * @throws BuilderException build exception
 151      */
 152     public ControlLoop setExistingTriggerPolicy(String id) throws BuilderException;
 153
 154     /**
 155      * Is an open loop.
 156      *
 157      * @return true or false
 158      */
 159     public boolean isOpenLoop();
 160
 161     /**
 162      * Get the trigger policy.
 163      *
 164      * @return the policy object
 165      * @throws BuilderException if there is a builder exception
 166      */
 167     public Policy getTriggerPolicy() throws BuilderException;
 168
 169     /**
 170      * Simply returns a copy of the ControlLoop information.
 171      *
 172      *
 173      * @return ControlLoop
 174      */
 175     public ControlLoop getControlLoop();
 176
 177     /**
 178      * Creates a policy that is chained to the result of another Policy.
 179      *
 180      * @param name name
 181      * @param description description
 182      * @param actor actor
 183      * @param target target
 184      * @param recipe recipe
 185      * @param retries retries
 186      * @param timeout timeout
 187      * @param policyId id
 188      * @param results results
 189      * @return Policy that was set
 190      * @throws BuilderException builder exception
 191      */
 192     public Policy setPolicyForPolicyResult(String name, String description, String actor, Target target, String recipe,
 193             Map<String, String> payload, Integer retries, Integer timeout, String policyId, PolicyResult... results)
 194             throws BuilderException;
 195
 196
 197     /**
 198      * Sets the policy result(s) to an existing Operational Policy.
 199      *
 200      * @param policyResultId result ID
 201      * @param policyId id
 202      * @param results results
 203      * @return Policy that was set
 204      * @throws BuilderException builder exception
 205      */
 206     public Policy setPolicyForPolicyResult(String policyResultId, String policyId, PolicyResult... results)
 207             throws BuilderException;
 208
 209     /**
 210      * Removes an Operational Policy. Be mindful that if any other Operational Policies have results
 211      * that point to this policy, any policies that have results pointing to this policy will have
 212      * their result reset to the appropriate default FINAL_* result.
 213      *
 214      *
 215      * @param policyID id for the policy
 216      * @return true if removed else false
 217      * @throws BuilderException builder exception
 218      */
 219     public boolean removePolicy(String policyID) throws BuilderException;
 220
 221     /**
 222      * Resets a policy's results to defualt FINAL_* codes.
 223      *
 224      * @return Policy object
 225      * @throws BuilderException - Policy does not exist
 226      */
 227     public Policy resetPolicyResults(String policyID) throws BuilderException;
 228
 229     /**
 230      * Removes all existing Operational Policies and reverts back to an Open Loop.
 231      *
 232      * @return Policy builder object
 233      */
 234     public ControlLoopPolicyBuilder removeAllPolicies();
 235
 236     /**
 237      * Adds an operationsAccumulateParams to an existing operational policy.
 238      *
 239      * @return Policy
 240      * @throws BuilderException - Policy does not exist
 241      */
 242     public Policy addOperationsAccumulateParams(String policyID, OperationsAccumulateParams operationsAccumulateParams)
 243             throws BuilderException;
 244
 245     /**
 246      * This will compile and build the YAML specification for the Control Loop Policy. Please
 247      * iterate the Results object for details. The Results object will contains warnings and errors.
 248      * If the specification compiled successfully, you will be able to retrieve the YAML.
 249      *
 250      * @return Results
 251      */
 252     public Results buildSpecification();
 253
 254     /**
 255      * The Factory is used to build a ControlLoopPolicyBuilder implementation.
 256      *
 257      * @author pameladragosh
 258      *
 259      */
 260     public static class Factory {
 261         private Factory() {
 262             // Private Constructor.
 263         }
 264
 265         /**
 266          * Builds a basic Control Loop with an overall timeout. Use this method if you wish to
 267          * create an OpenLoop, or if you want to interactively build a Closed Loop.
 268          *
 269          * @param controlLoopName - Per Closed Loop AID v1.0, unique string for the closed loop.
 270          * @param timeout - Overall timeout for the Closed Loop to execute.
 271          * @return ControlLoopPolicyBuilder object
 272          */
 273         public static ControlLoopPolicyBuilder buildControlLoop(String controlLoopName, Integer timeout) {
 274             return new ControlLoopPolicyBuilderImpl(controlLoopName, timeout);
 275         }
 276
 277         /**
 278          * Build a Control Loop for a resource and services associated with the resource.
 279          *
 280          * @param controlLoopName - Per Closed Loop AID v1.0, unique string for the closed loop.
 281          * @param timeout - Overall timeout for the Closed Loop to execute.
 282          * @param resource - Resource this closed loop is for. Should come from ASDC, but if not
 283          *        available use resourceName to distinguish.
 284          * @param services - Zero or more services associated with this resource. Should come from
 285          *        ASDC, but if not available use serviceName to distinguish.
 286          * @return ControlLoopPolicyBuilder object
 287          * @throws BuilderException builder exception
 288          */
 289         public static ControlLoopPolicyBuilder buildControlLoop(String controlLoopName, Integer timeout,
 290                 Resource resource, Service... services) throws BuilderException {
 291             return new ControlLoopPolicyBuilderImpl(controlLoopName, timeout, resource, services);
 292         }
 293
 294         /**
 295          * Build the control loop.
 296          *
 297          * @param controlLoopName control loop id
 298          * @param timeout timeout
 299          * @param service service
 300          * @param resources resources
 301          * @return builder object
 302          * @throws BuilderException builder exception
 303          */
 304         public static ControlLoopPolicyBuilder buildControlLoop(String controlLoopName, Integer timeout,
 305                 Service service, Resource... resources) throws BuilderException {
 306             return new ControlLoopPolicyBuilderImpl(controlLoopName, timeout, service, resources);
 307         }
 308
 309         /**
 310          * Build control loop.
 311          *
 312          * @param controlLoopName - Per Closed Loop AID v1.0, unique string for the closed loop.
 313          * @param timeout - Overall timeout for the Closed Loop to execute.
 314          * @param pnf - Physical Network Function. Should come from AIC, but if not available use
 315          *        well-known name to distinguish. Eg. eNodeB
 316          * @return ControlLoopPolicyBuilder object
 317          * @throws BuilderException builder exception
 318          */
 319         public static ControlLoopPolicyBuilder buildControlLoop(String controlLoopName, Integer timeout, Pnf pnf)
 320                 throws BuilderException {
 321             return new ControlLoopPolicyBuilderImpl(controlLoopName, timeout, pnf);
 322         }
 323     }
 324
 325 }