/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 *  Modifications Copyright (C) 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.models.provider;

import lombok.Data;

import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.utils.validation.ParameterValidationUtils;
import org.onap.policy.models.provider.impl.DatabasePolicyModelsProviderImpl;

// @formatter:off
/**
 * Class to hold all the plugin handler parameters.
 *
 * <p>The following parameters are defined:
 * <ol>
 * <li>name: A name for the parameters.
 * <li>implementation: The implementation of the PolicyModelsProvider to use for writing and reading concepts,
 * defaults to {@link DatabasePolicyModelsProviderImpl} and may not be null
 * <li>databaseUrl: The JDBC URL for the database, mandatory.
 * <li>databaseUser: The user id to use for connecting to the database, optional, defaults to null.
 * <li>databasePassword: The password to use for connecting to the database encoded in Base64, optional,
 * defaults to null.
 * <li>persistenceUnit: The persistence unit refined in META-INF/persistence.xml to use for connecting
 * to the database, mandatory.
 * </ol>
 *
 * @author Liam Fallon (liam.fallon@est.tech)
 */
//@formatter:on

@Data
public class PolicyModelsProviderParameters implements ParameterGroup {
    private static final String DEFAULT_IMPLEMENTATION = DatabasePolicyModelsProviderImpl.class.getName();

    private String name;
    private String implementation = DEFAULT_IMPLEMENTATION;
    private String databaseDriver;
    private String databaseUrl;
    private String databaseUser;
    private String databasePassword;
    private String persistenceUnit;

    /**
     * Validate the model provider parameters.
     *
     */
    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);

        if (!ParameterValidationUtils.validateStringParameter(implementation)) {
            validationResult.setResult("implementation", ValidationStatus.INVALID,
                    "a PolicyModelsProvider implementation must be specified");
        }

        if (!ParameterValidationUtils.validateStringParameter(databaseDriver)) {
            validationResult.setResult("databaseUrl", ValidationStatus.INVALID,
                    "a driver must be specified for the JDBC connection to the database");
        }

        if (!ParameterValidationUtils.validateStringParameter(databaseUrl)) {
            validationResult.setResult("databaseUrl", ValidationStatus.INVALID,
                    "a URL must be specified for the JDBC connection to the database");
        }

        if (!ParameterValidationUtils.validateStringParameter(persistenceUnit)) {
            validationResult.setResult("persistenceUnit", ValidationStatus.INVALID,
                    "a persistence unit must be specified for connecting to the database");
        }

        return validationResult;
    }
}