controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/ophistory/OperationHistoryDataManagerParams.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2023 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.ophistory;
  23
  24 import lombok.AllArgsConstructor;
  25 import lombok.Builder;
  26 import lombok.Data;
  27 import lombok.NoArgsConstructor;
  28 import org.onap.policy.common.parameters.BeanValidator;
  29 import org.onap.policy.common.parameters.ValidationResult;
  30 import org.onap.policy.common.parameters.annotations.Min;
  31 import org.onap.policy.common.parameters.annotations.NotBlank;
  32 import org.onap.policy.common.parameters.annotations.NotNull;
  33
  34 /**
  35  * Parameters for a Data Manager.
  36  */
  37 @NotNull
  38 @Data
  39 @Builder
  40 @NoArgsConstructor
  41 @AllArgsConstructor
  42 public class OperationHistoryDataManagerParams {
  43     public static final String DEFAULT_PU = "OperationsHistoryPU";
  44     public static final String DEFAULT_DRIVER = "org.mariadb.jdbc.Driver";
  45     public static final String DEFAULT_TYPE = "MariaDB";
  46
  47     @NotBlank
  48     private String url;
  49     @NotBlank
  50     private String userName;
  51
  52     // may be blank
  53     private String password;
  54
  55     @Builder.Default
  56     private String persistenceUnit = DEFAULT_PU;
  57
  58     @Builder.Default
  59     private String driver = DEFAULT_DRIVER;
  60
  61     @Builder.Default
  62     private String dbType = DEFAULT_TYPE;
  63
  64     /**
  65      * Maximum number of records that can be waiting to be inserted into the DB. When the
  66      * limit is reached, the oldest records are discarded.
  67      */
  68     @Min(1)
  69     @Builder.Default
  70     private int maxQueueLength = 10000;
  71
  72     /**
  73      * Number of records to add the DB in one transaction.
  74      */
  75     @Min(1)
  76     @Builder.Default
  77     private int batchSize = 100;
  78
  79     /**
  80      * Validates the parameters.
  81      *
  82      * @param resultName name of the result
  83      *
  84      * @return the validation result
  85      */
  86     public ValidationResult validate(String resultName) {
  87         return new BeanValidator().validateTop(resultName, this);
  88     }
  89
  90     /**
  91      * Return the Hibernate dialect for the database type.
  92      * @return the dialect
  93      */
  94     public Object getDbHibernateDialect() {
  95         return "org.hibernate.dialect." + dbType + "Dialect";
  96     }
  97 }